LBM .Net API Documentation
PDMMessage Class
Namespacescom.latencybusters.pdmPDMMessage
A PDM message consists of a definition and the corresponding optional and required fields as specified by the definition. Use {@link PDMMessage#toBytes()} to serialize a message to bytes or {@link PDMMessage#parse(byte[])} to deserialize a message from bytes.
Declaration Syntax
C#
public class PDMMessage
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
PDMMessage()()()
Empty constructor can be used when the {@link PDMDefinition} is not available.

PDMMessage(PDMDefinition)
Creates a message from a finalized {@link PDMDefinition}

PDMMessage(Int32, Int32, Int32)
Creates a message from a finalized definition by looking it up in the {@link PDMDefinitionCache} by the id passed

createFieldIterator()()()
Creates a new {@link PDMFieldIterator} to traverse through the {@link PDMField}s

DataSegmentLen
Gets the length in bytes of the data segment

Definition
Gets the PDMDefinition property of the message

Deserializer
Gets or sets the PDMDeserializer property of the message

getFields()()()
Gets the list of PDMFields in this message

getFieldValue(PDMFieldInfo)
Gets a field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition}

getFieldValueAsBlob(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to byte[]

getFieldValueAsBlobArray(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to an array of blobs

getFieldValueAsBoolean(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to a Boolean

getFieldValueAsBooleanArray(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to boolean[]

getFieldValueAsDecimal(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to {@link PDMDecimal}

getFieldValueAsDecimalArray(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to {@link PDMDecimal}[]

getFieldValueAsDouble(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to Double

getFieldValueAsDoubleArray(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to double[]

getFieldValueAsFloat(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to Single

getFieldValueAsFloatArray(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to float[]

getFieldValueAsInt16(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to Int16

getFieldValueAsInt16Array(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to short[]

getFieldValueAsInt32(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to Int32

getFieldValueAsInt32Array(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to int[]

getFieldValueAsInt64(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to Int64

getFieldValueAsInt64Array(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to long[]

getFieldValueAsInt8(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to a SByte

getFieldValueAsInt8Array(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to sbyte[]

getFieldValueAsMessage(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to {@link PDMMessage}

getFieldValueAsMessageArray(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to {@link PDMMessage}[]

getFieldValueAsString(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to String

getFieldValueAsStringArray(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to String[]

getFieldValueAsTimestamp(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to {@link PDMTimestamp}

getFieldValueAsTimestampArray(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to {@link PDMTimestamp}[]

getFieldValueAsUInt16(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to UInt16

getFieldValueAsUInt16Array(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to ushort[]

getFieldValueAsUInt32(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to UInt32

getFieldValueAsUInt32Array(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to uint[]

getFieldValueAsUInt64(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to UInt64

getFieldValueAsUInt64Array(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to ulong[]

getFieldValueAsUInt8(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to a Byte

getFieldValueAsUInt8Array(PDMFieldInfo)
Gets the field value by using the {@link PDMFieldInfo} handle from the {@link PDMDefinition} and attempts to cast it to byte[]

IncludeDefinition
Returns whether the {@link PDMDefinition} will be included when serializing to bytes (defaults to false)

isFieldValueSet(PDMFieldInfo)
Checks to see if the field's value is set

loadDefinition(PDMDefinition)
Loads the {@link PDMDefinition} passed and initializes the {@link PDMMessage}

MessageLen
Gets the message length in bytes which is known after it has been serialized

MsgDirty
Gets or sets the value of the MsgDirty flag. When a message has been serialized and then changed, we need to be able to re-serialize the message before updating the array that it is in. A message is "dirty" if it is modified after it has been serialized.

parse(array<Byte>[]()[])
Deserializes a message from a byte array

parse(array<Byte>[]()[], Int32)
Deserializes a message from a byte array at position

parse(PDMDeserializer, array<Byte>[]()[], Int32)
Deserializes a message from a byte array at position

removeFieldValue(PDMFieldInfo)
Removes the field value (corresponding to the passed field info) from the message

Serializer
Gets or sets the PDMSerializer property of the message

setFieldValue(PDMFieldInfo, Boolean)
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.Boolean.

setFieldValue(PDMFieldInfo, SByte)
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.INT8.

setFieldValue(PDMFieldInfo, Byte)
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.UINT8.

setFieldValue(PDMFieldInfo, Int16)
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.INT16.

setFieldValue(PDMFieldInfo, UInt16)
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.UINT16.

setFieldValue(PDMFieldInfo, Int32)
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.INT32.

setFieldValue(PDMFieldInfo, UInt32)
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.UINT32.

setFieldValue(PDMFieldInfo, Int64)
Sets the field value in the message using the {@link PDMFieldInfo} handle that corresponition and should be of type PDMFieldType.INT64.

setFieldValue(PDMFieldInfo, UInt64)
Sets the field value in the message using the {@link PDMFieldInfo} handle that corresponition and should be of type PDMFieldType.UINT64.

setFieldValue(PDMFieldInfo, Single)
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.FLOAT.

setFieldValue(PDMFieldInfo, Double)
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.DOUBLE.

setFieldValue(PDMFieldInfo, PDMDecimal)
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.DECIMAL.

setFieldValue(PDMFieldInfo, PDMTimestamp)
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.Timestamp.

setFieldValue(PDMFieldInfo, String)
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.FIX_STRING or PDMFieldType.STRING or PDMFieldType.FIX_UNICODE or PDMFieldType.UNICODE.

setFieldValue(PDMFieldInfo, PDMMessage)
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.MESSAGE.

setFieldValue(PDMFieldInfo, array<Boolean>[]()[])
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.BOOLEAN_ARR.

setFieldValue(PDMFieldInfo, array<SByte>[]()[])
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.INT8_ARR.

setFieldValue(PDMFieldInfo, array<Byte>[]()[])
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.UINT8_ARR or PDMFieldType.BLOB.

setFieldValue(PDMFieldInfo, array<Int16>[]()[])
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.INT16_ARR.

setFieldValue(PDMFieldInfo, array<UInt16>[]()[])
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.UINT16_ARR.

setFieldValue(PDMFieldInfo, array<Int32>[]()[])
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.INT32_ARR.

setFieldValue(PDMFieldInfo, array<UInt32>[]()[])
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.UINT32_ARR.

setFieldValue(PDMFieldInfo, array<Int64>[]()[])
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.INT64_ARR.

setFieldValue(PDMFieldInfo, array<UInt64>[]()[])
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.UINT64_ARR.

setFieldValue(PDMFieldInfo, array<Single>[]()[])
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.FLOAT_ARR.

setFieldValue(PDMFieldInfo, array<Double>[]()[])
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.DOUBLE_ARR.

setFieldValue(PDMFieldInfo, array<PDMDecimal>[]()[])
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.DECIMAL_ARR.

setFieldValue(PDMFieldInfo, array<PDMTimestamp>[]()[])
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.TIMESTAMP_ARR.

setFieldValue(PDMFieldInfo, array<String>[]()[])
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.FIX_STRING_ARR or PDMFieldType.STRING_ARR or PDMFieldType.FIX_UNICODE_ARR or PDMFieldType.UNICODE_ARR.

setFieldValue(PDMFieldInfo, array<array<Byte>[]()[]>[]()[])
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.BLOB_ARR.

setFieldValue(PDMFieldInfo, array<PDMMessage>[]()[])
Sets the field value in the message using the {@link PDMFieldInfo} handle and should be of type PDMFieldType.MESSAGE_ARR.

toBytes()()()
Serializes the message to a new byte array

toBytes(PDMSerializer)
Serializes the message to a new byte array

toBytes(PDMSerializer, array<Byte>[]()[], Int32)
Serializes the message to an existing byte array at position

TryToLoadDefFromCache
Gets or sets whether or not an attempt will be made when parsing a message to try to automatically loaded a {@link PDMDefinition} from the {@link PDMDefinitionCache} if the one currently set doesn't exactly match the one in the incoming message; the current one will be replaced (defaults to false)

updateOptOrVarFlag(PDMField)
Used internally to update the flag if needed to indicate that the message contains at least one optional or variable field

UseMsgDefIfNeeded
Gets or sets whether an included {@link PDMDefinition} should be parsed and used instead of the previously set {@link PDMDefinition} in cases where the two ids, major versions, and minor versions do not match exactly (defaults to false)

VERSION_POLICY_BEST
a const variable for "best" versioning policy

VERSION_POLICY_EXACT
a const variable for "exact" versioning policy

VersionPolicy
Gets or sets the VersionPolicy property of the message

Inheritance Hierarchy
Object
PDMMessage

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