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. TimeCode Modes: OFF=0,CPU=1,ZTC=2,SDN=3,SMS=4,DTL=5,IRB=6,SDD=7,ICE=8,VRT=9,FILE=10,STC=12 TimeCode Status: OKNC=2,OK=1,INACTIVE=-1,BADPARAM=-2,NOBITS=-3,NOBARKER=-4,BCDERR=-5,NAN=-6,NOCLOCK=-7,BADSTART=-8,NTPERR=-9

Author:

Jeff Schoen, Jay Hallam, Neon Ngo - use specified data rep (byte order) when packing/unpacking to/from data buffer

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABSC` Flag for using adjunct bytes as xdelta and xstart
`byte[]`	`buf` Byte buffer holding one or more ICE packets.
`static int`	`FIXED` Flag for fixed size transfer length (constant packet size)
`static int`	`headerLength` The length of an ICE packet
`static int`	`PKHO` Flag for packet header only debug mode

Constructor Summary

Constructors
Constructor and Description
`ICEPacket()` Construct an ICE packet 1024 bytes long
`ICEPacket(byte[] ibuf, int offset)` Construct an ICE packet from the specified byte array.
`ICEPacket(java.lang.String format, int size, int flags)` Construct an ICE packet

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`nxm.sys.inc.PacketHandler`	`cloneOf()` Make a clone of the packet handler
`void`	`close(nxm.sys.lib.DataFile df)` Close the detached data file if not null
`void`	`copyFrom(ICEPacket source)` Copy from another ICE packet object
`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`	`getBPA()` Get bytes per atom (BPA)
`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)` Get the configuration string from the data file
`int`	`getCount()` Get the current packet count
`int`	`getFixedSize()`
`java.lang.String`	`getFormat()` get the current Midas digraph format
`int`	`getRBData(int off)`
`byte`	`getRep()` get data representation ('I'=Ieee,'E'=Eeei,'V'=Vax), i.e.
`static byte`	`getRep(byte[] buf, int boffset)` get data representation in specified byte array.
`int`	`getSize()` Get Size of packet data in elements
`nxm.sys.lib.Time`	`getTC()` Get timecode as a Time object
`int`	`getTC(nxm.sys.lib.Time tc, double offset, double delta)` Get timecode
`byte`	`getTCMode()` get TC mode
`double`	`getTCO()` get TC offset
`byte`	`getTCStatus()` get TC status
`byte`	`getUserDataB(int pos)` Get the user data as byte
`double`	`getUserDataD(int pos)` Get the user data as a double
`float`	`getUserDataF(int pos)` Get the user data as a float
`short`	`getUserDataI(int pos)` Get the user data as a Midas I type (Java short)
`int`	`getUserDataL(int pos)` Get the user data as a Midas L type (Java int)
`long`	`getUserDataX(int pos)` Get the user data as a Midas X extra long type (Java long)
`byte`	`getUserKey()` Get the user defined key
`boolean`	`hasHeader()` Does this packet have any headers
`boolean`	`hasSync()` Does this packet have synchronization barker codes?
`static boolean`	`hasSync(byte[] buf, int boffset)` Does the packet have synchronization barker codes?
`java.lang.String`	`listHeader()` List the packet(s) header count, size, channel, format and timecode
`double`	`naturalDataOffset(nxm.sys.lib.DataFile df, double boffset)` Get the aligned data offset given a reasonable offset guesstimate.
`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 xstart and xdelta
`void`	`setBPA(int val)` Set bytes per atom (BPA).
`void`	`setBuffer(byte[] ibuf, int offset)` set ICE packet from the specified byte array
`void`	`setBytes(byte[] ibuf, int offset)` set ICE packet from the specified byte array
`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 separate packet header file
`void`	`setFixedSize(int size)` Set fixed size mode
`void`	`setFormat(java.lang.String format)` Set data format
`void`	`setID(byte id1, byte id2)` subsystem IDs
`void`	`setKeys(byte userKey)` Set barker syncs and the user key.
`void`	`setMode(java.lang.String mode)` set abscissa mode
`void`	`setRBData(int off, int value)`
`void`	`setRep(byte rep)` set data representation ('I'=Ieee,'E'=Eeei,'V'=Vax), i.e.
`void`	`setSize(int size)` data elements in packet
`void`	`setTC(ICEPacket source)`
`void`	`setTC(int mode, int status, double offset, double wsec, double fsec)` Set timecode mode, status, offset whole seconds and fractional seconds
`void`	`setUser(short user)` user defined field
`void`	`setUserData(byte val, int pos)` Set the user data.
`void`	`setUserData(double val, int pos)` Set the user data.
`void`	`setUserData(float val, int pos)` Set the user data.
`void`	`setUserData(int val, int pos)` Set the user data.
`void`	`setUserData(long val, int pos)` Set the user data.
`void`	`setUserData(short val, int pos)` Set the user data.
`void`	`setUserKey(byte val)` Set the user defined key
`void`	`upCount()` up the count by one
`void`	`upCount(int n)` up the count by N
`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
```
    Flag for using adjunct bytes as xdelta and xstart
    
    See Also:
    
    Constant Field Values
  - FIXED
```
public static final int FIXED
```
    Flag for fixed size transfer length (constant packet size)
    
    See Also:
    
    Constant Field Values
  - PKHO
```
public static final int PKHO
```
    Flag for packet header only debug mode
    
    See Also:
    
    Constant Field Values
  - headerLength
```
public static final int headerLength
```
    The length of an ICE packet
    
    See Also:
    
    Constant Field Values
  - buf
```
public byte[] buf
```
    Byte buffer holding one or more ICE packets. Meant to be read, not written
- Constructor Detail
  - ICEPacket
```
public ICEPacket()
```
    Construct an ICE packet 1024 bytes long
  - ICEPacket
```
public ICEPacket(byte[] ibuf,
                 int offset)
```
    Construct an ICE packet from the specified byte array.
    
    Parameters:
    
    ibuf - Byte array containing header
    
    offset - Byte offset of header within byte array
  - ICEPacket
```
public ICEPacket(java.lang.String format,
                 int size,
                 int flags)
```
    Construct an ICE packet
    
    Parameters:
    
    format - Midas format digraph used to set bpa, mode and type
    
    size - The size in elements (of data)
    
    flags - Flags for this function
- Method Detail
  - setBytes
```
public void setBytes(byte[] ibuf,
                     int offset)
```
    set ICE packet from the specified byte array
    
    Parameters:
    
    ibuf - Byte array containing header
    
    offset - Byte offset of header within byte array
  - setKeys
```
public void setKeys(byte userKey)
```
    Set barker syncs and the user key. Barker keys must be the same for all packets.
    
    Parameters:
    
    userKey - User defined key
  - setUserKey
```
public void setUserKey(byte val)
```
    Set the user defined key
    
    Parameters:
    
    val - User field value
  - getUserKey
```
public byte getUserKey()
```
    Get the user defined key
    
    Returns:
    
    User key value
  - hasSync
```
public boolean hasSync()
```
    Does this packet have synchronization barker codes?
    
    Returns:
    
    True if header in this instance has a sync
  - hasSync
```
public static boolean hasSync(byte[] buf,
                              int boffset)
```
    Does the packet have synchronization barker codes?
    
    Parameters:
    
    buf - The buffer to check
    
    boffset - Offset into the buffer
    
    Returns:
    
    True if header in this buffer has a sync
  - setCount
```
public void setCount(int count)
```
    packet number since start of xfer
    
    Parameters:
    
    count - Next packet number (zero based)
  - upCount
```
public void upCount()
```
    up the count by one
  - upCount
```
public void upCount(int n)
```
    up the count by N
    
    Parameters:
    
    n - Amount to increase current count by
  - setSize
```
public void setSize(int size)
```
    data elements in packet
    
    Parameters:
    
    size - Size in atoms of current packet
  - setUser
```
public void setUser(short user)
```
    user defined field
    
    Parameters:
    
    user - User field value
  - setChannel
```
public void setChannel(int channel)
```
    port channel number
    
    Parameters:
    
    channel - Channel field value
  - setID
```
public void setID(byte id1,
                  byte id2)
```
    subsystem IDs
    
    Parameters:
    
    id1 - Subsystem ID field 1
    
    id2 - Subsystem ID field 2
  - setRep
```
public void setRep(byte rep)
```
    set data representation ('I'=Ieee,'E'=Eeei,'V'=Vax), i.e. data byte order
    
    Parameters:
    
    rep - Current data representation
  - getRep
```
public byte getRep()
```
    get data representation ('I'=Ieee,'E'=Eeei,'V'=Vax), i.e. data byte order
    
    Returns:
    
    Current data representation
  - getRep
```
public static byte getRep(byte[] buf,
                          int boffset)
```
    get data representation in specified byte array.
    
    Parameters:
    
    buf - Byte array containing header
    
    boffset - Byte offset of header within byte array
    
    Returns:
    
    Data rep
  - getBPA
```
public int getBPA()
```
    Get bytes per atom (BPA)
    
    Returns:
    
    Bytes per atom
  - setBPA
```
public void setBPA(int val)
```
    Set bytes per atom (BPA). For advanced usage only as setFormat(String) calculates and call this method to set bpa appropriately. Note this will downcast int to a byte to put into packet header.
    
    Parameters:
    
    val - BPA value
  - setFormat
```
public void setFormat(java.lang.String format)
```
    Set data format
    
    Parameters:
    
    format - Midas format digraph (e.g. "SB", "SI", etc.)
  - setTC
```
public void setTC(int mode,
                  int status,
                  double offset,
                  double wsec,
                  double fsec)
```
    Set timecode mode, status, offset whole seconds and fractional seconds
    
    Parameters:
    
    mode - Timecode mode
    
    status - Timecode mode
    
    offset - Offset at which timecode applies
    
    wsec - Timecode whole seconds
    
    fsec - Timecode fractional seconds
  - setTC
```
public void setTC(ICEPacket source)
```
  - getTC
```
public nxm.sys.lib.Time getTC()
```
    Get timecode as a Time object
    
    Returns:
    
    Current time code object
  - getTCMode
```
public byte getTCMode()
```
    get TC mode
    
    Returns:
    
    TimeCode mode
  - getTCStatus
```
public byte getTCStatus()
```
    get TC status
    
    Returns:
    
    TimeCode status
  - getTCO
```
public double getTCO()
```
    get TC offset
    
    Returns:
    
    TimeCode offset
  - decTCO
```
public void decTCO(int xfer)
```
    decrement TC offset
    
    Parameters:
    
    xfer - Number of samples to decrement offset by
  - getTC
```
public int getTC(nxm.sys.lib.Time tc,
                 double offset,
                 double delta)
```
    Get timecode
    
    Parameters:
    
    tc - TimeCode object to fill in
    
    offset - Sample offset
    
    delta - Sample delta
    
    Returns:
    
    Timecode status
  - setUserData
```
public void setUserData(double val,
                        int pos)
```
    Set the user data.
    
    Parameters:
    
    val - The value
    
    pos - The element position in the user data area (0-1)
  - setUserData
```
public void setUserData(long val,
                        int pos)
```
    Set the user data.
    
    Parameters:
    
    val - The value
    
    pos - The element position in the user data area (0-1)
  - setUserData
```
public void setUserData(float val,
                        int pos)
```
    Set the user data.
    
    Parameters:
    
    val - The value
    
    pos - The element position in the user data area (0-3)
  - setUserData
```
public void setUserData(int val,
                        int pos)
```
    Set the user data.
    
    Parameters:
    
    val - The value
    
    pos - The element position in the user data area (0-3)
  - setUserData
```
public void setUserData(short val,
                        int pos)
```
    Set the user data.
    
    Parameters:
    
    val - The value
    
    pos - The element position in the user data area (0-8)
  - setUserData
```
public void setUserData(byte val,
                        int pos)
```
    Set the user data.
    
    Parameters:
    
    val - The value
    
    pos - The element position in the user data area (0-16)
  - getUserDataD
```
public double getUserDataD(int pos)
```
    Get the user data as a double
    
    Parameters:
    
    pos - The element position in the user data area (0-1)
    
    Returns:
    
    User data value
  - getUserDataX
```
public long getUserDataX(int pos)
```
    Get the user data as a Midas X extra long type (Java long)
    
    Parameters:
    
    pos - The element position in the user data area (0-1)
    
    Returns:
    
    User data value
  - getUserDataF
```
public float getUserDataF(int pos)
```
    Get the user data as a float
    
    Parameters:
    
    pos - The element position in the user data area (0-3)
    
    Returns:
    
    User data value
  - getUserDataL
```
public int getUserDataL(int pos)
```
    Get the user data as a Midas L type (Java int)
    
    Parameters:
    
    pos - The element position in the user data area (0-3)
    
    Returns:
    
    User data value
  - getUserDataI
```
public short getUserDataI(int pos)
```
    Get the user data as a Midas I type (Java short)
    
    Parameters:
    
    pos - The element position in the user data area (0-8)
    
    Returns:
    
    User data value
  - getUserDataB
```
public byte getUserDataB(int pos)
```
    Get the user data as byte
    
    Parameters:
    
    pos - The element position in the user data area (0-16)
    
    Returns:
    
    User data value
  - setAbscissa
```
public void setAbscissa(double xstart,
                        double xdelta)
```
    set abscissa xstart and xdelta
    
    Parameters:
    
    xstart - The x start
    
    xdelta - The x delta
  - setMode
```
public void setMode(java.lang.String mode)
```
    set abscissa mode
    
    Parameters:
    
    mode - The special header mode
  - setFixedSize
```
public void setFixedSize(int size)
```
    Set fixed size mode
    
    Parameters:
    
    size - The desired fixed size
  - getChannel
```
public int getChannel()
```
    Get Channel number of this packet
    
    Returns:
    
    Channel number
  - getCount
```
public int getCount()
```
    Get the current packet count
    
    Returns:
    
    Packet count
  - getFormat
```
public java.lang.String getFormat()
```
    get the current Midas digraph format
    
    Returns:
    
    Packet data format
  - getSize
```
public int getSize()
```
    Get Size of packet data in elements
    
    Returns:
    
    Packet data size
  - getBytes
```
public int getBytes()
```
    Get size of packet data in bytes
    
    Returns:
    
    Packet 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)
```
    Get the configuration string from the data file
    
    Specified by:
    
    getConfiguration in interface nxm.sys.inc.PacketHandler
    
    Parameters:
    
    df - The data file to get the configuration for.
    
    Returns:
    
    Config string
  - setFileName
```
public void setFileName(nxm.sys.lib.DataFile df,
                        nxm.sys.lib.FileName filename)
```
    set filename for separate packet header file
    
    Specified by:
    
    setFileName in interface nxm.sys.inc.PacketHandler
    
    Parameters:
    
    df - Midas data file
    
    filename - The file name
  - naturalDataOffset
```
public double naturalDataOffset(nxm.sys.lib.DataFile df,
                                double boffset)
```
    Get the aligned data offset given a reasonable offset guesstimate.
    
    Specified by:
    
    naturalDataOffset in interface nxm.sys.inc.PacketHandler
    
    Parameters:
    
    df - Midas data file
    
    boffset - Approximate offset
    
    Returns:
    
    data offset
  - 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
    
    Parameters:
    
    df - The Midas data file
    
    boffset - The offset
    
    Returns:
    
    packet offset
    
    See Also:
    
    PacketHandler.packetToDataOffset(DataFile,double)
  - 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
    
    Parameters:
    
    df - The Midas data file
    
    boffset - The offset
    
    Returns:
    
    data offset
    
    See Also:
    
    PacketHandler.dataToPacketOffset(DataFile,double)
  - open
```
public void open(nxm.sys.lib.DataFile df)
```
    open the packet handler
    
    Specified by:
    
    open in interface nxm.sys.inc.PacketHandler
    
    Parameters:
    
    df - The Midas data file
  - 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
    
    Parameters:
    
    df - The Midas data file
    
    boffset - The offset
  - 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
    
    Parameters:
    
    df - The Midas data file
    
    buf - The buffer in which to read the header and data
    
    boff - Offset into buf
    
    bytes - number of bytes to read
    
    lbuf - Read into this if buf is null
    
    Returns:
    
    number of bytes read
  - 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
    
    Parameters:
    
    df - The Midas data file
    
    buf - The buffer from which to write
    
    boff - Offset into buf
    
    bytes - number of bytes to write
    
    lbuf - Write this if buf is null
    
    Returns:
    
    number of bytes read
  - close
```
public void close(nxm.sys.lib.DataFile df)
```
    Close the detached data file if not null
    
    Specified by:
    
    close in interface nxm.sys.inc.PacketHandler
    
    Parameters:
    
    df - The Midas data file
  - hasHeader
```
public boolean hasHeader()
```
    Does this packet have any headers
    
    Specified by:
    
    hasHeader in interface nxm.sys.inc.PacketHandler
    
    Returns:
    
    True if has header
  - listHeader
```
public java.lang.String listHeader()
```
    List the packet(s) header count, size, channel, format and timecode
    
    Specified by:
    
    listHeader in interface nxm.sys.inc.PacketHandler
    
    Returns:
    
    list string
  - cloneOf
```
public nxm.sys.inc.PacketHandler cloneOf()
```
    Make a clone of the packet handler
    
    Specified by:
    
    cloneOf in interface nxm.sys.inc.PacketHandler
    
    Returns:
    
    packe handler clone
  - copyFrom
```
public void copyFrom(ICEPacket source)
```
    Copy from another ICE packet object
    
    Parameters:
    
    source - ICEPacket class to copy from
  - setBuffer
```
public void setBuffer(byte[] ibuf,
                      int offset)
```
    set ICE packet from the specified byte array
    
    Parameters:
    
    ibuf - Byte array containing header
    
    offset - Byte offset of header within byte array

Class ICEPacket

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ABSC

FIXED

PKHO

headerLength

buf

Constructor Detail

ICEPacket

ICEPacket

ICEPacket

Method Detail

setBytes

setKeys

setUserKey

getUserKey

hasSync

hasSync

setCount

upCount

upCount

setSize

setUser

setChannel

setID

setRep

getRep

getRep

getBPA

setBPA

setFormat

setTC

setTC

getTC

getTCMode

getTCStatus

getTCO

decTCO

getTC

setUserData

setUserData

setUserData

setUserData

setUserData

setUserData

getUserDataD

getUserDataX

getUserDataF

getUserDataL

getUserDataI

getUserDataB

setAbscissa

setMode

setFixedSize

getChannel

getCount

getFormat

getSize

getBytes

getFixedSize

setRBData

getRBData

getConfiguration

setFileName

naturalDataOffset

dataToPacketOffset

packetToDataOffset

open

seek

read

write

close

hasHeader

listHeader

cloneOf

copyFrom