LBM .Net API Documentation
LBMSDMField Class
Namespacescom.latencybusters.lbm.sdmLBMSDMField
LBMSDMField is the base class for all LBM SDM field types. All base LBM SDM field types use the naming convention LBMSDMField(Type). Field arrays are subclasses of the respective field class and use the naming convention LBMSDMArray(Type). LBMSDMRaw(BaseType) is used as the naming convention for raw data types where needed and support the respective LBMSDMField(Type) classes.
Declaration Syntax
C#
public class LBMSDMField : LBMSDM, 
	ICloneable
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
LBMSDMField()()()
Create an untyped, unnamed field

LBMSDMField(String, Int16)
Create a named field with a defined type - used by derived classes

add_element(LBMSDMField)
Add an element to an array from a field

append(LBMSDMField)
This is overridden by array classes

Clone()()()
Clone this field

debug_level
Debug mask for SDM implementation.
(Inherited from LBMSDM.)
elements
Number of elements in array

format(array<Byte>[]()[], Int32)
This is overridden by field and array subclasses

format_name(array<Byte>[]()[], Int32)
Format into a byte buffer the name of this field. Only needed by LBMSDMessage to format messages

format_type(array<Byte>[]()[], Int32)
Format into a byte buffer the type of this field. Only needed by LBMSDMessage to format messages

get_len()()()
This is overridden by field and array subclasses

get_name()()()
Get the field name

getType(String, Boolean)
Get the TYPE_XXX value for a given string. Recognised strings are: boolean, int8, uint8, int16, uint16, int32, uint32, int64, uint64, float, double, decimal, timestamp, message, string, unicode, blob

getType()()()
Get the type of this field

getTypeString()()()
Get a string representing this field type

internalString(String, String)
Create a string based on the internal representation (includes the type)

isNull()()()
Test to see if this field is a null field (I.E. a field with no data)

length()()()
Return the number of elements in an array.

log(String)
Log an event. If debug level is set greater than 0, output to stderr
(Inherited from LBMSDM.)
MAX_FIELD_NAME_LENGTH
Maximum length of a field name.

name
The name of this field

name_len()()()
Get the length of this fields name in raw form. This is only needed by LBMSDMessage to format a raw message.

parse(array<Byte>[]()[], Int32)
This is overridden by field and array subclasses

remove(Int32)
Remove an element from an array class

sameBaseType(LBMSDMField)
Compare the base type of the field to this field

sameType(LBMSDMField)
Compare the type of the field to this field

set(LBMSDMField, Int32)
This is overridden by array classes

set_debug_level(Int32)
Set the debug level for processing this SDM message. Currently all debugs go to standard out.
(Inherited from LBMSDM.)
set_name(String)
Set the name of this field. A copy of the name will be made.

setNull()()()
Set this field to a null value - discarding current value (if any)

toDbgString()()()
Create a string useful for debugging.

type
The current field type

TYPE_ARRAY_BLOB
SDM field type: Array of Binary Large Objects (BLOB).

TYPE_ARRAY_BOOLEAN
SDM field type: Array of Booleans (non-zero is true; zero is false).

TYPE_ARRAY_DECIMAL
SDM field type: Array of decimal numbers.

TYPE_ARRAY_DOUBLE
SDM field type: Array of double-precision floating points.

TYPE_ARRAY_FLOAT
SDM field type: Array of single-precision floating points.

TYPE_ARRAY_INT16
SDM field type: Array of 16-bit signed integers.

TYPE_ARRAY_INT32
SDM field type: Array of 32-bit signed integers.

TYPE_ARRAY_INT64
SDM field type: Array of 64-bit signed integers.

TYPE_ARRAY_INT8
SDM field type: Array of 8-bit signed integers.

TYPE_ARRAY_MESSAGE
SDM field type: Array of nested SDM messages.

TYPE_ARRAY_STRING
SDM field type: Array of character strings (ASCIZ).

TYPE_ARRAY_TIMESTAMP
SDM field type: Array of timestamps (seconds and microseconds since the epoch (UTC)).

TYPE_ARRAY_UINT16
SDM field type: Array of 16-bit unsigned integers.

TYPE_ARRAY_UINT32
SDM field type: Array of 32-bit unsigned integers.

TYPE_ARRAY_UINT64
SDM field type: Array of 64-bit unsigned integers.

TYPE_ARRAY_UINT8
SDM field type: Array of 8-bit unsigned integers.

TYPE_ARRAY_UNICODE
SDM field type: Array of unicode strings.

TYPE_BLOB
SDM field type: Binary Large Object (BLOB).

TYPE_BOOLEAN
SDM field type: Boolean (non-zero is true; zero is false).

TYPE_DECIMAL
SDM field type: Decimal number.

TYPE_DOUBLE
SDM field type: Double-precision floating point.

TYPE_FLOAT
SDM field type: Single-precision floating point.

TYPE_INT16
SDM field type: 16-bit signed integer.

TYPE_INT32
SDM field type: 32-bit signed integer.

TYPE_INT64
SDM field type: 64-bit signed integer.

TYPE_INT8
SDM field type: 8-bit signed integer.

TYPE_INVALID
SDM field type: Type is invalid.

type_len()()()
Get the length of the type field in raw form. This is only needed by LBMSDMessage to format a raw message.

TYPE_MESSAGE
SDM field type: Nested SDM message.

TYPE_STRING
SDM field type: Character string (ASCIZ).

TYPE_TIMESTAMP
SDM field type: Seconds and microseconds since the epoch (UTC).

TYPE_UINT16
SDM field type: 16-bit unsigned integer.

TYPE_UINT32
SDM field type: 32-bit unsigned integer.

TYPE_UINT64
SDM field type: 64-bit unsigned integer.

TYPE_UINT8
SDM field type: 8-bit unsigned integer.

TYPE_UNICODE
SDM field type: Unicode string.

TypeString
Get a string representing this field type

Inheritance Hierarchy

Assembly: lbmcssdm (Module: lbmcssdm) Version: 6.7.1.0