nxm.ice.lib
Class ICEPacket

java.lang.Object
  nxm.ice.lib.ICEPacket

All Implemented Interfaces:

nxm.sys.inc.PacketHandler

public class ICEPacket

extends java.lang.Object

implements nxm.sys.inc.PacketHandler

Defines the header for ICE packetized data.

Field Summary

static int	ABSC
byte[]	buf
static int	FIXED
static int	headerLength

Constructor Summary

ICEPacket()

ICEPacket(java.lang.String format, int size, int flags)

Method Summary

nxm.sys.inc.PacketHandler	cloneOf()
void	close(nxm.sys.lib.DataFile df)
void	copyFrom(ICEPacket source)
double	dataToPacketOffset(nxm.sys.lib.DataFile df, double boffset) translate seek data byte offset to the packet byte offset
void	decTCO(int xfer) decrement TC offset
int	getBytes() get Size of packet data in bytes
int	getChannel() get Channel number of this packet
java.lang.String	getConfiguration(nxm.sys.lib.DataFile df) packet Handler methods
int	getCount() get the current packet count
int	getFixedSize()
java.lang.String	getFormat() get the current Format
int	getRBData(int off)
int	getSize() get Size of packet data in elements
nxm.sys.lib.Time	getTC() get timecode
int	getTC(nxm.sys.lib.Time tc, double offset, double delta) get timecode
double	getTCO() get TC offset
boolean	hasHeader()
java.lang.String	listHeader()
double	naturalDataOffset(nxm.sys.lib.DataFile df, double boffset)
void	open(nxm.sys.lib.DataFile df) open the packet handler
double	packetToDataOffset(nxm.sys.lib.DataFile df, double boffset) translate seek packet byte offset to the data byte offset
int	read(nxm.sys.lib.DataFile df, byte[] buf, int boff, int bytes, long lbuf) read packet header and data
void	seek(nxm.sys.lib.DataFile df, double boffset) seek to the given data offset (or find valid trim value)
void	setAbscissa(double xstart, double xdelta) set abscissa
void	setChannel(int channel) port channel number
void	setCount(int count) packet number since start of xfer
void	setFileName(nxm.sys.lib.DataFile df, nxm.sys.lib.FileName filename) set filename for seperate packet header file
void	setFixedSize(int size) set fixed size mode
void	setFormat(java.lang.String format) set format
void	setID(byte id1, byte id2) subsystem IDs
void	setKeys(byte type) barker syncs(3) and packet type(1)
void	setRBData(int off, int value)
void	setRep(byte rep) data rep (Vax,Ieee,Eeei)
void	setSize(int size) data elements in packet
void	setTC(int mode, int status, double offset, double wsec, double fsec) set timecode
void	setUser(short user) user defined field
void	upCount() up the count by one
int	write(nxm.sys.lib.DataFile df, byte[] buf, int boff, int bytes, long lbuf) write packet header and data

Methods inherited from class java.lang.Object

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

Field Detail

ABSC

public static final int ABSC

See Also:

Constant Field Values

FIXED

public static final int FIXED

See Also:

Constant Field Values

headerLength

public static final int headerLength

See Also:

Constant Field Values

buf

public byte[] buf

Constructor Detail

ICEPacket

public ICEPacket()

ICEPacket

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

Method Detail

setKeys

public void setKeys(byte type)

barker syncs(3) and packet type(1)

setCount

public void setCount(int count)

packet number since start of xfer

upCount

public void upCount()

up the count by one

setSize

public void setSize(int size)

data elements in packet

setUser

public void setUser(short user)

user defined field

setChannel

public void setChannel(int channel)

port channel number

setID

public void setID(byte id1,
                  byte id2)

subsystem IDs

setRep

public void setRep(byte rep)

data rep (Vax,Ieee,Eeei)

setFormat

public void setFormat(java.lang.String format)

set format

setTC

public void setTC(int mode,
                  int status,
                  double offset,
                  double wsec,
                  double fsec)

set timecode

getTC

public nxm.sys.lib.Time getTC()

get timecode

getTCO

public double getTCO()

get TC offset

decTCO

public void decTCO(int xfer)

decrement TC offset

getTC

public int getTC(nxm.sys.lib.Time tc,
                 double offset,
                 double delta)

get timecode

setAbscissa

public void setAbscissa(double xstart,
                        double xdelta)

set abscissa

setFixedSize

public void setFixedSize(int size)

set fixed size mode

getChannel

public int getChannel()

get Channel number of this packet

getCount

public int getCount()

get the current packet count

getFormat

public java.lang.String getFormat()

get the current Format

getSize

public int getSize()

get Size of packet data in elements

getBytes

public int getBytes()

get Size of packet data in bytes

getFixedSize

public int getFixedSize()

setRBData

public void setRBData(int off,
                      int value)

getRBData

public int getRBData(int off)

getConfiguration

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

packet Handler methods

Specified by:

getConfiguration in interface nxm.sys.inc.PacketHandler

setFileName

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

set filename for seperate packet header file

Specified by:

setFileName in interface nxm.sys.inc.PacketHandler

naturalDataOffset

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

Specified by:

naturalDataOffset in interface nxm.sys.inc.PacketHandler

dataToPacketOffset

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

translate seek data byte offset to the packet byte offset

Specified by:

dataToPacketOffset in interface nxm.sys.inc.PacketHandler

packetToDataOffset

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

translate seek packet byte offset to the data byte offset

Specified by:

packetToDataOffset in interface nxm.sys.inc.PacketHandler

open

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

open the packet handler

Specified by:

open in interface nxm.sys.inc.PacketHandler

seek

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

seek to the given data offset (or find valid trim value)

Specified by:

seek in interface nxm.sys.inc.PacketHandler

read

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

read packet header and data

Specified by:

read in interface nxm.sys.inc.PacketHandler

write

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

write packet header and data

Specified by:

write in interface nxm.sys.inc.PacketHandler

close

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

Specified by:

close in interface nxm.sys.inc.PacketHandler

hasHeader

public boolean hasHeader()

Specified by:

hasHeader in interface nxm.sys.inc.PacketHandler

listHeader

public java.lang.String listHeader()

Specified by:

listHeader in interface nxm.sys.inc.PacketHandler

cloneOf

public nxm.sys.inc.PacketHandler cloneOf()

Specified by:

cloneOf in interface nxm.sys.inc.PacketHandler

copyFrom

public void copyFrom(ICEPacket source)