nxm.ice.lib

Class VRTPacket

java.lang.Object

nxm.ice.lib.VRTPacket

All Implemented Interfaces:

java.lang.Cloneable, nxm.sys.inc.PacketHandler

public class VRTPacket
extends java.lang.Object
implements nxm.sys.inc.PacketHandler, java.lang.Cloneable

Handler for VITA-49 Radio Transport packets.

  VRT Packet Word Placement

    0 HDR Header (Type:4,C:1,T:1,RR:2,TSI:2,TSF:2,Seq:4,Size:16)
    1 SID Stream ID 
    2 OUID Organizational Unique ID
    3 CID  Information Class : Packet Class
    4 TSIS TimeStamp - Integer Seconds
  6:5 TSFS TimeStamp - Fractional Seconds
    7 TLR Trailer
    
    X Data Payload (X=360 qwords for 1500MTU)

    Packet qword 7 moved after payload at transmit

  Header Types:
    0cxs c=Context x=Extension s=WithStreamID
    
    Packet Class (Pack:1,Type:2,Format:5,Resv:2,Size:6)

    Ice PCC = Packet Class Code (PT:1,BE:1,DST:2,DIF:4,DIS:8) = 0x100F for LittleEndian CI

    Data Item Size = (bitsPerSample-1)

    Data Sample Type
    00 Real
    01 Complex Cartesian
    10 Complex Polar

    Data Item Format
    u0000 Fixed Point - u=Unsigned|Signed
    u0eee VRT float w/ e-bit exponent
    01110 IEEE Single Precision Floating Point
    01111 IEEE Double Precision Floating Point

  Information Class


  TimeStamp
    TSI 0=None 1=UTC 2=GPS 3=Other
    TSF 0=None 1=Count 2=pSec 3=FreeRunningCount
  
  

Author:

Jeff Schoen

Field Summary

Fields

Modifier and Type	Field and Description
byte[]	buf
byte[]	cbuf
static java.lang.String	flagsList
static int	FLG_BIGE
static int	FLG_CTX
static int	FLG_DIFI
static int	FLG_NONE
static int	FLG_NOSID
static int	FLG_NOUID
static int	FLG_TRIM
static int	OUID_DIFI
static int	OUID_ICE
static int	TSF_CNT
static int	TSF_FRC
static int	TSF_NONE
static int	TSF_PSEC
static int	TSI_GPS
static int	TSI_NONE
static int	TSI_POSIX
static int	TSI_UTC

Constructor Summary

Constructors

Constructor and Description
VRTPacket()
VRTPacket(java.lang.String format, int flags)
VRTPacket(java.lang.String format, int size, int flags)
VRTPacket(java.lang.String format, int flags, java.lang.String variant)
VRTPacket(java.lang.String format, java.lang.String variant)

Method Summary

Modifier and Type	Method and Description
int	buf2pkt(byte[] dbuf, int off, long pdata, int len)
nxm.sys.inc.PacketHandler	cloneOf() Create a clone of this instance for propagation.
void	close(nxm.sys.lib.DataFile df) Finalize this instance.
void	createContextFor(int ctx, int rate, int freq, int gain)
int	ctx2pkt(long pdata)
double	dataToPacketOffset(nxm.sys.lib.DataFile df, double boffset) Translate the data byte offset to packetized byte offset.
int	getBits()
void	getBuffer(byte[] buffer, int boff)
int	getBytes()
int	getCID()
java.lang.String	getConfiguration(nxm.sys.lib.DataFile df) Get the configuration string needed to initialize this handler.
int	getCount()
int	getDataLength()
java.lang.String	getFormat()
int	getHeaderLength()
int	getICID()
int	getNextContext()
int	getOUID()
byte	getRep()
int	getSID()
int	getSize()
nxm.sys.lib.Time	getTC()
int	getTrailerLength()
boolean	hasHeader() Determine if the last read included a new packet header.
java.lang.String	listHeader() Lists the current packet header.
double	naturalDataOffset(nxm.sys.lib.DataFile df, double boffset) Translate the data byte offset to byte offset at start of packet.
void	open(nxm.sys.lib.DataFile df) Initialize this instance.
double	packetToDataOffset(nxm.sys.lib.DataFile df, double boffset) Translate the packetized byte offset to data byte offset.
int	read(nxm.sys.lib.DataFile df, byte[] buf, int boff, int bytes, long lbuf) Read data including packet header.
void	seek(nxm.sys.lib.DataFile df, double boffset) Seek to the closest given data byte offset.
void	setBits(int bits)
void	setBuffer(byte[] buffer, int boff)
void	setBytes(int bytes)
void	setCID(int cid)
void	setCount(int count)
void	setFileName(nxm.sys.lib.DataFile df, nxm.sys.lib.FileName filename) Set the file name for a packets only file.
void	setFlags(int flags)
void	setFormat(java.lang.String format)
void	setICID(int icid)
void	setOUID(int ouid)
void	setRep(byte rep)
void	setSID(int sid)
void	setSize(int elem)
void	setTC(double wsec, double fsec)
void	setTrailer(int trailer)
void	upCount()
int	write(nxm.sys.lib.DataFile df, byte[] buf, int boff, int bytes, long lbuf) Write data including packet header.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OUID_ICE

public static int OUID_ICE

OUID_DIFI

public static int OUID_DIFI

TSI_NONE

public static int TSI_NONE

TSI_UTC

public static int TSI_UTC

TSI_GPS

public static int TSI_GPS

TSI_POSIX

public static int TSI_POSIX

TSF_NONE

public static int TSF_NONE

TSF_CNT

public static int TSF_CNT

TSF_PSEC

public static int TSF_PSEC

TSF_FRC

public static int TSF_FRC

flagsList

public static java.lang.String flagsList

FLG_NONE

public static int FLG_NONE

FLG_TRIM

public static int FLG_TRIM

FLG_BIGE

public static int FLG_BIGE

FLG_NOUID

public static int FLG_NOUID

FLG_CTX

public static int FLG_CTX

FLG_NOSID

public static int FLG_NOSID

FLG_DIFI

public static int FLG_DIFI

buf

public byte[] buf

cbuf

public byte[] cbuf

Constructor Detail

VRTPacket

public VRTPacket()

VRTPacket

public VRTPacket(java.lang.String format,
                 java.lang.String variant)

VRTPacket

public VRTPacket(java.lang.String format,
                 int flags)

VRTPacket

public VRTPacket(java.lang.String format,
                 int flags,
                 java.lang.String variant)

VRTPacket

public VRTPacket(java.lang.String format,
                 int size,
                 int flags)

Method Detail

setFlags

public void setFlags(int flags)

createContextFor

public void createContextFor(int ctx,
                             int rate,
                             int freq,
                             int gain)

getNextContext

public int getNextContext()

setRep

public void setRep(byte rep)

getRep

public byte getRep()

getHeaderLength

public int getHeaderLength()

getDataLength

public int getDataLength()

getTrailerLength

public int getTrailerLength()

setSize

public void setSize(int elem)

getSize

public int getSize()

setBytes

public void setBytes(int bytes)

getBytes

public int getBytes()

setTrailer

public void setTrailer(int trailer)

setSID

public void setSID(int sid)

getSID

public int getSID()

setOUID

public void setOUID(int ouid)

getOUID

public int getOUID()

setICID

public void setICID(int icid)

getICID

public int getICID()

setCID

public void setCID(int cid)

getCID

public int getCID()

setCount

public void setCount(int count)

getCount

public int getCount()

upCount

public void upCount()

setFormat

public void setFormat(java.lang.String format)

getFormat

public java.lang.String getFormat()

setBits

public void setBits(int bits)

getBits

public int getBits()

setTC

public void setTC(double wsec,
                  double fsec)

getTC

public nxm.sys.lib.Time getTC()

ctx2pkt

public int ctx2pkt(long pdata)

buf2pkt

public int buf2pkt(byte[] dbuf,
                   int off,
                   long pdata,
                   int len)

getConfiguration

public java.lang.String getConfiguration(nxm.sys.lib.DataFile df)

Get the configuration string needed to initialize this handler.

Specified by:

getConfiguration in interface nxm.sys.inc.PacketHandler

Parameters:

df - The data file to get the configuration for.

Returns:

The configuration string.

setFileName

public void setFileName(nxm.sys.lib.DataFile df,
                        nxm.sys.lib.FileName filename)

Set the file name for a packets only file.

Specified by:

setFileName in interface nxm.sys.inc.PacketHandler

Parameters:

df - The data file to set the name of.

filename - The file new name.

naturalDataOffset

public double naturalDataOffset(nxm.sys.lib.DataFile df,
                                double boffset)

Translate the data byte offset to byte offset at start of packet.

Specified by:

naturalDataOffset in interface nxm.sys.inc.PacketHandler

Parameters:

df - The data file the data-byte-offset is in relation to.

boffset - The data-byte-offset.

Returns:

The (natural) byte-offset into the file.

dataToPacketOffset

public double dataToPacketOffset(nxm.sys.lib.DataFile df,
                                 double boffset)

Translate the data byte offset to packetized byte offset.

Specified by:

dataToPacketOffset in interface nxm.sys.inc.PacketHandler

Parameters:

df - The data file the data-byte-offset is in relation to.

boffset - The data-byte-offset.

Returns:

The packetized-byte-offset.

See Also:

PacketHandler.packetToDataOffset(DataFile,double)

packetToDataOffset

public double packetToDataOffset(nxm.sys.lib.DataFile df,
                                 double boffset)

Translate the packetized byte offset to data byte offset.

Specified by:

packetToDataOffset in interface nxm.sys.inc.PacketHandler

Parameters:

df - The data file the data-byte-offset is in relation to.

boffset - The packetized-byte-offset.

Returns:

The data-byte-offset.

See Also:

PacketHandler.dataToPacketOffset(DataFile,double)

open

public void open(nxm.sys.lib.DataFile df)

Initialize this instance.

Specified by:

open in interface nxm.sys.inc.PacketHandler

Parameters:

df - The data file to open.

seek

public void seek(nxm.sys.lib.DataFile df,
                 double boffset)

Seek to the closest given data byte offset.

Specified by:

seek in interface nxm.sys.inc.PacketHandler

Parameters:

df - The data file to seek to the byte offset in.

boffset - The byte offset into the file.

read

public int read(nxm.sys.lib.DataFile df,
                byte[] buf,
                int boff,
                int bytes,
                long lbuf)

Read data including packet header.

Specified by:

read in interface nxm.sys.inc.PacketHandler

Parameters:

df - The data file to read from.

buf - The buffer to read the data in to.

boff - The byte-offset into the buffer to start writing at.

bytes - The number of bytes to attempt to read.

lbuf - Native buffer location (0=Disable).

Returns:

The number of bytes actually read in.

write

public int write(nxm.sys.lib.DataFile df,
                 byte[] buf,
                 int boff,
                 int bytes,
                 long lbuf)

Write data including packet header.

Specified by:

write in interface nxm.sys.inc.PacketHandler

Parameters:

df - The data file to write to.

buf - The buffer to write the data in from.

boff - The byte-offset into the buffer to start writing at.

bytes - The number of bytes to attempt to write.

lbuf - Native buffer location (0=Disable).

Returns:

The number of bytes actually written out.

close

public void close(nxm.sys.lib.DataFile df)

Finalize this instance.

Specified by:

close in interface nxm.sys.inc.PacketHandler

Parameters:

df - The data file to close.

hasHeader

public boolean hasHeader()

Determine if the last read included a new packet header.

Specified by:

hasHeader in interface nxm.sys.inc.PacketHandler

Returns:

true if the last read included a new packet header and false if it did not.

listHeader

public java.lang.String listHeader()

Lists the current packet header.

Specified by:

listHeader in interface nxm.sys.inc.PacketHandler

Returns:

The current packet header.

cloneOf

public nxm.sys.inc.PacketHandler cloneOf()

Create a clone of this instance for propagation.

Specified by:

cloneOf in interface nxm.sys.inc.PacketHandler

Returns:

A clone of this instance.

setBuffer

public void setBuffer(byte[] buffer,
                      int boff)

getBuffer

public void getBuffer(byte[] buffer,
                      int boff)