com.latencybusters.lbm.sdm.LBMSDMRawUint16 Class Reference

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

Public Member Functions
void	set (int v) throws LBMSDMException
	LBMSDMRawUint16 () throws LBMSDMException
	LBMSDMRawUint16 (int v) throws LBMSDMException
int	format (byte[] buf, int offset) throws LBMSDMException
String	toString ()
int	parse (byte[] buf, int offset) throws LBMSDMException
int	toInt ()
String	toDbgString ()
void	set_debug_level (int level)
void	log (String s)

Static Public Member Functions
static int	format (byte[] buf, int offset, int v) throws LBMSDMException

Static Public Attributes
static int	length = 2
static final int	DEBUG_BASIC = 1
static final int	DEBUG_VERBOSE_PARSING = 2

Protected Attributes
int	debug_level = 0

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

(

)

throws LBMSDMException

Create a raw uint16 field, defaulting to 0

com.latencybusters.lbm.sdm.LBMSDMRawUint16.LBMSDMRawUint16

(

int

v

)

throws LBMSDMException

Set a raw uint16 field providing the value as an int

Parameters

v	The int to seed this raw object

Exceptions

LBMSDMUnsignedException

if an unsigned value is passed in

Member Function Documentation

static int com.latencybusters.lbm.sdm.LBMSDMRawUint16.format ( byte []  buf, int  offset, int  v  ) throws LBMSDMException

static

Format a uint16 value into a byte buffer

Parameters

buf	The buffer to contain the formatted value
offset	The offset in to the buffer to start formatting
v	The value of the uint16 to be formatted as a long

Returns

The offset after formatting the int

References com.latencybusters.lbm.sdm.LBMSDMRawUint16.length.

Referenced by com.latencybusters.lbm.sdm.LBMSDMRawUint16.format(), and com.latencybusters.lbm.sdm.LBMSDMField.format_type().

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

Format the raw uint16 value into a byte buffer

Parameters

buf	The buffer to contain the formatted value
offset	The offset in to the buffer to start formatting

Returns

The offset after formatting this object

References com.latencybusters.lbm.sdm.LBMSDMRawUint16.format(), and com.latencybusters.lbm.sdm.LBMSDMRawUint16.length.

void com.latencybusters.lbm.sdm.LBMSDM.log ( String  s )

inherited

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

Referenced by com.latencybusters.lbm.sdm.LBMSDMFields.get_attr(), com.latencybusters.lbm.sdm.LBMSDMFields.LBMSDMFields(), com.latencybusters.lbm.sdm.LBMSDMFieldBlob.set(), com.latencybusters.lbm.sdm.LBMSDMFieldMessage.set(), com.latencybusters.lbm.sdm.LBMSDMFieldDecimal.set(), com.latencybusters.lbm.sdm.LBMSDMFieldTimestamp.set(), com.latencybusters.lbm.sdm.LBMSDMArrayDecimal.set(), and com.latencybusters.lbm.sdm.LBMSDMArrayUint64.set().

int com.latencybusters.lbm.sdm.LBMSDMRawUint16.parse	(	byte []	buf,
		int	offset
	)		throws LBMSDMException

Parse the raw uint16 value from a byte buffer

Parameters

buf	The buffer that contains the formatted value
offset	The offset in to the buffer to start parsing

Returns

the new offset after parsing the field

References com.latencybusters.lbm.sdm.LBMSDMRawUint16.length, and com.latencybusters.lbm.sdm.LBMSDMRawUint16.toInt().

void com.latencybusters.lbm.sdm.LBMSDMRawUint16.set

(

int

v

)

throws LBMSDMException

Set a uint16 field providing the value as an int

Parameters

v	The int this raw object is to use

Exceptions

LBMSDMUnsignedException

if an unsigned value is passed in

void com.latencybusters.lbm.sdm.LBMSDM.set_debug_level ( int  level )

inherited

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

String com.latencybusters.lbm.sdm.LBMSDMRaw.toDbgString ( )

inherited

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

int com.latencybusters.lbm.sdm.LBMSDMRawUint16.toInt

(

)

Get the int representation of the uint16

Returns

An int with the value of the object

Referenced by com.latencybusters.lbm.sdm.LBMSDMRawUint16.parse(), and com.latencybusters.lbm.sdm.LBMSDMRawUint16.toString().

String com.latencybusters.lbm.sdm.LBMSDMRawUint16.toString

(

)

Get a string version of an uint16

Returns

A string representation of the uint16

References com.latencybusters.lbm.sdm.LBMSDMRawUint16.toInt().

Member Data Documentation

final int com.latencybusters.lbm.sdm.LBMSDM.DEBUG_BASIC = 1

staticinherited

Debug flag for basic debug output

int com.latencybusters.lbm.sdm.LBMSDM.debug_level = 0

protectedinherited

Debug mask for SDM implementation.

See also

set_debug_level

Referenced by com.latencybusters.lbm.sdm.LBMSDMessage.data(), com.latencybusters.lbm.sdm.LBMSDMessage.parse(), com.latencybusters.lbm.sdm.LBMSDMFieldMessage.parse(), and com.latencybusters.lbm.sdm.LBMSDMArrayMessage.parse().

final int com.latencybusters.lbm.sdm.LBMSDM.DEBUG_VERBOSE_PARSING = 2

staticinherited

Debug flag for verbose message parsing output

int com.latencybusters.lbm.sdm.LBMSDMRawUint16.length = 2

static

The number of bytes needed to store a raw LBMSDMRawUint16

Referenced by com.latencybusters.lbm.sdm.LBMSDMRawUint16.format(), com.latencybusters.lbm.sdm.LBMSDMField.format_type(), and com.latencybusters.lbm.sdm.LBMSDMRawUint16.parse().

---

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

• LBMSDMRawUint16.java