SDDSPacket

java.lang.Object
- nxm.ice.lib.SDDSPacket

All Implemented Interfaces:: java.lang.Cloneable, nxm.sys.inc.PacketHandler

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

Defines the header for SDDS packetized data.

    07:00 ICE/UDP header
    08:08 Format Identifier Mode {SF,SOS,PP,OF,SS,DM:3}
    09:09 Format Identifier Bits {CX,SNP,VW,BPS:5}
    11:10 Frame Sequence  (0x1F=parity packet)
    12:12 TimeTag Status {1msV,ttV,sscV,0,0,1msPtr[10:8]}
    13:13 TimeTag 1ms pointer {1msPtr[7:0]}
    15:14 TimeTag 1ms delta
    23:16 TimeTag 250ps tics (normal precision)
    27:24 TimeTag 250ps/2**32 tics (extended precision)
    39:28 SSC Info {DFDT:32,F:64}
    43:40 SSD Info
    63:44 AAD Info

TimeTag Status byte 0x80 1ms PTR valid 0x40 Time Tag valid 0x20 SSC Valid Standard Format Identifiers are: 16 bit FID=0x1082 8 bit FID=0x0881 4 bit FID=0x0480

Author:: Jeff Schoen

Field Summary

Fields
Modifier and Type Field and Description

byte[] buf

static int ICE

static int UDP

Fields
Modifier and Type	Field and Description
`byte[]`	`buf`
`static int`	`ICE`
`static int`	`UDP`

Constructor Summary

Constructors
Constructor and Description

SDDSPacket()

SDDSPacket(java.lang.String format, int flags)

Constructors
Constructor and Description
`SDDSPacket()`
`SDDSPacket(java.lang.String format, int flags)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`nxm.sys.inc.PacketHandler`	`cloneOf()` Create a clone of this instance for propagation.
`void`	`close(nxm.sys.lib.DataFile df)` Finalize this instance.
`double`	`dataToPacketOffset(nxm.sys.lib.DataFile df, double boffset)` Translate the data byte offset to packetized byte offset.
`int`	`getAddress()`
`java.lang.String`	`getAddrStr()`
`int`	`getBits()`
`void`	`getBuffer(byte[] buffer, int boff)`
`int`	`getBytes()`
`java.lang.String`	`getConfiguration(nxm.sys.lib.DataFile df)` Get the configuration string needed to initialize this handler.
`int`	`getCount()`
`java.lang.String`	`getFormat()`
`int`	`getPort()`
`int`	`getSize()`
`double`	`getSSC()`
`nxm.sys.lib.Time`	`getTC()`
`static nxm.sys.lib.Time`	`getTC(byte[] buf, int off, long lbuf)`
`int`	`getTCO()`
`int`	`getTCS()`
`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`	`setAddress(int addr)`
`void`	`setBits(int bits)`
`void`	`setBuffer(byte[] buffer, int boff)`
`void`	`setCount(int count)`
`void`	`setDelta(double delta)`
`void`	`setFileName(nxm.sys.lib.DataFile df, nxm.sys.lib.FileName filename)` Set the file name for a packets only file.
`void`	`setFormat(java.lang.String format)`
`void`	`setICE(boolean state)`
`void`	`setKeys(int key)`
`void`	`setPort(int port)`
`void`	`setSSC(double f, double dfdt)`
`void`	`setTC(int offset, double delta, double wsec, double fsec)`
`void`	`setUDP(boolean state)`
`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
  - UDP
```
public static final int UDP
```
    See Also:
    
    Constant Field Values
  - ICE
```
public static final int ICE
```
    See Also:
    
    Constant Field Values
  - buf
```
public byte[] buf
```
- Constructor Detail
  - SDDSPacket
```
public SDDSPacket()
```
  - SDDSPacket
```
public SDDSPacket(java.lang.String format,
                  int flags)
```
- Method Detail
  - setUDP
```
public void setUDP(boolean state)
```
  - setICE
```
public void setICE(boolean state)
```
  - setAddress
```
public void setAddress(int addr)
```
  - getAddress
```
public int getAddress()
```
  - getAddrStr
```
public java.lang.String getAddrStr()
```
  - setPort
```
public void setPort(int port)
```
  - getPort
```
public int getPort()
```
  - setKeys
```
public void setKeys(int key)
```
  - setBits
```
public void setBits(int bits)
```
  - getBits
```
public int getBits()
```
  - setCount
```
public void setCount(int count)
```
  - upCount
```
public void upCount()
```
  - setFormat
```
public void setFormat(java.lang.String format)
```
  - setSSC
```
public void setSSC(double f,
                   double dfdt)
```
  - setDelta
```
public void setDelta(double delta)
```
  - getSSC
```
public double getSSC()
```
  - setTC
```
public void setTC(int offset,
                  double delta,
                  double wsec,
                  double fsec)
```
  - getTC
```
public nxm.sys.lib.Time getTC()
```
  - getTC
```
public static nxm.sys.lib.Time getTC(byte[] buf,
                                     int off,
                                     long lbuf)
```
  - getTCS
```
public int getTCS()
```
  - getTCO
```
public int getTCO()
```
  - getCount
```
public int getCount()
```
  - getFormat
```
public java.lang.String getFormat()
```
  - getSize
```
public int getSize()
```
  - getBytes
```
public int getBytes()
```
  - 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)
  - 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.
  - 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.
  - 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)
```

Class SDDSPacket

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UDP

ICE

buf

Constructor Detail

SDDSPacket

SDDSPacket

Method Detail

setUDP

setICE

setAddress

getAddress

getAddrStr

setPort

getPort

setKeys

setBits

getBits

setCount

upCount

setFormat

setSSC

setDelta

getSSC

setTC

getTC

getTC

getTCS

getTCO

getCount

getFormat

getSize

getBytes

getConfiguration

setFileName

naturalDataOffset

dataToPacketOffset

packetToDataOffset

seek

open

read

write

close

hasHeader

listHeader

cloneOf

setBuffer

getBuffer