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

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

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

Public Member Functions

 LBMSDMRawUint64 ()
 Create a raw uint64 field, defaulting to 0.
 
 LBMSDMRawUint64 (ulong v)
 Create a raw uint64 field providing the value as a long. More...
 
virtual void set (ulong v)
 Set a raw uint64 field providing the value as a long. More...
 
virtual ulong get ()
 Get a raw uint64 field as a long. More...
 
virtual int format (byte[] buf, int offset)
 Format the raw uint64 value into a byte buffer. More...
 
override System.String ToString ()
 Get a string version of an uint64. More...
 
virtual int parse (byte[] buf, int offset)
 Parse the raw uint64 value from a byte buffer in to the object. More...
 
virtual ulong toUlong ()
 Get the long representation of the uint64. More...
 
virtual new System.Object Clone ()
 Get a copy of this object. 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...
 

Static Public Member Functions

static int format (byte[] buf, int offset, ulong v)
 Format an uint64 value into a byte buffer. More...
 
static ulong parse_s (byte[] buf, int offset)
 Parse the raw uint64 value from 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 = 8
 The number of bytes needed to store a raw LBMSDMRawUint64.
 

Detailed Description

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

Constructor & Destructor Documentation

com.latencybusters.lbm.sdm.LBMSDMRawUint64.LBMSDMRawUint64 ( ulong  v)

Create a raw uint64 field providing the value as a long.

Parameters
vThe long to seed this raw object

Member Function Documentation

static int com.latencybusters.lbm.sdm.LBMSDMRawUint64.format ( byte[]  buf,
int  offset,
ulong  v 
)
static

Format an uint64 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 uint64 to be formatted as a long
Returns
The offset after formatting the BigInteger

Referenced by com.latencybusters.lbm.sdm.LBMSDMFieldUint64.format(), and com.latencybusters.lbm.sdm.LBMSDMFieldUint64.toDbgString().

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

Format the raw uint64 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 ulong com.latencybusters.lbm.sdm.LBMSDMRawUint64.get ( )
virtual

Get a raw uint64 field as a long.

Returns
A copy of the long this object has

Referenced by com.latencybusters.lbm.sdm.LBMSDMArrayUint64.get(), and com.latencybusters.lbm.sdm.LBMSDMFieldUint64.get().

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.LBMSDMRawUint64.parse ( byte[]  buf,
int  offset 
)
virtual

Parse the raw uint64 value from a byte buffer in to the object.

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

Referenced by com.latencybusters.lbm.sdm.LBMSDMFieldUint64.parse().

static ulong com.latencybusters.lbm.sdm.LBMSDMRawUint64.parse_s ( byte[]  buf,
int  offset 
)
static

Parse the raw uint64 value from a byte buffer.

Parameters
bufThe buffer that contains the formatted value
offsetThe offset in to the buffer to start parsing
Returns
The uint64 value parsed as a long

Referenced by com.latencybusters.lbm.sdm.LBMSDMRawDouble.parse_s().

virtual void com.latencybusters.lbm.sdm.LBMSDMRawUint64.set ( ulong  v)
virtual

Set a raw uint64 field providing the value as a long.

Parameters
vThe long this raw object is to use

Referenced by com.latencybusters.lbm.sdm.LBMSDMRawUint64.Clone().

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.LBMSDMRawUint64.ToString ( )

Get a string version of an uint64.

Returns
A string representation of the uint64
virtual ulong com.latencybusters.lbm.sdm.LBMSDMRawUint64.toUlong ( )
virtual

Get the long representation of the uint64.

Returns
A long with the value of the object

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