LBM .Net API Documentation
LBMSDMFieldString Class
Namespacescom.latencybusters.lbm.sdmLBMSDMFieldString
Implements an SDM Field of type String
Declaration Syntax
C#
public class LBMSDMFieldString : LBMSDMField, 
	ICloneable
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
LBMSDMFieldString(String)
Constructor for an empty string field.

LBMSDMFieldString(String, String)
Constructor for a string field with a known string

LBMSDMFieldString(Int16, String)
Constructor for array subclasses

add_element(LBMSDMField)
Add an element to an array from a field
(Inherited from LBMSDMField.)
append(LBMSDMField)
This is overridden by array classes
(Inherited from LBMSDMField.)
Clone()()()
Get a copy of this object
(Overrides LBMSDMField.Clone()()().)
debug_level
Debug mask for SDM implementation.
(Inherited from LBMSDM.)
elements
Number of elements in array
(Inherited from LBMSDMField.)
format(array<Byte>[]()[], Int32, String, Int32)
Format a raw string in to a byte buffer specifying the size of the length field. This is because strings can be limited to 255 bytes for names. String fields can be longer than 255 characters.

format(array<Byte>[]()[], Int32)
Format the string as a long string The formatted message will use a 4 byte length field to describe the string size
(Overrides LBMSDMField.format(array<Byte>[]()[], Int32).)
format_long(array<Byte>[]()[], Int32, String)
Format a long string (greater than 255 characters) The formatted message will use a 4 byte length field to describe the string size

format_name(array<Byte>[]()[], Int32)
Format into a byte buffer the name of this field. Only needed by LBMSDMessage to format messages
(Inherited from LBMSDMField.)
format_short(array<Byte>[]()[], Int32, String)
Format a short string (less than 255 characters) The formatted message will use a 1 byte length field to describe the string size

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

get_base_len()()()
Get the length of formatted field This is used by the respective array class

get_len()()()
Get the length of formatted field
(Overrides LBMSDMField.get_len()()().)
get_name()()()
Get the field name
(Inherited from LBMSDMField.)
getType()()()
Get the type of this field
(Inherited from LBMSDMField.)
getTypeString()()()
Get a string representing this field type
(Inherited from LBMSDMField.)
internalString(String, String)
Create a string based on the internal representation (includes the type)
(Inherited from LBMSDMField.)
internalValue
The internal data storage for this field

isNull()()()
Test to see if this field is a null field (I.E. a field with no data)
(Inherited from LBMSDMField.)
length()()()
Return the number of elements in an array.
(Inherited from LBMSDMField.)
log(String)
Log an event. If debug level is set greater than 0, output to stderr
(Inherited from LBMSDM.)
name
The name of this field
(Inherited from LBMSDMField.)
name_len()()()
Get the length of this fields name in raw form. This is only needed by LBMSDMessage to format a raw message.
(Inherited from LBMSDMField.)
parse(array<Byte>[]()[], Int32)
Parse a byte buffer and store the value as the string value which is considered a long string
(Overrides LBMSDMField.parse(array<Byte>[]()[], Int32).)
parse_name(array<Byte>[]()[], Int32)
Parse a byte buffer and store the value as the name which is considered a short string

remove(Int32)
Remove an element from an array class
(Inherited from LBMSDMField.)
sameBaseType(LBMSDMField)
Compare the base type of the field to this field
(Inherited from LBMSDMField.)
sameType(LBMSDMField)
Compare the type of the field to this field
(Inherited from LBMSDMField.)
set(String)
Set the raw string.

set(LBMSDMField, Int32)
This is overridden by array classes
(Inherited from LBMSDMField.)
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.
(Inherited from LBMSDMField.)
setNull()()()
Set this field to a null value - discarding current value (if any)
(Inherited from LBMSDMField.)
toDbgString()()()
Get a string useful for debugging
(Overrides LBMSDMField.toDbgString()()().)
ToString()()()
Get the string
(Overrides Object.ToString()()().)
type
The current field type
(Inherited from LBMSDMField.)
type_len()()()
Get the length of the type field in raw form. This is only needed by LBMSDMessage to format a raw message.
(Inherited from LBMSDMField.)
TypeString
Get a string representing this field type
(Inherited from LBMSDMField.)
Inheritance Hierarchy
Object
LBMSDM
 LBMSDMField
  LBMSDMFieldString
   LBMSDMArrayString

Assembly: lbmcssdm (Module: lbmcssdm) Version: 6.7.1.0