Class FlatGroupReader

Repeating Group Reader for a Flat Message.

Inheritance
Object
FlatGroupReader
Inherited Members
Namespace: OnixS.Fix
Assembly: OnixS.Fix.Engine.dll
Syntax
public sealed class FlatGroupReader : IEnumerable<FlatGroupReader>, IEnumerable, IEnumerator<FlatGroupReader>, IEnumerator, IDisposable

Constructors

FlatGroupReader(FieldInfo)

Сonstructor.

Declaration
public FlatGroupReader(FieldInfo fieldInfo)
Parameters
Type Name Description
FieldInfo fieldInfo

Group field info

FlatGroupReader(Int32)

Сonstructor.

Declaration
public FlatGroupReader(int numberOfEntriesTag)
Parameters
Type Name Description
Int32 numberOfEntriesTag

Number of Entries tag

Properties

Current

Gets the element in the collection at the current position of the enumerator.

Declaration
public FlatGroupReader Current { get; }
Property Value
Type Description
FlatGroupReader

Methods

Contains(Int32)

Returns whether the field with the given tag is set.

Declaration
public bool Contains(int tag)
Parameters
Type Name Description
Int32 tag

tag of the field to search
Returns
Type Description
Boolean

true if the field is set, false if the field is not set or is not defined for this message

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()

Get(Int32)

Returns the field value as string.

Declaration
public string Get(int tag)
Parameters
Type Name Description
Int32 tag

Tag number
Returns
Type Description
String

Field value as string, null if it is not set

Get(Int32, out Field)

Fills the given Field with reference to value by the given tag.

Declaration
public bool Get(int tag, out Field field)
Parameters
Type Name Description
Int32 tag

field tag
Field field

field to be filled
Returns
Type Description
Boolean

true if the field is found, otherwise - false

GetBytes(Int32)

Returns the field value as Byte[].

Declaration
public byte[] GetBytes(int tag)
Parameters
Type Name Description
Int32 tag

Tag number
Returns
Type Description
Byte[]

Field value as Byte[]
Exceptions
Type Condition
TagNotFoundException

If the field is absent

GetChar(Int32)

Returns the field value as a character.

Declaration
public int GetChar(int tag)
Parameters
Type Name Description
Int32 tag

Tag number
Returns
Type Description
Int32

Field value as a character
Exceptions
Type Condition
TagNotFoundException

If the field is absent
IncorrectFieldValueException

if the field value cannot be converted to a character

GetDecimal(Int32)

Returns the field value as Decimal.

Declaration
public decimal GetDecimal(int tag)
Parameters
Type Name Description
Int32 tag

Tag number
Returns
Type Description
Decimal

Field value as Decimal
Exceptions
Type Condition
TagNotFoundException

If the field is absent
IncorrectFieldValueException

if the value cannot be converted to Decimal

GetDouble(Int32)

Returns the field value as double.

Note: According to the FIX Protocol float format the value should not contain the exponent ('e' or 'E') symbol.

Note: The double type should not be used for precise values.

Declaration
public double GetDouble(int tag)
Parameters
Type Name Description
Int32 tag

Tag number
Returns
Type Description
Double

Field value as double
Exceptions
Type Condition
TagNotFoundException

If the field is absent
IncorrectFieldValueException

if the field value cannot be converted to double

GetFlag(Int32)

Returns the flag value.

Declaration
public bool GetFlag(int tag)
Parameters
Type Name Description
Int32 tag

Tag number
Returns
Type Description
Boolean

true if the field value is 'Y', false if the field value is 'N' or the field is absent

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 HH:MM:SS (whole seconds) or HH:MM:SS.sss (milliseconds) or HH:MM:SS.sssssss (microseconds) or HH:MM:SS.ssssssssss (nanoseconds) or HH:MM:SS.sssssssssssss (picoseconds) format

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 HH:MM:SS (whole seconds) or HH:MM:SS.sss (milliseconds) or HH:MM:SS.sssssss (microseconds) or HH:MM:SS.ssssssssss (nanoseconds) or HH:MM:SS.sssssssssssss (picoseconds) format

GetHighResolutionTimestamp(Int32)

Returns the field value as HighResolutionTimestamp.

Declaration
public HighResolutionTimestamp GetHighResolutionTimestamp(int tag)
Parameters
Type Name Description
Int32 tag

Tag number
Returns
Type Description
HighResolutionTimestamp

Field value as HighResolutionTimestamp
Exceptions
Type Condition
TagNotFoundException

If the field is absent
IncorrectFieldValueException

if the field value cannot be parsed to HighResolutionTimestamp using either YYYYMMDD-HH:MM:SS (whole seconds) or YYYYMMDD-HH:MM:SS.sss (milliseconds) or YYYYMMDD-HH:MM:SS.sssssss (microseconds) or YYYYMMDD-HH:MM:SS.ssssssssss (nanoseconds) or YYYYMMDD-HH:MM:SS.sssssssssssss (picoseconds) format

GetHighResolutionTimestamp(Int32, out TimestampFormat)

Returns the field value as HighResolutionTimestamp and it's source format.

Declaration
public HighResolutionTimestamp GetHighResolutionTimestamp(int tag, out TimestampFormat format)
Parameters
Type Name Description
Int32 tag

Tag number
TimestampFormat format

Value format
Returns
Type Description
HighResolutionTimestamp

Field value as HighResolutionTimestamp
Exceptions
Type Condition
TagNotFoundException

If the field is absent
IncorrectFieldValueException

if the field value cannot be parsed to HighResolutionTimestamp using either YYYYMMDD-HH:MM:SS (whole seconds) or YYYYMMDD-HH:MM:SS.sss (milliseconds) or YYYYMMDD-HH:MM:SS.sssssss (microseconds) or YYYYMMDD-HH:MM:SS.ssssssssss (nanoseconds) or YYYYMMDD-HH:MM:SS.sssssssssssss (picoseconds) format

GetInteger(Int32)

Returns the field value as int.

Declaration
public int GetInteger(int tag)
Parameters
Type Name Description
Int32 tag

Tag number
Returns
Type Description
Int32

Field value as int
Exceptions
Type Condition
TagNotFoundException

If the field is absent
IncorrectFieldValueException

if the field value cannot be converted to int

GetLong(Int32)

Returns the field value as long.

Declaration
public long GetLong(int tag)
Parameters
Type Name Description
Int32 tag

Tag number
Returns
Type Description
Int64

Field value as long
Exceptions
Type Condition
TagNotFoundException

If the field is absent
IncorrectFieldValueException

if the field value cannot be converted to long

GetSpan(Int32)

Returns the field value as ReadOnlySpan<T>.

Declaration
public ReadOnlySpan<byte> GetSpan(int tag)
Parameters
Type Name Description
Int32 tag

Tag number
Returns
Type Description
ReadOnlySpan<Byte>

Field value as ReadOnlySpan<T>
Exceptions
Type Condition
TagNotFoundException

If the field is absent

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 HH:MM:SS (whole seconds) or HH:MM:SS.sss (milliseconds) or HH:MM:SS.sssssss (microseconds) or HH:MM:SS.ssssssssss (nanoseconds) or HH:MM:SS.sssssssssssss (picoseconds) format

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 HH:MM:SS (whole seconds) or HH:MM:SS.sss (milliseconds) or HH:MM:SS.sssssss (microseconds) or HH:MM:SS.ssssssssss (nanoseconds) or HH:MM:SS.sssssssssssss (picoseconds) format

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 YYYYMMDD-HH:MM:SS (whole seconds) or YYYYMMDD-HH:MM:SS.sss (milliseconds) or YYYYMMDD-HH:MM:SS.sssssss (microseconds) or YYYYMMDD-HH:MM:SS.ssssssssss (nanoseconds) or YYYYMMDD-HH:MM:SS.sssssssssssss (picoseconds) format

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 YYYYMMDD-HH:MM:SS (whole seconds) or YYYYMMDD-HH:MM:SS.sss (milliseconds) or YYYYMMDD-HH:MM:SS.sssssss (microseconds) or YYYYMMDD-HH:MM:SS.ssssssssss (nanoseconds) or YYYYMMDD-HH:MM:SS.sssssssssssss (picoseconds) format

MoveNext()

Advances the enumerator to the next element of the collection.

Declaration
public bool MoveNext()
Returns
Type Description
Boolean

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Reset()

Sets the enumerator to its initial position, which is before the first element in the collection.

Declaration
public void Reset()

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

true if the field value was converted, otherwise - false

TryGetBytes(Int32, out Byte[])

Returns the field value as Byte[]. A return value indicates whether the operation succeeded.

Declaration
public bool TryGetBytes(int tag, out byte[] result)
Parameters
Type Name Description
Int32 tag

Tag number
Byte[] result

Field value
Returns
Type Description
Boolean

true if the field value was converted, otherwise - false

TryGetChar(Int32, out Char)

Returns the field value as a character. A return value indicates whether the operation succeeded.

Declaration
public bool TryGetChar(int tag, out char result)
Parameters
Type Name Description
Int32 tag

Tag number
Char result

Field value as a character
Returns
Type Description
Boolean

true if the field value was converted, otherwise - false

TryGetDecimal(Int32, out Decimal)

Returns the field value as Decimal. A return value indicates whether the operation succeeded.

Declaration
public bool TryGetDecimal(int tag, out decimal result)
Parameters
Type Name Description
Int32 tag

Tag number
Decimal result

Contains the decimal number equivalent to the field value, if the conversion succeeded, or zero if the conversion failed.
Returns
Type Description
Boolean

true if the field value was converted, otherwise - false

TryGetDouble(Int32, out Double)

Converts the field value to its double equivalent. A return value indicates whether the operation succeeded.

Note: According to the FIX Protocol float format the value should not contain the exponent ('e' or 'E') symbol.

Note: The double type should not be used for precise values.

Declaration
public bool TryGetDouble(int tag, out double result)
Parameters
Type Name Description
Int32 tag

Tag number
Double result

Contains the double number equivalent to the field value, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the field value is absent, is not of the correct format, or represents a number less than MinValue or greater than MaxValue. This parameter is passed uninitialized.
Returns
Type Description
Boolean

true if the field value was converted, otherwise - false

TryGetFlag(Int32, out Boolean)

Returns the field value as Boolean . A return value indicates whether the operation succeeded.

Declaration
public bool TryGetFlag(int tag, out bool result)
Parameters
Type Name Description
Int32 tag

Tag number
Boolean result

Contains true if the field value is 'Y', false if the field value is 'N' or the field is absent
Returns
Type Description
Boolean

true if the field value was converted, otherwise - false

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

true if the field value was converted, otherwise - false

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

true if the field value was converted, otherwise - false

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

true if the field value was converted, otherwise - false

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

true if the field value was converted, otherwise - false

TryGetInteger(Int32, out Int32)

Converts the field value to its 32-bit signed integer equivalent. A return value indicates whether the operation succeeded.

Declaration
public bool TryGetInteger(int tag, out int result)
Parameters
Type Name Description
Int32 tag

Tag number
Int32 result

The 32-bit signed integer number equivalent to the field value, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the field value is absent, is not of the correct format, or represents a number less than MinValue or greater than MaxValue. This parameter is passed uninitialized.
Returns
Type Description
Boolean

true if the field value was converted, otherwise - false

TryGetLong(Int32, out Int64)

Converts the field value to its 64-bit signed integer equivalent. A return value indicates whether the operation succeeded.

Declaration
public bool TryGetLong(int tag, out long result)
Parameters
Type Name Description
Int32 tag

Tag number
Int64 result

The 64-bit signed integer number equivalent to the field value, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the field value is absent, is not of the correct format, or represents a number less than MinValue or greater than MaxValue. This parameter is passed uninitialized.
Returns
Type Description
Boolean

true if the field value was converted, otherwise - false

TryGetSpan(Int32, out ReadOnlySpan<Byte>)

Returns the field value as ReadOnlySpan<T>. A return value indicates whether the operation succeeded.

Declaration
public bool TryGetSpan(int tag, out ReadOnlySpan<byte> result)
Parameters
Type Name Description
Int32 tag

Tag number
ReadOnlySpan<Byte> result

Field value
Returns
Type Description
Boolean

true if the field value was converted, otherwise - false

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

true if the field value was converted, otherwise - false

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

true if the field value was converted, otherwise - false

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

true if the field value was converted, otherwise - false

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

true if the field value was converted, otherwise - false

Unwrap()

Detaches the reader.

Declaration
public void Unwrap()

Wrap(FlatGroupReader)

Attaches as a nested repeating group reader.

Declaration
public bool Wrap(FlatGroupReader parentReader)
Parameters
Type Name Description
FlatGroupReader parentReader

parent repeating group reder
Returns
Type Description
Boolean

true if the parentReader current entry contains the nested repeating group, false otherwise

Wrap(FlatMessage)

Attaches as a top-level repeating group reader.

Declaration
public bool Wrap(FlatMessage message)
Parameters
Type Name Description
FlatMessage message
Returns
Type Description
Boolean

true if the message contains the group, false otherwise

Explicit Interface Implementations

IEnumerable<FlatGroupReader>.GetEnumerator()

Returns an enumerator that iterates through a collection.

Declaration
IEnumerator<FlatGroupReader> IEnumerable<FlatGroupReader>.GetEnumerator()
Returns
Type Description
IEnumerator<FlatGroupReader>

An enumerator that can be used to iterate through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
IEnumerator

An IEnumerator object that can be used to iterate through the collection.

IEnumerator.Current

Gets the element in the collection at the current position of the enumerator.

Declaration
object IEnumerator.Current { get; }
Returns
Type Description
Object

Implements