UM .NET API  6.16
com.latencybusters.lbm.sdm.LBMSDMRawUint16 Class Reference

An LBMSDMRawUint16 is a helper class to minimise the effort of formatting and parsing unsigned 16 bit integers. More...

Inheritance diagram for com.latencybusters.lbm.sdm.LBMSDMRawUint16:
com.latencybusters.lbm.sdm.LBMSDMRaw com.latencybusters.lbm.sdm.LBMSDM

Public Member Functions

virtual void set (ushort v)
 Set a uint16 field providing the value as an int. More...
 
 LBMSDMRawUint16 ()
 Create a raw uint16 field, defaulting to 0.
 
 LBMSDMRawUint16 (ushort v)
 Set a raw uint16 field providing the value as an int. More...
 
virtual int format (byte[] buf, int offset)
 Format the raw uint16 value into a byte buffer. More...
 
override System.String ToString ()
 Get a string version of an uint16. More...
 
virtual int parse (byte[] buf, int offset)
 Parse the raw uint16 value from a byte buffer. More...
 
virtual ushort toUshort ()
 Get the int representation of the uint16. More...
 
virtual System.String toDbgString ()
 Get a debug string for this object. This is not expected to be called and exists for child classes. More...
 
virtual void set_debug_level (int level)
 Set the debug level for processing this SDM message. Currently all debugs go to standard out. More...
 
virtual void log (System.String s)
 Log an event. If debug level is set greater than 0, output to stderr. More...
 
System.Object Clone ()
 Get a copy of this object. More...
 

Static Public Member Functions

static int format (byte[] buf, int offset, ushort v)
 Format a uint16 value into a byte buffer. More...
 

Public Attributes

const int DEBUG_BASIC = 1
 Debug flag for basic debug output.
 
const int DEBUG_VERBOSE_PARSING = 2
 Debug flag for verbose message parsing output.
 

Static Public Attributes

static int length = 2
 The number of bytes needed to store a raw LBMSDMRawUint16.
 

Detailed Description

An LBMSDMRawUint16 is a helper class to minimise the effort of formatting and parsing unsigned 16 bit integers.

Constructor & Destructor Documentation

com.latencybusters.lbm.sdm.LBMSDMRawUint16.LBMSDMRawUint16 ( ushort  v)

Set a raw uint16 field providing the value as an int.

LBMSDMUnsignedException if an unsigned value is passed in

Parameters
vThe int to seed this raw object

Member Function Documentation

System.Object com.latencybusters.lbm.sdm.LBMSDM.Clone ( )
inherited

Get a copy of this object.

Returns
A new object with a copy
static int com.latencybusters.lbm.sdm.LBMSDMRawUint16.format ( byte[]  buf,
int  offset,
ushort  v 
)
static

Format a uint16 value into a byte buffer.

Parameters
bufThe buffer to contain the formatted value
offsetThe offset in to the buffer to start formatting
vThe value of the uint16 to be formatted as a long
Returns
The offset after formatting the int

Referenced by com.latencybusters.lbm.sdm.LBMSDMField.format_type().

virtual int com.latencybusters.lbm.sdm.LBMSDMRawUint16.format ( byte[]  buf,
int  offset 
)
virtual

Format the raw uint16 value into a byte buffer.

Parameters
bufThe buffer to contain the formatted value
offsetThe offset in to the buffer to start formatting
Returns
The offset after formatting this object
virtual void com.latencybusters.lbm.sdm.LBMSDM.log ( System.String  s)
virtualinherited

Log an event. If debug level is set greater than 0, output to stderr.

Parameters
sString containing the event to log
virtual int com.latencybusters.lbm.sdm.LBMSDMRawUint16.parse ( byte[]  buf,
int  offset 
)
virtual

Parse the raw uint16 value from a byte buffer.

Parameters
bufThe buffer that contains the formatted value
offsetThe offset in to the buffer to start parsing
Returns
the new offset after parsing the field
virtual void com.latencybusters.lbm.sdm.LBMSDMRawUint16.set ( ushort  v)
virtual

Set a uint16 field providing the value as an int.

Parameters
vThe int this raw object is to use
virtual void com.latencybusters.lbm.sdm.LBMSDM.set_debug_level ( int  level)
virtualinherited

Set the debug level for processing this SDM message. Currently all debugs go to standard out.

Parameters
levelDebug level to set
virtual System.String com.latencybusters.lbm.sdm.LBMSDMRaw.toDbgString ( )
virtualinherited

Get a debug string for this object. This is not expected to be called and exists for child classes.

Returns
returns null - derived classes override with their value

Referenced by com.latencybusters.lbm.sdm.LBMSDMBadRawObjectException.LBMSDMBadRawObjectException().

override System.String com.latencybusters.lbm.sdm.LBMSDMRawUint16.ToString ( )

Get a string version of an uint16.

Returns
A string representation of the uint16
virtual ushort com.latencybusters.lbm.sdm.LBMSDMRawUint16.toUshort ( )
virtual

Get the int representation of the uint16.

Returns
An int with the value of the object

The documentation for this class was generated from the following file: