LBM .Net API Documentation
PDMField Class
Namespacescom.latencybusters.pdmPDMField
A field is element in the message that contains the value and a reference back to the field information that was created in the {@link PDMDefinition}
Declaration Syntax
C#
public class PDMField
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
PDMField(PDMFieldInfo, PDMSection, Int32, PDMSerializer, PDMDeserializer)
Initializes a new instance of the PDMField class

ByteSwap
Whether or not the bytes of the field need to be swapped

createBufferIfNeeded()()()
Creates the section buffer for the field if they are needed

FieldInfo
Gets the corresponding PDMFieldInfo from the PDMDefinition

FieldType
Gets the PDMFieldType of the PDMField

getBlobArrayValue()()()
Gets the actual value that was set in the field as Blob[]

getBlobValue()()()
Gets the actual value that was set in the field as Blob

getBooleanArrayValue()()()
Gets the actual value that was set in the field as Boolean[]

getBooleanValue()()()
Gets the actual value that was set in the field as Boolean

getDecimalArrayValue()()()
Gets the actual value that was set in the field as PDMDecimal[]

getDecimalValue()()()
Gets the actual value that was set in the field as PDMDecimal

getDoubleArrayValue()()()
Gets the actual value that was set in the field as Double[]

getDoubleValue()()()
Gets the actual value that was set in the field as Double

getFloatArrayValue()()()
Gets the actual value that was set in the field as Single[]

getFloatValue()()()
Gets the actual value that was set in the field as Float

getInt16ArrayValue()()()
Gets the actual value that was set in the field as Int16[]

getInt16Value()()()
Gets the actual value that was set in the field as Int16

getInt32ArrayValue()()()
Gets the actual value that was set in the field as Int32[]

getInt32Value()()()
Gets the actual value that was set in the field as Int32

getInt64ArrayValue()()()
Gets the actual value that was set in the field as Int64[]

getInt64Value()()()
Gets the actual value that was set in the field as Int64

getInt8ArrayValue()()()
Gets the actual value that was set in the field as Int8[]

getInt8Value()()()
Gets the actual value that was set in the field as Int8

getMessageArrayValue()()()
Gets the actual value that was set in the field as PDMMessage[]

getMessageValue()()()
Gets the actual value that was set in the field as PDMMessage

getStringArrayValue()()()
Gets the actual value that was set in the field as String[]

getStringValue()()()
Gets the actual value that was set in the field as String for types: FIX_STRING, STRING, FIX_UNICODE, UNICODE

getTimestampArrayValue()()()
Gets the actual value that was set in the field as PDMTimestamp[]

getTimestampValue()()()
Gets the actual value that was set in the field as PDMTimestamp

getUInt16ArrayValue()()()
Gets the actual value that was set in the field as UInt16[]

getUInt16Value()()()
Gets the actual value that was set in the field as UInt16

getUInt32ArrayValue()()()
Gets the actual value that was set in the field as UInt32[]

getUInt32Value()()()
Gets the actual value that was set in the field as UInt32

getUInt64ArrayValue()()()
Gets the actual value that was set in the field as UInt64[]

getUInt64Value()()()
Gets the actual value that was set in the field as Int64

getUInt8ArrayValue()()()
Gets the actual value that was set in the field as UInt8[]

getUInt8Value()()()
Gets the actual value that was set in the field as UInt8

getValue()()()
Gets the actual value that was set in the field.

Id
Gets the internal Id of the PDMField

IntName
Gets the IntName of the PDMField

isValueSet()()()
Used to check whether or not the value has been set for this PDMField

LenIncludingHeader
Gets the length in bytes of the field or -1 if it is variable length and cannot be determined yet

Offset
The Offset of the PDMField

OPT_FIX_HEADER_LEN
const variable for the length of an optional-fixed header

OPT_VAR_HEADER_LEN
const variable for the length of an optional-variable header

REQ_FIX_HEADER_LEN
const variable for the length of a required-fixed field header

REQ_VAR_HEADER_LEN
const variable for the length of a required-variable header

Section
The PDMSection of the PDMField

setValue(Boolean)
Sets the field value to the value passed

setValue(SByte)
Sets the field value to the value passed

setValue(Byte)
Sets the field value to the value passed

setValue(Int16)
Sets the field value to the value passed

setValue(UInt16)
Sets the field value to the value passed

setValue(Int32)
Sets the field value to the value passed

setValue(UInt32)
Sets the field value to the value passed

setValue(Int64)
Sets the field value to the value passed

setValue(UInt64)
Sets the field value to the value passed

setValue(Single)
Sets the field value to the value passed

setValue(Double)
Sets the field value to the value passed

setValue(PDMDecimal)
Sets the field value to the value passed

setValue(PDMTimestamp)
Sets the field value to the value passed

setValue(String)
Sets the field value to the value passed

setValue(PDMMessage)
Sets the field value to the value passed

setValue(array<Boolean>[]()[])
Sets the field value to the array value passed

setValue(array<SByte>[]()[])
Sets the field value to the array value passed

setValue(array<Byte>[]()[])
Sets the field value to the array value passed

setValue(array<Int16>[]()[])
Sets the field value to the array value passed

setValue(array<UInt16>[]()[])
Sets the field value to the array value passed

setValue(array<Int32>[]()[])
Sets the field value to the array value passed

setValue(array<UInt32>[]()[])
Sets the field value to the array value passed

setValue(array<Int64>[]()[])
Sets the field value to the array value passed

setValue(array<UInt64>[]()[])
Sets the field value to the array value passed

setValue(array<Single>[]()[])
Sets the field value to the array value passed

setValue(array<Double>[]()[])
Sets the field value to the array value passed

setValue(array<PDMDecimal>[]()[])
Sets the field value to the array value passed

setValue(array<PDMTimestamp>[]()[])
Sets the field value to the array value passed

setValue(array<String>[]()[])
Sets the field value to the array value passed

setValue(array<array<Byte>[]()[]>[]()[])
Sets the field value to the array value passed

setValue(array<PDMMessage>[]()[])
Sets the field value to the array value passed

setValueSet(Boolean)
Sets the bool to indicate whether or not the value has been set for this PDMField

StrName
Gets the StrName of the PDMField

swapBytes()()()
swaps the bytes of the field specific to the field type

UNICODE_CHAR_LEN
const variable for the forced length of a unicode character

VariableLen
The VariableLen of the PDMField

Inheritance Hierarchy
Object
PDMField

Assembly: lbmcspdm (Module: lbmcspdm) Version: 6.7.1.0 (1.0.0.0)