UM .NET API
6.16.1
|
A PDM message consists of a definition and the corresponding optional and required fields as specified by the definition. Use PDMMessage#toBytes() to serialize a message to bytes or PDMMessage#parse(byte[]) to deserialize a message from bytes. More...
Public Member Functions | |
PDMMessage () | |
Empty constructor can be used when the PDMDefinition is not available. | |
PDMMessage (PDMDefinition definition) | |
Creates a message from a finalized PDMDefinition. More... | |
PDMMessage (int definitionId, int versionMajor, int versionMinor) | |
Creates a message from a finalized definition by looking it up in the PDMDefinitionCache by the id passed. More... | |
virtual void | updateOptOrVarFlag (PDMField field) |
Used internally to update the flag if needed to indicate that the message contains at least one optional or variable field. More... | |
bool | isFieldValueSet (PDMFieldInfo fieldInfo) |
Checks to see if the field's value is set. More... | |
virtual PDMFieldIterator | createFieldIterator () |
Creates a new PDMFieldIterator to traverse through the PDMFields. More... | |
virtual void | loadDefinition (PDMDefinition definition) |
Loads the PDMDefinition passed and initializes the PDMMessage. More... | |
virtual PDMMessage | removeFieldValue (PDMFieldInfo fieldInfo) |
Removes the field value (corresponding to the passed field info) from the message. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, bool newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.Boolean. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, sbyte newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.INT8. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, byte newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.UINT8. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, short newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.INT16. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, ushort newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.UINT16. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, int newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.INT32. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, uint newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.UINT32. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, long newValue) |
Sets the field value in the message using the PDMFieldInfo handle that corresponition and should be of type PDMFieldType.INT64. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, ulong newValue) |
Sets the field value in the message using the PDMFieldInfo handle that corresponition and should be of type PDMFieldType.UINT64. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, float newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.FLOAT. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, double newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.DOUBLE. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, PDMDecimal newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.DECIMAL. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, PDMTimestamp newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.Timestamp. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, System.String newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.FIX_STRING or PDMFieldType.STRING or PDMFieldType.FIX_UNICODE or PDMFieldType.UNICODE. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, PDMMessage newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.MESSAGE. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, bool[] newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.BOOLEAN_ARR. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, sbyte[] newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.INT8_ARR. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, byte[] newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.UINT8_ARR or PDMFieldType.BLOB. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, short[] newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.INT16_ARR. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, ushort[] newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.UINT16_ARR. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, int[] newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.INT32_ARR. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, uint[] newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.UINT32_ARR. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, long[] newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.INT64_ARR. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, ulong[] newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.UINT64_ARR. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, float[] newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.FLOAT_ARR. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, double[] newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.DOUBLE_ARR. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, PDMDecimal[] newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.DECIMAL_ARR. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, PDMTimestamp[] newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.TIMESTAMP_ARR. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, System.String[] newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.FIX_STRING_ARR or PDMFieldType.STRING_ARR or PDMFieldType.FIX_UNICODE_ARR or PDMFieldType.UNICODE_ARR. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, byte[][] newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.BLOB_ARR. More... | |
virtual PDMMessage | setFieldValue (PDMFieldInfo fieldInfo, PDMMessage[] newValue) |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.MESSAGE_ARR. More... | |
virtual System.Object | getFieldValue (PDMFieldInfo fieldInfo) |
Gets a field value by using the PDMFieldInfo handle from the PDMDefinition. More... | |
virtual System.Boolean | getFieldValueAsBoolean (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to a Boolean. More... | |
virtual System.SByte | getFieldValueAsInt8 (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to a SByte. More... | |
virtual System.Byte | getFieldValueAsUInt8 (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to a Byte. More... | |
virtual System.Int16 | getFieldValueAsInt16 (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to Int16. More... | |
virtual System.UInt16 | getFieldValueAsUInt16 (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to UInt16. More... | |
virtual System.Int32 | getFieldValueAsInt32 (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to Int32. More... | |
virtual System.UInt32 | getFieldValueAsUInt32 (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to UInt32. More... | |
virtual System.Int64 | getFieldValueAsInt64 (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to Int64. More... | |
virtual System.UInt64 | getFieldValueAsUInt64 (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to UInt64. More... | |
virtual System.Single | getFieldValueAsFloat (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to Single. More... | |
virtual System.Double | getFieldValueAsDouble (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to Double. More... | |
virtual PDMDecimal | getFieldValueAsDecimal (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to PDMDecimal. More... | |
virtual PDMTimestamp | getFieldValueAsTimestamp (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to PDMTimestamp. More... | |
virtual System.String | getFieldValueAsString (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to String. More... | |
virtual byte[] | getFieldValueAsBlob (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to byte[]. More... | |
virtual PDMMessage | getFieldValueAsMessage (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to PDMMessage. More... | |
virtual bool[] | getFieldValueAsBooleanArray (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to boolean[]. More... | |
virtual sbyte[] | getFieldValueAsInt8Array (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to sbyte[]. More... | |
virtual byte[] | getFieldValueAsUInt8Array (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to byte[]. More... | |
virtual short[] | getFieldValueAsInt16Array (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to short[]. More... | |
virtual ushort[] | getFieldValueAsUInt16Array (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to ushort[]. More... | |
virtual int[] | getFieldValueAsInt32Array (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to int[]. More... | |
virtual uint[] | getFieldValueAsUInt32Array (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to uint[]. More... | |
virtual long[] | getFieldValueAsInt64Array (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to long[]. More... | |
virtual ulong[] | getFieldValueAsUInt64Array (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to ulong[]. More... | |
virtual float[] | getFieldValueAsFloatArray (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to float[]. More... | |
virtual double[] | getFieldValueAsDoubleArray (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to double[]. More... | |
virtual PDMDecimal[] | getFieldValueAsDecimalArray (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to PDMDecimal[]. More... | |
virtual PDMTimestamp[] | getFieldValueAsTimestampArray (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to PDMTimestamp[]. More... | |
virtual System.String[] | getFieldValueAsStringArray (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to String[]. More... | |
virtual byte[][] | getFieldValueAsBlobArray (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to an array of blobs. More... | |
virtual PDMMessage[] | getFieldValueAsMessageArray (PDMFieldInfo fieldInfo) |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to PDMMessage[]. More... | |
virtual byte[] | toBytes () |
Serializes the message to a new byte array. More... | |
virtual byte[] | toBytes (PDMSerializer ser) |
Serializes the message to a new byte array. More... | |
virtual int | toBytes (PDMSerializer ser, byte[] ba, int pos) |
Serializes the message to an existing byte array at position. More... | |
virtual int | parse (byte[] ba) |
Deserializes a message from a byte array. More... | |
virtual int | parse (byte[] ba, int pos) |
Deserializes a message from a byte array at position. More... | |
virtual int | parse (PDMDeserializer deser, byte[] ba, int pos) |
Deserializes a message from a byte array at position. More... | |
Public Attributes | |
const int | VERSION_POLICY_EXACT = 0 |
a const variable for "exact" versioning policy | |
const int | VERSION_POLICY_BEST = 1 |
a const variable for "best" versioning policy | |
Protected Member Functions | |
List< PDMField > | getFields () |
Gets the list of PDMFields in this message. More... | |
Properties | |
virtual PDMDefinition | Definition [get] |
Gets the PDMDefinition property of the message. More... | |
virtual PDMSerializer | Serializer [get, set] |
Gets or sets the PDMSerializer property of the message. More... | |
virtual PDMDeserializer | Deserializer [get, set] |
Gets or sets the PDMDeserializer property of the message. More... | |
virtual int | VersionPolicy [get, set] |
Gets or sets the VersionPolicy property of the message. More... | |
virtual bool | IncludeDefinition [get, set] |
Returns whether the PDMDefinition will be included when serializing to bytes (defaults to false) More... | |
virtual bool | UseMsgDefIfNeeded [get, set] |
Gets or sets whether an included PDMDefinition should be parsed and used instead of the previously set PDMDefinition in cases where the two ids, major versions, and minor versions do not match exactly (defaults to false) More... | |
virtual bool | TryToLoadDefFromCache [get, set] |
Gets or sets whether or not an attempt will be made when parsing a message to try to automatically loaded a PDMDefinition from the 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) More... | |
virtual int | MessageLen [get] |
Gets the message length in bytes which is known after it has been serialized. More... | |
virtual bool | MsgDirty [get, set] |
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. More... | |
A PDM message consists of a definition and the corresponding optional and required fields as specified by the definition. Use PDMMessage#toBytes() to serialize a message to bytes or PDMMessage#parse(byte[]) to deserialize a message from bytes.
com.latencybusters.pdm.PDMMessage.PDMMessage | ( | PDMDefinition | definition | ) |
Creates a message from a finalized PDMDefinition.
definition | The finalized PDMDefinition |
com.latencybusters.pdm.PDMMessage.PDMMessage | ( | int | definitionId, |
int | versionMajor, | ||
int | versionMinor | ||
) |
Creates a message from a finalized definition by looking it up in the PDMDefinitionCache by the id passed.
definitionId | The definition id to lookup in the cache |
versionMajor | The definition major version used in the lookup |
versionMinor | The definition minor version used in the lookup |
References com.latencybusters.pdm.PDMDefinitionCache.get(), and com.latencybusters.pdm.PDMDefinitionCache.Instance.
|
virtual |
Creates a new PDMFieldIterator to traverse through the PDMFields.
|
protected |
Gets the list of PDMFields in this message.
References com.latencybusters.pdm.PDMSection.Buffer, com.latencybusters.pdm.PDMOffsetTable.clear(), com.latencybusters.pdm.PDMSegmentHeader.clear(), com.latencybusters.pdm.PDMDefinition.compareTo(), com.latencybusters.pdm.PDMDefinition.compareToWithVersion(), com.latencybusters.pdm.PDMSection.createBuffer(), com.latencybusters.pdm.PDMField.FieldInfo, com.latencybusters.pdm.PDMDefinitionCache.get(), com.latencybusters.pdm.PDMOffsetTable.get(), com.latencybusters.pdm.PDMDefinition.getFieldInfoList(), com.latencybusters.pdm.PDMDefinition.Id, com.latencybusters.pdm.PDMDeserializer.isByteSwap(), com.latencybusters.pdm.PDMField.isValueSet(), com.latencybusters.pdm.PDMOffsetTable.MinOffsetIndex, com.latencybusters.pdm.PDMDefinition.MsgVersMajor, com.latencybusters.pdm.PDMDefinition.MsgVersMinor, com.latencybusters.pdm.PDMDefinition.NumFields, com.latencybusters.pdm.PDMOffsetTable.Offsets, com.latencybusters.pdm.PDMOffsetTable.parse(), com.latencybusters.pdm.PDMSegmentHeader.parse(), com.latencybusters.pdm.PDMDefinition.parse(), com.latencybusters.pdm.PDMDeserializer.readInt(), com.latencybusters.pdm.PDMOffsetTable.set(), com.latencybusters.pdm.PDMOffsetTable.Size, com.latencybusters.pdm.PDMOffsetTable.toBytes(), com.latencybusters.pdm.PDMMessageHeader.toBytes(), com.latencybusters.pdm.PDMSegmentHeader.toBytes(), com.latencybusters.pdm.PDMDefinition.toBytes(), com.latencybusters.pdm.PDMMessage.VERSION_POLICY_BEST, com.latencybusters.pdm.PDMMessage.VERSION_POLICY_EXACT, and com.latencybusters.pdm.PDMSerializer.writeByteArray().
|
virtual |
Gets a field value by using the PDMFieldInfo handle from the PDMDefinition.
fieldInfo | the PDMFieldInfo handle |
References com.latencybusters.pdm.PDMField.getValue(), and com.latencybusters.pdm.PDMField.isValueSet().
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to byte[].
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to an array of blobs.
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to a Boolean.
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to boolean[].
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to PDMDecimal.
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to PDMDecimal[].
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to Double.
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to double[].
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to Single.
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to float[].
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to Int16.
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to short[].
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to Int32.
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to int[].
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to Int64.
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to long[].
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to a SByte.
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to sbyte[].
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to PDMMessage.
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to PDMMessage[].
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to String.
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to String[].
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to PDMTimestamp.
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to PDMTimestamp[].
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to UInt16.
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to ushort[].
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to UInt32.
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to uint[].
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to UInt64.
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to ulong[].
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to a Byte.
fieldInfo | the PDMFieldInfo handle |
|
virtual |
Gets the field value by using the PDMFieldInfo handle from the PDMDefinition and attempts to cast it to byte[].
fieldInfo | the PDMFieldInfo handle |
bool com.latencybusters.pdm.PDMMessage.isFieldValueSet | ( | PDMFieldInfo | fieldInfo | ) |
Checks to see if the field's value is set.
fieldInfo | the corresponding field info handle |
References com.latencybusters.pdm.PDMField.isValueSet().
|
virtual |
Loads the PDMDefinition passed and initializes the PDMMessage.
definition | the PDMDefinition to load |
References com.latencybusters.pdm.PDMDefinition.Finalized.
|
virtual |
Deserializes a message from a byte array.
ba | the byte array |
Referenced by com.latencybusters.pdm.PDMField.getMessageArrayValue(), com.latencybusters.pdm.PDMField.getMessageValue(), and com.latencybusters.pdm.PDMField.isValueSet().
|
virtual |
Deserializes a message from a byte array at position.
ba | the byte array |
pos | the starting position |
|
virtual |
Deserializes a message from a byte array at position.
deser | the PDMDeserializer to use |
ba | the byte array |
pos | the starting position |
References com.latencybusters.pdm.PDMMessageHeader.parse().
|
virtual |
Removes the field value (corresponding to the passed field info) from the message.
fieldInfo | the PDMFieldInfo of the field to remove |
References com.latencybusters.pdm.PDMField.FieldInfo, and com.latencybusters.pdm.PDMField.isValueSet().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.Boolean.
fieldInfo | the PDMFieldInfo handle |
newValue | the bool value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.INT8.
fieldInfo | the PDMFieldInfo handle |
newValue | the sbyte value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.UINT8.
fieldInfo | the PDMFieldInfo handle |
newValue | the byte value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.INT16.
fieldInfo | the PDMFieldInfo handle |
newValue | the short value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.UINT16.
fieldInfo | the PDMFieldInfo handle |
newValue | the ushort value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.INT32.
fieldInfo | the PDMFieldInfo handle |
newValue | the int value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.UINT32.
fieldInfo | the PDMFieldInfo handle |
newValue | the uint value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle that corresponition and should be of type PDMFieldType.INT64.
fieldInfo | the PDMFieldInfo handle |
newValue | the long value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle that corresponition and should be of type PDMFieldType.UINT64.
fieldInfo | the PDMFieldInfo handle |
newValue | the ulong value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.FLOAT.
fieldInfo | the PDMFieldInfo handle |
newValue | the float value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.DOUBLE.
fieldInfo | the PDMFieldInfo handle |
newValue | the double value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.DECIMAL.
fieldInfo | the PDMFieldInfo handle |
newValue | the PDMDecimal value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.Timestamp.
fieldInfo | the PDMFieldInfo handle |
newValue | the PDMTimestamp value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.FIX_STRING or PDMFieldType.STRING or PDMFieldType.FIX_UNICODE or PDMFieldType.UNICODE.
fieldInfo | the PDMFieldInfo handle |
newValue | the String value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.MESSAGE.
fieldInfo | the PDMFieldInfo handle |
newValue | the PDMMessage value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.BOOLEAN_ARR.
fieldInfo | the PDMFieldInfo handle |
newValue | the bool array value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.INT8_ARR.
fieldInfo | the PDMFieldInfo handle |
newValue | the sbyte array value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.UINT8_ARR or PDMFieldType.BLOB.
fieldInfo | the PDMFieldInfo handle |
newValue | the byte array value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.INT16_ARR.
fieldInfo | the PDMFieldInfo handle |
newValue | the short array value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.UINT16_ARR.
fieldInfo | the PDMFieldInfo handle |
newValue | the ushort array value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.INT32_ARR.
fieldInfo | the PDMFieldInfo handle |
newValue | the int array value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.UINT32_ARR.
fieldInfo | the PDMFieldInfo handle |
newValue | the uint array value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.INT64_ARR.
fieldInfo | the PDMFieldInfo handle |
newValue | the long array value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.UINT64_ARR.
fieldInfo | the PDMFieldInfo handle |
newValue | the ulong array value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.FLOAT_ARR.
fieldInfo | the PDMFieldInfo handle |
newValue | the float array value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.DOUBLE_ARR.
fieldInfo | the PDMFieldInfo handle |
newValue | the double array value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.DECIMAL_ARR.
fieldInfo | the PDMFieldInfo handle |
newValue | the PDMDecimal array value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.TIMESTAMP_ARR.
fieldInfo | the PDMFieldInfo handle |
newValue | the PDMTimestamp array value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.FIX_STRING_ARR or PDMFieldType.STRING_ARR or PDMFieldType.FIX_UNICODE_ARR or PDMFieldType.UNICODE_ARR.
fieldInfo | the PDMFieldInfo handle |
newValue | the String array value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.BLOB_ARR.
fieldInfo | the PDMFieldInfo handle |
newValue | the byte[] array value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Sets the field value in the message using the PDMFieldInfo handle and should be of type PDMFieldType.MESSAGE_ARR.
fieldInfo | the PDMFieldInfo handle |
newValue | the PDMMessage array value |
References com.latencybusters.pdm.PDMField.setValue().
|
virtual |
Serializes the message to a new byte array.
|
virtual |
Serializes the message to a new byte array.
ser | the PDMSerializer to use |
|
virtual |
Serializes the message to an existing byte array at position.
ser | the PDMSerializer to use |
ba | the byte array |
pos | the starting position |
|
virtual |
Used internally to update the flag if needed to indicate that the message contains at least one optional or variable field.
field | the field to check |
References com.latencybusters.pdm.PDMField.FieldInfo, and com.latencybusters.pdm.PDMField.isValueSet().
|
get |
Gets the PDMDefinition property of the message.
Values: the definition for this message
|
getset |
Gets or sets the PDMDeserializer property of the message.
Values: the deserializer for this message
|
getset |
Returns whether the PDMDefinition will be included when serializing to bytes (defaults to false)
Values: the bool indicating whether to include the definition or not
Referenced by com.latencybusters.pdm.PDMField.setValue().
|
get |
Gets the message length in bytes which is known after it has been serialized.
Values: the message length in bytes
Referenced by com.latencybusters.pdm.PDMField.setValue().
|
getset |
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.
Values: the bool value
|
getset |
Gets or sets the PDMSerializer property of the message.
Values: the serializer for this message
Referenced by com.latencybusters.pdm.PDMField.setValue().
|
getset |
Gets or sets whether or not an attempt will be made when parsing a message to try to automatically loaded a PDMDefinition from the 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)
Values: the bool value
|
getset |
Gets or sets whether an included PDMDefinition should be parsed and used instead of the previously set PDMDefinition in cases where the two ids, major versions, and minor versions do not match exactly (defaults to false)
Values: the bool value
|
getset |
Gets or sets the VersionPolicy property of the message.
Values: the version policy of the message which should be VERSION_POLICY_BEST or VERSION_POLICY_EXACT