Class FlatMessage
FIX Protocol Message as a sequence of 'tag=value' pairs.
Inherited Members
Namespace: OnixS.Fix
Assembly: OnixS.Fix.Engine.dll
Syntax
public class FlatMessage : IMessage, IFieldSet, IEnumerable<Field>, IEnumerable
Constructors
FlatMessage(FlatMessage)
Copy constructor.
Declaration
public FlatMessage(FlatMessage flatMessage)
Parameters
Type | Name | Description |
---|---|---|
FlatMessage | flatMessage | source flat message to be copied |
FlatMessage(Message, Boolean)
Constructs an instance from the given Message.
Declaration
public FlatMessage(Message source, bool setApplVerId = true)
Parameters
Type | Name | Description |
---|---|---|
Message | source | Source message |
Boolean | setApplVerId | Option to set the |
FlatMessage(ProtocolVersion, Boolean)
Constructs an instance with empty required message header fields:
BeginString
, BodyLength
, MsgType
, SenderCompID
,
TargetCompID
, MsgSeqNum
, SendingTime
.
Declaration
public FlatMessage(ProtocolVersion version, bool setApplVerId = true)
Parameters
Type | Name | Description |
---|---|---|
ProtocolVersion | version | ProtocolVersion to be used during the message construction |
Boolean | setApplVerId | Option to set the |
FlatMessage(Byte[], Int32)
Constructs the instance from the given plain FIX (tag=value
) byte array.
Declaration
public FlatMessage(byte[] rawFixMessage, int length)
Parameters
Type | Name | Description |
---|---|---|
Byte[] | rawFixMessage | A plain FIX ( |
Int32 | length | the message length in bytes |
FlatMessage(Byte[], Int32, Int32)
Constructs the instance from the given plain FIX (tag=value
) byte array.
Declaration
public FlatMessage(byte[] rawFixMessage, int offset, int length)
Parameters
Type | Name | Description |
---|---|---|
Byte[] | rawFixMessage | A plain FIX ( |
Int32 | offset | Array offset |
Int32 | length | the message length in bytes |
FlatMessage(ReadOnlySpan<Byte>)
Constructs the instance from the given plain FIX (tag=value
) byte span.
Declaration
public FlatMessage(ReadOnlySpan<byte> rawFixMessage)
Parameters
Type | Name | Description |
---|---|---|
ReadOnlySpan<Byte> | rawFixMessage | A plain FIX ( |
FlatMessage(String)
Constructs the instance from the given plain FIX (tag=value
) string.
Declaration
public FlatMessage(string rawFixMessage)
Parameters
Type | Name | Description |
---|---|---|
String | rawFixMessage | A plain FIX ( |
Fields
IndexNotFound
Declaration
public const int IndexNotFound = -1
Field Value
Type | Description |
---|---|
Int32 |
Properties
Content
Declaration
public byte[] Content { get; }
Property Value
Type | Description |
---|---|
Byte[] |
ContentLength
Declaration
public int ContentLength { get; }
Property Value
Type | Description |
---|---|
Int32 |
FieldCount
Declaration
public int FieldCount { get; }
Property Value
Type | Description |
---|---|
Int32 |
Item[Int32]
Declaration
public string this[int tag] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag |
Property Value
Type | Description |
---|---|
String |
NumberOfFields
Return number of tag/value pairs.
Declaration
public int NumberOfFields { get; }
Property Value
Type | Description |
---|---|
Int32 | number of tag/value pairs. |
SenderCompId
Declaration
public string SenderCompId { get; }
Property Value
Type | Description |
---|---|
String |
SeqNum
Declaration
public int SeqNum { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
TargetCompId
Declaration
public string TargetCompId { get; }
Property Value
Type | Description |
---|---|
String |
Type
Declaration
public string Type { get; }
Property Value
Type | Description |
---|---|
String |
Version
FIX Protocol version.
Declaration
public ProtocolVersion Version { get; }
Property Value
Type | Description |
---|---|
ProtocolVersion |
Methods
Add(Int32, ByteBuffer)
Adds the given tag/value pair at the end of the message instance.
Note: Tag/value pair can be added multiple times, for example to build up a repeating group.
Declaration
public FlatMessage Add(int tag, ByteBuffer value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
ByteBuffer | value | field value represented as ByteBuffer |
Returns
Type | Description |
---|---|
FlatMessage | this |
Add(Int32, ByteBuffer, Int64, Int64)
Adds the given tag/value pair at the end of the message instance.
Note: Tag/value pair can be added multiple times, for example to build up a repeating group.
Declaration
public FlatMessage Add(int tag, ByteBuffer value, long startPosition, long length)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
ByteBuffer | value | field value represented as ByteBuffer |
Int64 | startPosition | |
Int64 | length |
Returns
Type | Description |
---|---|
FlatMessage | this |
Add(Int32, Byte[], Int32, Int32)
Adds the given tag/value pair at the end of the message instance.
Note: Tag/value pair can be added multiple times, for example to build up a repeating group.
Declaration
public FlatMessage Add(int tag, byte[] value, int offset, int length)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Byte[] | value | field value |
Int32 | offset | value offset |
Int32 | length | value length |
Returns
Type | Description |
---|---|
FlatMessage | this |
Add(Int32, Char)
Adds the given tag/value pair at the end of the message instance.
Note: Tag/value pair can be added multiple times, for example to build up a repeating group.
Declaration
public FlatMessage Add(int tag, char value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Char | value | field value represented as Char |
Returns
Type | Description |
---|---|
FlatMessage | this |
Add(Int32, DateTime)
Adds the given tag/value pair at the end of the message instance.
Note: Tag/value pair can be added multiple times, for example to build up a repeating group.
Declaration
public FlatMessage Add(int tag, DateTime value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
DateTime | value | field value represented as DateTime |
Returns
Type | Description |
---|---|
FlatMessage | this |
Add(Int32, Decimal)
Adds the given tag/value pair at the end of the message instance.
Note: Tag/value pair can be added multiple times, for example to build up a repeating group.
Declaration
public FlatMessage Add(int tag, decimal value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Decimal | value | field value represented as Decimal |
Returns
Type | Description |
---|---|
FlatMessage | this |
Add(Int32, Decimal, Int32)
Adds the given tag/value pair at the end of the message instance.
Note: Tag/value pair can be added multiple times, for example to build up a repeating group.
Declaration
public FlatMessage Add(int tag, decimal value, int precision)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Decimal | value | field value represented as Decimal |
Int32 | precision | the number of digits in decimal part |
Returns
Type | Description |
---|---|
FlatMessage | this |
Add(Int32, Double)
Adds the given tag/value pair at the end of the message instance.
Note: Tag/value pair can be added multiple times, for example to build up a repeating group.
Declaration
public FlatMessage Add(int tag, double value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Double | value | field value represented as Double |
Returns
Type | Description |
---|---|
FlatMessage | this |
Add(Int32, Double, Int32)
Adds the given tag/value pair at the end of the message instance.
Note: Tag/value pair can be added multiple times, for example to build up a repeating group.
Declaration
public FlatMessage Add(int tag, double value, int precision)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Double | value | field value represented as Double |
Int32 | precision | the number of digits in decimal part |
Returns
Type | Description |
---|---|
FlatMessage | this |
Add(Int32, Int32)
Adds the given tag/value pair at the end of the message instance.
Note: Tag/value pair can be added multiple times, for example to build up a repeating group.
Declaration
public FlatMessage Add(int tag, int value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Int32 | value | field value represented as Int32 |
Returns
Type | Description |
---|---|
FlatMessage | this |
Add(Int32, Int64)
Adds the given tag/value pair at the end of the message instance.
Note: Tag/value pair can be added multiple times, for example to build up a repeating group.
Declaration
public FlatMessage Add(int tag, long value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Int64 | value | field value represented as Int64 |
Returns
Type | Description |
---|---|
FlatMessage | this |
Add(Int32, ReadOnlySpan<Byte>)
Declaration
public FlatMessage Add(int tag, ReadOnlySpan<byte> value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
ReadOnlySpan<Byte> | value |
Returns
Type | Description |
---|---|
FlatMessage |
Add(Int32, String)
Adds the given tag/value pair at the end of the message instance.
Note: Tag/value pair can be added multiple times, for example to build up a repeating group.
Declaration
public FlatMessage Add(int tag, string value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Field tag |
String | value | Field value represented as String |
Returns
Type | Description |
---|---|
FlatMessage | this |
Remarks
If CheckSum is the last field then it is replaced by this pair
Add(Int32, StringBuilder)
Adds the given tag/value pair at the end of the message instance.
Note: Tag/value pair can be added multiple times, for example to build up a repeating group.
Declaration
public FlatMessage Add(int tag, StringBuilder value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Field tag |
StringBuilder | value | Field value represented as StringBuilder |
Returns
Type | Description |
---|---|
FlatMessage | this |
Remarks
If CheckSum is the last field then it is replaced by this pair
AddFlag(Int32, Boolean)
Declaration
public FlatMessage AddFlag(int tag, bool value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
Boolean | value |
Returns
Type | Description |
---|---|
FlatMessage |
Assemble(ByteBuffer)
Assembles the FIX message to the given buffer.
Note: The fields order should comply with the FIX Protocol requirements: the first field should be BeginString, the second field should be BodyLength.
Note: If the last field is not CheckSum then it will be added.
Note: This method updates both BodyLength and CheckSum values.
Declaration
public void Assemble(ByteBuffer buffer)
Parameters
Type | Name | Description |
---|---|---|
ByteBuffer | buffer | target byte buffer |
Assemble(ByteBuffer, ByteBuffer)
Assembles the FIX message to the given buffers.
Note: The fields order should comply with the FIX Protocol requirements: the first field should be BeginString, the second field should be BodyLength.
Note: If the last field is not CheckSum then it will be added.
Note: This method updates both BodyLength and CheckSum values.
Declaration
public void Assemble(ByteBuffer firstBuffer, ByteBuffer secondBuffer)
Parameters
Type | Name | Description |
---|---|---|
ByteBuffer | firstBuffer | target buffer where BeginString and BodyLength will be assembled |
ByteBuffer | secondBuffer | target buffer where the rest of fields will be assembled |
Clone()
Declaration
public FlatMessage Clone()
Returns
Type | Description |
---|---|
FlatMessage |
CompareFieldValue(Int32, String)
Declaration
public bool CompareFieldValue(int tag, string value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
String | value |
Returns
Type | Description |
---|---|
Boolean |
CompareType(Char)
Declaration
public bool CompareType(char type)
Parameters
Type | Name | Description |
---|---|---|
Char | type |
Returns
Type | Description |
---|---|
Boolean |
CompareType(String)
Declaration
public bool CompareType(string type)
Parameters
Type | Name | Description |
---|---|---|
String | type |
Returns
Type | Description |
---|---|
Boolean |
Contains(Int32)
Returns whether the field corresponding to the given tag exists.
Declaration
public bool Contains(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Returns
Type | Description |
---|---|
Boolean | true in case exits, false otherwise. |
FindIndex(Int32)
Finds the field index that corresponds to the given tag.
Note: If multiple tag/value pairs correspond to the given tag, it will return the first one only.
Declaration
public int FindIndex(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Field tag |
Returns
Type | Description |
---|---|
Int32 | Field index that corresponds to the given tag if the corresponding field is present, otherwise - IndexNotFound |
FindIndex(Int32, Int32)
Finds the field index that corresponds to the given tag and is located after the given index.
Note: This method allows to find indexes of all tag/value pairs correspond to the given tag.
Declaration
public int FindIndex(int tag, int indexToFindAfter)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Field tag |
Int32 | indexToFindAfter |
Returns
Type | Description |
---|---|
Int32 | Field index that corresponds to the given tag if the corresponding field is present, otherwise - IndexNotFound |
Get(Int32)
Returns the field value by the given tag.
Note: The linear search is performed until the tag is found.
Declaration
public string Get(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag |
Returns
Type | Description |
---|---|
String | the field value or |
Get(Int32, Int32)
Returns the field value by the given tag.
Note: The linear search is performed until the tag is found.
Declaration
public string Get(int tag, int hintFieldIndex)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag |
Int32 | hintFieldIndex | The search will be started from this field. |
Returns
Type | Description |
---|---|
String | the field value or |
Get(Int32, StringBuilder)
Declaration
public void Get(int tag, StringBuilder result)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
StringBuilder | result |
GetByIndex(Int32)
Returns the field value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public string GetByIndex(int index)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair |
Returns
Type | Description |
---|---|
String | the field value. |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
GetByIndex(Int32, out Field)
Fills the field with tag/value from the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public bool GetByIndex(int index, out Field field)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair |
Field | field | field to be filled |
Returns
Type | Description |
---|---|
Boolean | true in case the field index is valid, false otherwise. |
GetBytes(Int32)
Returns the field value as a byte array.
Declaration
public byte[] GetBytes(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
Returns
Type | Description |
---|---|
Byte[] | field value as a byte array, null if it is not set |
GetChar(Int32)
Returns the field value by the given tag.
Declaration
public char GetChar(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Returns
Type | Description |
---|---|
Char | the field value by the given tag, if it is not found.
|
Exceptions
Type | Condition |
---|---|
IncorrectFieldValueException | if the value is not a char |
GetCharByIndex(Int32)
Returns the field value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public char GetCharByIndex(int index)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair |
Returns
Type | Description |
---|---|
Char | the field value. |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
IncorrectFieldValueException | if the value is not a char |
GetDecimal(Int32)
Declaration
public decimal GetDecimal(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag |
Returns
Type | Description |
---|---|
Decimal |
GetDecimalByIndex(Int32)
Returns the field value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public decimal GetDecimalByIndex(int index)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair |
Returns
Type | Description |
---|---|
Decimal | the field value. |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
IncorrectFieldValueException | if the value cannot be parsed to double |
GetDouble(Int32)
Returns the field value by the given tag.
Declaration
public double GetDouble(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Returns
Type | Description |
---|---|
Double | the field value by the given tag, if it is not found.
|
Exceptions
Type | Condition |
---|---|
IncorrectFieldValueException | if the value cannot be parsed to double |
GetDoubleByIndex(Int32)
Returns the field value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public double GetDoubleByIndex(int index)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair |
Returns
Type | Description |
---|---|
Double | the field value. |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
IncorrectFieldValueException | if the value cannot be parsed to double |
GetEnumerator()
Declaration
public FlatMessage.FieldIterator GetEnumerator()
Returns
Type | Description |
---|---|
FlatMessage.FieldIterator |
GetFields()
Declaration
public Field[] GetFields()
Returns
Type | Description |
---|---|
Field[] |
GetFlag(Int32)
Returns the flag value by the given tag.
Declaration
public bool GetFlag(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Returns
Type | Description |
---|---|
Boolean | whether field exist and field value is equal to "Y" or "y" |
GetFlagByIndex(Int32)
Returns the field value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public bool GetFlagByIndex(int index)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair |
Returns
Type | Description |
---|---|
Boolean | the field value. |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
IncorrectFieldValueException | if the value is not a char |
GetHighResolutionTimeSpan(Int32)
Returns the field value as TimeSpan.
Declaration
public HighResolutionTimeSpan GetHighResolutionTimeSpan(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
Returns
Type | Description |
---|---|
HighResolutionTimeSpan | Field value as HighResolutionTimeSpan |
Exceptions
Type | Condition |
---|---|
TagNotFoundException | If the field is absent |
IncorrectFieldValueException | if the field value cannot be parsed to HighResolutionTimeSpan using
either |
GetHighResolutionTimeSpan(Int32, out TimeSpanFormat)
Returns the field value as TimeSpan and it's source format.
Declaration
public HighResolutionTimeSpan GetHighResolutionTimeSpan(int tag, out TimeSpanFormat format)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
TimeSpanFormat | format | Value format |
Returns
Type | Description |
---|---|
HighResolutionTimeSpan | Field value as HighResolutionTimeSpan |
Exceptions
Type | Condition |
---|---|
TagNotFoundException | If the field is absent |
IncorrectFieldValueException | if the field value cannot be parsed to HighResolutionTimeSpan using
either |
GetHighResolutionTimestamp(Int32)
Declaration
public HighResolutionTimestamp GetHighResolutionTimestamp(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag |
Returns
Type | Description |
---|---|
HighResolutionTimestamp |
GetHighResolutionTimestamp(Int32, out TimestampFormat)
Declaration
public HighResolutionTimestamp GetHighResolutionTimestamp(int tag, out TimestampFormat format)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
TimestampFormat | format |
Returns
Type | Description |
---|---|
HighResolutionTimestamp |
GetInteger(Int32)
Returns the field value by the given tag.
Declaration
public int GetInteger(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Returns
Type | Description |
---|---|
Int32 | the field value by the given tag, if it is not found.
|
Exceptions
Type | Condition |
---|---|
IncorrectFieldValueException | if the value cannot be parsed to int |
GetIntegerByIndex(Int32)
Returns the field value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public int GetIntegerByIndex(int index)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair |
Returns
Type | Description |
---|---|
Int32 | the field value. |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
IncorrectFieldValueException | if the value cannot be parsed to int |
GetLong(Int32)
Returns the field value by the given tag.
Declaration
public long GetLong(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Returns
Type | Description |
---|---|
Int64 | the field value by the given tag, if it is not found.
|
Exceptions
Type | Condition |
---|---|
IncorrectFieldValueException | if the value cannot be parsed to long |
GetLongByIndex(Int32)
Returns the field value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public long GetLongByIndex(int index)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair |
Returns
Type | Description |
---|---|
Int64 | the field value. |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
IncorrectFieldValueException | if the value cannot be parsed to long |
GetSpan(Int32)
Returns the field value by the given tag.
Declaration
public ReadOnlySpan<byte> GetSpan(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Returns
Type | Description |
---|---|
ReadOnlySpan<Byte> | the field value by the given tag, throws TagNotFoundException if it is not found. |
GetStructuredMessage(Dictionary, MessageValidationFlags)
Declaration
public virtual Message GetStructuredMessage(Dictionary dictionary, MessageValidationFlags parsingFlags)
Parameters
Type | Name | Description |
---|---|---|
Dictionary | dictionary | |
MessageValidationFlags | parsingFlags |
Returns
Type | Description |
---|---|
Message |
GetTagByIndex(Int32)
Returns the field tag at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public int GetTagByIndex(int index)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair |
Returns
Type | Description |
---|---|
Int32 | the field tag. |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
GetTimeSpan(Int32)
Returns the field value as TimeSpan.
Declaration
public TimeSpan GetTimeSpan(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
Returns
Type | Description |
---|---|
TimeSpan | Field value as TimeSpan |
Exceptions
Type | Condition |
---|---|
TagNotFoundException | If the field is absent |
IncorrectFieldValueException | if the field value cannot be parsed to TimeSpan using
either |
GetTimeSpan(Int32, out TimeSpanFormat)
Returns the field value as TimeSpan and it's source format.
Declaration
public TimeSpan GetTimeSpan(int tag, out TimeSpanFormat format)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
TimeSpanFormat | format | Value format |
Returns
Type | Description |
---|---|
TimeSpan | Field value as TimeSpan |
Exceptions
Type | Condition |
---|---|
TagNotFoundException | If the field is absent |
IncorrectFieldValueException | if the field value cannot be parsed to TimeSpan using
either |
GetTimestamp(Int32)
Returns the field value as DateTime.
Declaration
public DateTime GetTimestamp(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
Returns
Type | Description |
---|---|
DateTime | Field value as DateTime |
Exceptions
Type | Condition |
---|---|
TagNotFoundException | If the field is absent |
IncorrectFieldValueException | if the field value cannot be parsed to DateTime using
either |
GetTimestamp(Int32, out TimestampFormat)
Returns the field value as DateTime and it's source format.
Declaration
public DateTime GetTimestamp(int tag, out TimestampFormat format)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
TimestampFormat | format | Value format |
Returns
Type | Description |
---|---|
DateTime | Field value as DateTime |
Exceptions
Type | Condition |
---|---|
TagNotFoundException | If the field is absent |
IncorrectFieldValueException | if the field value cannot be parsed to DateTime using
either |
GetValues(Int32)
Returns all the values for all occurrences of a particular tag.
Declaration
public List<string> GetValues(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | fields tag |
Returns
Type | Description |
---|---|
List<String> | all the values for all occurrences of a particular tag. |
GetValues(Int32, List<String>)
Adds all the values for all occurrences of a particular tag to the given list.
Declaration
public void GetValues(int tag, List<string> list)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
List<String> | list | list to be filled |
IsAbsentOrEmpty(Int32)
Checks that the field is absent or empty.
Declaration
public bool IsAbsentOrEmpty(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
Returns
Type | Description |
---|---|
Boolean |
|
IsSessionLevel()
Returns true
if this is a session-level message, otherwise - false
.
Declaration
public bool IsSessionLevel()
Returns
Type | Description |
---|---|
Boolean |
|
Remove(Int32)
Removes the field by the given tag.
Declaration
public bool Remove(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Returns
Type | Description |
---|---|
Boolean |
|
RemoveLastField()
Removes the last field.
Declaration
public FlatMessage RemoveLastField()
Returns
Type | Description |
---|---|
FlatMessage | this |
Reset(FlatMessage)
Resets the flat message with the given one, allows to re-use internal data structures.
Declaration
public void Reset(FlatMessage source)
Parameters
Type | Name | Description |
---|---|---|
FlatMessage | source | Source Flat Message to be copied |
Reset(Byte[], Int32)
Resets the flat message with the given raw FIX message, allows to re-use internal data structures.
Declaration
public void Reset(byte[] rawFixMessage, int length)
Parameters
Type | Name | Description |
---|---|---|
Byte[] | rawFixMessage | raw FIX message in the tag=value form |
Int32 | length | the message length in bytes |
Reset(ReadOnlySpan<Byte>)
Declaration
public void Reset(ReadOnlySpan<byte> rawFixMessage)
Parameters
Type | Name | Description |
---|---|---|
ReadOnlySpan<Byte> | rawFixMessage |
Set(Int32, in HighResolutionTimeSpan)
Sets the field value as HighResolutionTimeSpan.
Declaration
public IFieldSet Set(int tag, in HighResolutionTimeSpan value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
HighResolutionTimeSpan | value | Field value |
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | if field with the given tag is not defined for this message and unknown fields are disabled |
Set(Int32, in HighResolutionTimeSpan, TimeSpanFormat)
Sets the field value as HighResolutionTimeSpan.
Declaration
public IFieldSet Set(int tag, in HighResolutionTimeSpan value, TimeSpanFormat format)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
HighResolutionTimeSpan | value | Field value |
TimeSpanFormat | format | Value format |
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | if field with the given tag is not defined for this message and unknown fields are disabled |
Set(Int32, in HighResolutionTimestamp)
Sets the field value as HighResolutionTimestamp.
Declaration
public IFieldSet Set(int tag, in HighResolutionTimestamp value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
HighResolutionTimestamp | value | Field value |
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | if field with the given tag is not defined for this message and unknown fields are disabled |
Set(Int32, in HighResolutionTimestamp, TimestampFormat)
Sets the field value as HighResolutionTimestamp.
Declaration
public IFieldSet Set(int tag, in HighResolutionTimestamp value, TimestampFormat format)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
HighResolutionTimestamp | value | Field value |
TimestampFormat | format | Value format |
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | if field with the given tag is not defined for this message and unknown fields are disabled |
Set(Int32, Boolean)
Sets the value as a flag: 'Y' or 'N'.
Declaration
public IFieldSet Set(int tag, bool value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
Boolean | value |
|
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | if field with the given tag is not defined for this message and unknown fields are disabled |
Set(Int32, Byte[])
Sets the value for the given tag.
Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.
Declaration
public IFieldSet Set(int tag, byte[] value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Byte[] | value | field value |
Returns
Type | Description |
---|---|
IFieldSet | this |
Set(Int32, Byte[], Int32, Int32)
Sets the value for the given tag.
Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.
Declaration
public IFieldSet Set(int tag, byte[] value, int offset, int length)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Byte[] | value | field value |
Int32 | offset | value offset |
Int32 | length | value length |
Returns
Type | Description |
---|---|
IFieldSet | this |
Set(Int32, Char)
Sets the field value as a character.
Declaration
public IFieldSet Set(int tag, char value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
Char | value | Field value |
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | If field with the given tag is not defined for this message type and unknown fields are disabled |
Set(Int32, DateTime)
Sets the field value as DateTime.
Declaration
public IFieldSet Set(int tag, DateTime value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
DateTime | value | Field value |
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | if field with the given tag is not defined for this message and unknown fields are disabled |
Set(Int32, DateTime, TimestampFormat)
Sets the field value as DateTime.
Declaration
public IFieldSet Set(int tag, DateTime value, TimestampFormat format)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
DateTime | value | Field value |
TimestampFormat | format | Value format |
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | if field with the given tag is not defined for this message and unknown fields are disabled |
Set(Int32, Decimal)
Sets the field value as Decimal .
Declaration
public IFieldSet Set(int tag, decimal value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
Decimal | value | Field value |
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | if field with the given tag is not defined for this message and unknown fields are disabled |
Set(Int32, Decimal, Int32)
Sets the field value as Decimal with the given number of decimal places.
Declaration
public IFieldSet Set(int tag, decimal value, int precision)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
Decimal | value | Field value |
Int32 | precision | The desired number of decimal places |
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | if field with the given tag is not defined for this message and unknown fields are disabled |
Set(Int32, Double)
Sets the Double field value.
Note: The double
type should not be used for precise values.
Note: Rounds value
to 15 significant digits using rounding to nearest. This is done even if the number has more than 15 digits and the less significant digits are zero.
Note: The number will be rounded towards nearest neighbor unless both neighbors are equidistant, in which case round up.
Declaration
public IFieldSet Set(int tag, double value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
Double | value | Field value |
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | if field with the given tag is not defined for this message and unknown fields are disabled |
Set(Int32, Double, Int32)
Sets the field value as Double with the given number of decimal places.
Note: The number will be rounded towards nearest neighbor unless both neighbors are equidistant, in which case round up.
Declaration
public IFieldSet Set(int tag, double value, int precision)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
Double | value | Field value |
Int32 | precision | The desired number of decimal places |
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | if field with the given tag is not defined for this message and unknown fields are disabled |
Set(Int32, Int32)
Sets the integer field value.
Declaration
public IFieldSet Set(int tag, int value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
Int32 | value | Field value |
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | if field with the given tag is not defined for this message and unknown fields are disabled |
Set(Int32, Int64)
Sets the long field value.
Declaration
public IFieldSet Set(int tag, long value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
Int64 | value | Field value |
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | if field with the given tag is not defined for this message and unknown fields are disabled |
Set(Int32, ReadOnlySpan<Byte>)
Declaration
public IFieldSet Set(int tag, ReadOnlySpan<byte> value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
ReadOnlySpan<Byte> | value |
Returns
Type | Description |
---|---|
IFieldSet |
Set(Int32, String)
Sets the value for the given tag.
Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.
Declaration
public IFieldSet Set(int tag, string value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
String | value | field value represented as String |
Returns
Type | Description |
---|---|
IFieldSet | this |
Exceptions
Type | Condition |
---|---|
TagNotFoundException | in case the given tag does not exist in the flat message. |
Set(Int32, StringBuilder)
Declaration
public IFieldSet Set(int tag, StringBuilder value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
StringBuilder | value |
Returns
Type | Description |
---|---|
IFieldSet |
Set(Int32, TimeSpan)
Sets the field value as TimeSpan.
Declaration
public IFieldSet Set(int tag, TimeSpan value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
TimeSpan | value | Field value |
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | if field with the given tag is not defined for this message and unknown fields are disabled |
Set(Int32, TimeSpan, TimeSpanFormat)
Sets the field value as TimeSpan.
Declaration
public IFieldSet Set(int tag, TimeSpan value, TimeSpanFormat format)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
TimeSpan | value | Field value |
TimeSpanFormat | format | Value format |
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | if field with the given tag is not defined for this message and unknown fields are disabled |
SetByIndex(Int32, ByteBuffer)
Sets the value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public FlatMessage SetByIndex(int index, ByteBuffer value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair to be updated |
ByteBuffer | value | field value represented as ByteBuffer |
Returns
Type | Description |
---|---|
FlatMessage | this |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
SetByIndex(Int32, HighResolutionTimeSpan, TimeSpanFormat)
Sets the HighResolutionTimeSpan value at the given field index.
Declaration
public FlatMessage SetByIndex(int index, HighResolutionTimeSpan value, TimeSpanFormat format)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | Index of tag/value pair to be updated |
HighResolutionTimeSpan | value | Field value |
TimeSpanFormat | format | Timestamp format |
Returns
Type | Description |
---|---|
FlatMessage | This instance |
SetByIndex(Int32, HighResolutionTimestamp, TimestampFormat)
Sets the HighResolutionTimestamp value at the given field index.
Declaration
public FlatMessage SetByIndex(int index, HighResolutionTimestamp value, TimestampFormat format)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | Index of tag/value pair to be updated |
HighResolutionTimestamp | value | Field value |
TimestampFormat | format | Timestamp format |
Returns
Type | Description |
---|---|
FlatMessage | This instance |
SetByIndex(Int32, Boolean)
Sets the boolean value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public FlatMessage SetByIndex(int index, bool value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | Index of the tag/value pair to be updated |
Boolean | value | boolean value |
Returns
Type | Description |
---|---|
FlatMessage | this |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
SetByIndex(Int32, Byte[])
Sets the value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public FlatMessage SetByIndex(int index, byte[] value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair to be updated |
Byte[] | value | field value |
Returns
Type | Description |
---|---|
FlatMessage | this |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
SetByIndex(Int32, Byte[], Int32, Int32)
Sets the value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public FlatMessage SetByIndex(int index, byte[] value, int offset, int length)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair to be updated |
Byte[] | value | field value |
Int32 | offset | value offset |
Int32 | length | value length |
Returns
Type | Description |
---|---|
FlatMessage | this |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
SetByIndex(Int32, Char)
Sets the value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public FlatMessage SetByIndex(int index, char value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair to be updated |
Char | value | field value represented as Char |
Returns
Type | Description |
---|---|
FlatMessage | this |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
SetByIndex(Int32, DateTime)
Sets the DateTime value at the given field index.
Declaration
public FlatMessage SetByIndex(int index, DateTime value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | Index of tag/value pair to be updated |
DateTime | value | Field value |
Returns
Type | Description |
---|---|
FlatMessage | This instance |
SetByIndex(Int32, DateTime, TimestampFormat)
Sets the DateTime value at the given field index.
Declaration
public FlatMessage SetByIndex(int index, DateTime value, TimestampFormat format)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | Index of tag/value pair to be updated |
DateTime | value | Field value |
TimestampFormat | format | Timestamp format |
Returns
Type | Description |
---|---|
FlatMessage | This instance |
SetByIndex(Int32, Decimal)
Sets the Double value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public FlatMessage SetByIndex(int index, decimal value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | Index of tag/value pair to be updated |
Decimal | value | field value represented as Decimal |
Returns
Type | Description |
---|---|
FlatMessage | this |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
SetByIndex(Int32, Decimal, Int32)
Sets the value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public FlatMessage SetByIndex(int index, decimal value, int precision)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair to be updated |
Decimal | value | field value represented as Decimal |
Int32 | precision | the number of digits in decimal part |
Returns
Type | Description |
---|---|
FlatMessage | this |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
SetByIndex(Int32, Double)
Sets the Double value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public FlatMessage SetByIndex(int index, double value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | Index of tag/value pair to be updated |
Double | value | Field value |
Returns
Type | Description |
---|---|
FlatMessage | this |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
SetByIndex(Int32, Double, Int32)
Sets the value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public FlatMessage SetByIndex(int index, double value, int precision)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair to be updated |
Double | value | field value represented as Double |
Int32 | precision | the number of digits in decimal part |
Returns
Type | Description |
---|---|
FlatMessage | this |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
SetByIndex(Int32, Int32)
Sets the integer value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public FlatMessage SetByIndex(int index, int value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair to be updated |
Int32 | value | field value represented as Int32 |
Returns
Type | Description |
---|---|
FlatMessage | this |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
SetByIndex(Int32, Int64)
Sets the long value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public FlatMessage SetByIndex(int index, long value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair to be updated |
Int64 | value | field value represented as Int64 |
Returns
Type | Description |
---|---|
FlatMessage | this |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
SetByIndex(Int32, ReadOnlySpan<Byte>)
Sets the value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public FlatMessage SetByIndex(int index, ReadOnlySpan<byte> value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | index of tag/value pair to be updated |
ReadOnlySpan<Byte> | value | field value represented as ReadOnlySpan<T> |
Returns
Type | Description |
---|---|
FlatMessage | this |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
SetByIndex(Int32, String)
Sets the value at the given field index.
Note: Field index can be found using FindIndex(Int32) method.
Declaration
public FlatMessage SetByIndex(int index, string value)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | Index of tag/value pair to be updated |
String | value | Field value represented as String |
Returns
Type | Description |
---|---|
FlatMessage | This instance |
Exceptions
Type | Condition |
---|---|
IndexNotFoundException | if the index is invalid |
SetByIndex(Int32, TimeSpan, TimeSpanFormat)
Sets the TimeSpan value at the given field index.
Declaration
public FlatMessage SetByIndex(int index, TimeSpan value, TimeSpanFormat format)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | Index of tag/value pair to be updated |
TimeSpan | value | Field value |
TimeSpanFormat | format | TimeSpan format |
Returns
Type | Description |
---|---|
FlatMessage | This instance |
SetFlag(Int32, Boolean)
Sets the flag value - 'Y' or 'N'.
Declaration
public IFieldSet SetFlag(int tag, bool value = true)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
Boolean | value |
|
Returns
Type | Description |
---|---|
IFieldSet | This instance |
Exceptions
Type | Condition |
---|---|
TagNotDefinedForThisMessageTypeException | if field with the given tag is not defined for this message and unknown fields are disabled |
ToBytes(Span<Byte>)
Serializes the message to the given byte span.
Declaration
public int ToBytes(Span<byte> buffer)
Parameters
Type | Name | Description |
---|---|---|
Span<Byte> | buffer | Byte span to serialize the message content to |
Returns
Type | Description |
---|---|
Int32 | The number of copied bytes if the given span is large enough; otherwise - a negative number, the absolute value of which is equal to the required size of the span |
ToRawFixString()
Declaration
public string ToRawFixString()
Returns
Type | Description |
---|---|
String |
ToString()
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
String |
Overrides
ToString(Char, FixStringFormat)
Declaration
public string ToString(char delimiter, FixStringFormat format = FixStringFormat.TagNumber)
Parameters
Type | Name | Description |
---|---|---|
Char | delimiter | |
FixStringFormat | format |
Returns
Type | Description |
---|---|
String |
ToString(StringBuilder, Char, FixStringFormat)
Fills StringBuilder with the string representation of the object.
Declaration
public void ToString(StringBuilder builder, char delimiter = '\u0001', FixStringFormat format = FixStringFormat.TagNumber)
Parameters
Type | Name | Description |
---|---|---|
StringBuilder | builder | string builder to be filled |
Char | delimiter | |
FixStringFormat | format |
TryGet(Int32, out String)
Returns the field value as String. A return value indicates whether the operation succeeded.
Declaration
public bool TryGet(int tag, out string result)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
String | result | Field value |
Returns
Type | Description |
---|---|
Boolean |
|
TryGet(Int32, StringBuilder)
Declaration
public bool TryGet(int tag, StringBuilder result)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
StringBuilder | result |
Returns
Type | Description |
---|---|
Boolean |
TryGetBytes(Int32, out Byte[])
Returns field value as Byte[] .
Declaration
public bool TryGetBytes(int tag, out byte[] result)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
Byte[] | result | field value |
Returns
Type | Description |
---|---|
Boolean | whether value available |
TryGetChar(Int32, out Char)
Declaration
public bool TryGetChar(int tag, out char result)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
Char | result |
Returns
Type | Description |
---|---|
Boolean |
TryGetDecimal(Int32, out Decimal)
Declaration
public bool TryGetDecimal(int tag, out decimal result)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
Decimal | result |
Returns
Type | Description |
---|---|
Boolean |
TryGetDouble(Int32, out Double)
Declaration
public bool TryGetDouble(int tag, out double result)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
Double | result |
Returns
Type | Description |
---|---|
Boolean |
TryGetFlag(Int32, out Boolean)
Declaration
public virtual bool TryGetFlag(int tag, out bool result)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
Boolean | result |
Returns
Type | Description |
---|---|
Boolean |
TryGetHighResolutionTimeSpan(Int32, out HighResolutionTimeSpan)
Returns the field value as HighResolutionTimeSpan .
Declaration
public bool TryGetHighResolutionTimeSpan(int tag, out HighResolutionTimeSpan result)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
HighResolutionTimeSpan | result | Field value |
Returns
Type | Description |
---|---|
Boolean |
|
TryGetHighResolutionTimeSpan(Int32, out HighResolutionTimeSpan, out TimeSpanFormat)
Returns the field value as HighResolutionTimeSpan and it's source format.
Declaration
public bool TryGetHighResolutionTimeSpan(int tag, out HighResolutionTimeSpan result, out TimeSpanFormat format)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
HighResolutionTimeSpan | result | Field value |
TimeSpanFormat | format | Value format |
Returns
Type | Description |
---|---|
Boolean |
|
TryGetHighResolutionTimestamp(Int32, out HighResolutionTimestamp)
Returns the field value as HighResolutionTimestamp .
Declaration
public bool TryGetHighResolutionTimestamp(int tag, out HighResolutionTimestamp result)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
HighResolutionTimestamp | result | Field value |
Returns
Type | Description |
---|---|
Boolean |
|
TryGetHighResolutionTimestamp(Int32, out HighResolutionTimestamp, out TimestampFormat)
Returns the field value as HighResolutionTimestamp and it's source format.
Declaration
public bool TryGetHighResolutionTimestamp(int tag, out HighResolutionTimestamp result, out TimestampFormat format)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
HighResolutionTimestamp | result | Field value |
TimestampFormat | format | Value format |
Returns
Type | Description |
---|---|
Boolean |
|
TryGetInteger(Int32, out Int32)
Declaration
public bool TryGetInteger(int tag, out int result)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
Int32 | result |
Returns
Type | Description |
---|---|
Boolean |
TryGetLong(Int32, out Int64)
Declaration
public bool TryGetLong(int tag, out long result)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
Int64 | result |
Returns
Type | Description |
---|---|
Boolean |
TryGetSpan(Int32, out ReadOnlySpan<Byte>)
Fills the given ReadOnlySpan<T> with reference to value by the given tag.
Declaration
public bool TryGetSpan(int tag, out ReadOnlySpan<byte> result)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | field tag |
ReadOnlySpan<Byte> | result | field value reference to be filled |
Returns
Type | Description |
---|---|
Boolean | true in case the field is found, false otherwise. |
TryGetTimeSpan(Int32, out TimeSpan)
Returns the field value as TimeSpan .
Declaration
public bool TryGetTimeSpan(int tag, out TimeSpan result)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
TimeSpan | result | Field value |
Returns
Type | Description |
---|---|
Boolean |
|
TryGetTimeSpan(Int32, out TimeSpan, out TimeSpanFormat)
Returns the field value as TimeSpan and it's source format.
Declaration
public bool TryGetTimeSpan(int tag, out TimeSpan result, out TimeSpanFormat format)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
TimeSpan | result | Field value |
TimeSpanFormat | format | Value format |
Returns
Type | Description |
---|---|
Boolean |
|
TryGetTimestamp(Int32, out DateTime)
Returns the field value as DateTime .
Declaration
public bool TryGetTimestamp(int tag, out DateTime result)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
DateTime | result | Field value |
Returns
Type | Description |
---|---|
Boolean |
|
TryGetTimestamp(Int32, out DateTime, out TimestampFormat)
Returns the field value as DateTime and it's source format.
Declaration
public bool TryGetTimestamp(int tag, out DateTime result, out TimestampFormat format)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | Tag number |
DateTime | result | Field value |
TimestampFormat | format | Value format |
Returns
Type | Description |
---|---|
Boolean |
|
Explicit Interface Implementations
IFieldSet.Contains(Int32, Boolean)
Declaration
bool IFieldSet.Contains(int tag, bool nested)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
Boolean | nested |
Returns
Type | Description |
---|---|
Boolean |
IFieldSet.GetGroup(Int32)
Declaration
Group IFieldSet.GetGroup(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag |
Returns
Type | Description |
---|---|
Group |
IFieldSet.GetGroupsEnumerator()
Declaration
IEnumerator<Group> IFieldSet.GetGroupsEnumerator()
Returns
Type | Description |
---|---|
IEnumerator<Group> |
IFieldSet.HasGroup(Int32)
Declaration
bool IFieldSet.HasGroup(int tag)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag |
Returns
Type | Description |
---|---|
Boolean |
IFieldSet.NumberOfGroups
Declaration
int IFieldSet.NumberOfGroups { get; }
Returns
Type | Description |
---|---|
Int32 |
IFieldSet.SetGroup(Int32, Int32)
Declaration
Group IFieldSet.SetGroup(int tag, int numberOfInstances)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
Int32 | numberOfInstances |
Returns
Type | Description |
---|---|
Group |
IFieldSet.TryGetGroup(Int32, out Group)
Declaration
bool IFieldSet.TryGetGroup(int tag, out Group result)
Parameters
Type | Name | Description |
---|---|---|
Int32 | tag | |
Group | result |
Returns
Type | Description |
---|---|
Boolean |
IMessage.Clone()
Declaration
IMessage IMessage.Clone()
Returns
Type | Description |
---|---|
IMessage |
IMessage.IsFlatMessage
Declaration
bool IMessage.IsFlatMessage { get; }
Returns
Type | Description |
---|---|
Boolean |
IEnumerable<Field>.GetEnumerator()
Declaration
IEnumerator<Field> IEnumerable<Field>.GetEnumerator()
Returns
Type | Description |
---|---|
IEnumerator<Field> |
IEnumerable.GetEnumerator()
Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type | Description |
---|---|
IEnumerator |