LBM .Net API Documentation
PDMDefinition Class
Namespacescom.latencybusters.pdmPDMDefinition
The message definition class that needs to be populated and finalized before using in a {@link PDMMessage}
Declaration Syntax
C#
public class PDMDefinition
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
PDMDefinition()()()
Protected constructor used by {@link PDMMessage} when parsing a PDMDefinition included with the {@link PDMMessage}

PDMDefinition(Int32)
Creates a new definition with the specified number of fields

PDMDefinition(Int32, Boolean)
Creates a new definition with the specified number of fields and whether or not to use ints or strings as field names

addFieldInfo(String, Int32, PDMFieldType, Int32, Boolean, Int32)
The main method used internally to add field information to the definition

addFieldInfo(String, PDMFieldType, Boolean)
Adds field information to the definition with a string field name

addFieldInfo(Int32, PDMFieldType, Boolean)
Adds field information to the definition with an int field name

addFieldInfo(String, PDMFieldType, Int32, Boolean)
Adds field information to the definition for a fixed length string field with a string field name

addFieldInfo(Int32, PDMFieldType, Int32, Boolean)
Adds field information to the definition for a fixed length string field with an int field name

addFieldInfo(String, PDMFieldType, Boolean, Int32)
Adds field information to the definition for a fixed-size array field with a string field name

addFieldInfo(Int32, PDMFieldType, Boolean, Int32)
Adds field information to the definition for a fixed-size array field with an int field name

addFieldInfo(String, PDMFieldType, Int32, Boolean, Int32)
Adds field information to the definition for a fixed-size array field of fixed length strings with a string field name

addFieldInfo(Int32, PDMFieldType, Int32, Boolean, Int32)
Adds field information to the definition for a fixed-size array field of fixed length strings with an int field name

calcLen(PDMSerializer)
Calculates the total length of the definition

compareTo(Int32)
Used to compare this {@link PDMDefinition} to another's id taking into account only the the definition id

compareTo(PDMDefinition)
Used to compare this {@link PDMDefinition} to another taking into account only the the definition id

compareToWithVersion(Int32, Int32, Int32)
Used to compare this {@link PDMDefinition} to another's properties taking into account the definition id and the major and minor message version

compareToWithVersion(PDMDefinition)
Used to compare this {@link PDMDefinition} to another taking into account the definition id and the major and minor message version

createFieldInfoIterator()()()
Creates an iterator of {@link PDMFieldInfo} to iterate through the field information

Finalized
The finalized property of the definition

finalizeDef()()()
Finalizes the definition to ready it for use in a message

FixedRequiredLen
Gets or calcs the length of the fixed required fields

getFieldInfo(Int32)
Access the field information by integer name

getFieldInfo(String)
Access the field information by String name

getFieldInfoById(Int32)
Gets the {@link PDMFieldInfo} object by its id

getFieldInfoList()()()
The accessor method for the list of field info

Id
The Id property of the definition

IntsForNames
The IntsForNames property of the definition

MsgVersMajor
The MsgVersMajor property of the definition

MsgVersMinor
The MsgVersMinor property of the definition

NumFields
The NumFields property of the definition

parse(PDMDeserializer, array<Byte>[]()[])
Parses an existing byte array into this object

parse(PDMDeserializer, array<Byte>[]()[], Int32)
Parses an existing byte array into this object

toBytes(PDMSerializer)
Serializes the {@link PDMDefinition} to a new byte array

toBytes(PDMSerializer, array<Byte>[]()[], Int32)
Serialize the {@link PDMDefinition} to an existing byte array

Inheritance Hierarchy
Object
PDMDefinition

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