com.latencybusters.lbm.sdm
Class LBMSDMRawUint16

java.lang.Object
  com.latencybusters.lbm.sdm.LBMSDM
      com.latencybusters.lbm.sdm.LBMSDMRaw
          com.latencybusters.lbm.sdm.LBMSDMRawUint16

public class LBMSDMRawUint16
extends LBMSDMRaw

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

Field Summary

static int

length The number of bytes needed to store a raw LBMSDMRawUint16

Fields inherited from class com.latencybusters.lbm.sdm.LBMSDM

DEBUG_BASIC, debug_level, DEBUG_VERBOSE_PARSING

Constructor Summary

LBMSDMRawUint16()
Create a raw uint16 field, defaulting to 0

LBMSDMRawUint16(int v)
Set a raw uint16 field providing the value as an int

Method Summary

int	format(byte[] buf, int offset) Format the raw uint16 value into a byte buffer
static int	format(byte[] buf, int offset, int v) Format a uint16 value into a byte buffer
int	parse(byte[] buf, int offset) Parse the raw uint16 value from a byte buffer
void	set(int v) Set a uint16 field providing the value as an int
int	toInt() Get the int representation of the uint16
java.lang.String	toString() Get a string version of an uint16

Methods inherited from class com.latencybusters.lbm.sdm.LBMSDMRaw

toDbgString

Methods inherited from class com.latencybusters.lbm.sdm.LBMSDM

log, set_debug_level

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

length

public static int length

The number of bytes needed to store a raw LBMSDMRawUint16

Constructor Detail

LBMSDMRawUint16

public LBMSDMRawUint16()
                throws LBMSDMException

Create a raw uint16 field, defaulting to 0

Throws:

LBMSDMException

LBMSDMRawUint16

public 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

Throws:

LBMSDMUnsignedException - if an unsigned value is passed in

LBMSDMException

Method Detail

set

public void 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

Throws:

LBMSDMUnsignedException - if an unsigned value is passed in

LBMSDMException

format

public static int format(byte[] buf,
                         int offset,
                         int v)
                  throws LBMSDMException

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

Throws:

LBMSDMException

format

public int 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

Throws:

LBMSDMException

toString

public java.lang.String toString()

Get a string version of an uint16

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the uint16

parse

public int 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

Throws:

LBMSDMException

toInt

public int toInt()

Get the int representation of the uint16

Returns:

An int with the value of the object