Class FieldSet

Collection of Fields.

Inheritance

Object

FieldSet

GroupInstance

Message

Implements

IFieldSet

IEnumerable<Field>

IEnumerable

IDisposable

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Namespace: OnixS.Fix

Assembly: OnixS.Fix.Engine.dll

Syntax

public abstract class FieldSet : IFieldSet, IEnumerable<Field>, IEnumerable, IDisposable

Constructors

FieldSet()

Declaration

protected FieldSet()

FieldSet(Message, FieldContainerInfo)

Declaration

protected FieldSet(Message parentMessage, FieldContainerInfo desc)

Parameters

Type	Name	Description
Message	parentMessage
FieldContainerInfo	desc

FieldSet(Int32, Int32, MessageMemoryPool)

Declaration

protected FieldSet(int numberOfFields, int numberOfGroups, MessageMemoryPool memoryPool = null)

Parameters

Type	Name	Description
Int32	numberOfFields
Int32	numberOfGroups
MessageMemoryPool	memoryPool

Properties

FieldCount

Returns the number of tag/value pairs excluding nested repeating groups.

Declaration

public int FieldCount { get; }

Property Value

Type	Description
Int32	The number of tag/value pairs excluding nested repeating groups

IsDisposed

Declaration

public bool IsDisposed { get; }

Property Value

Type	Description
Boolean

Item[Int32]

Returns the field value as String.

Declaration

public string this[int tag] { get; set; }

Parameters

Type	Name	Description
Int32	tag	Tag number

Property Value

Type	Description
String	Field value as String, null if it is not set

NumberOfFields

Declaration

public int NumberOfFields { get; }

Property Value

Type	Description
Int32

NumberOfGroups

Returns the number of repeating groups defined on the current level excluding nested repeating groups.

Declaration

public int NumberOfGroups { get; set; }

Property Value

Type	Description
Int32	Number of repeating groups defined on the current level excluding nested repeating groups

Methods

AddField()

Declaration

protected int AddField()

Returns

Type	Description
Int32

Assemble(ByteBuffer)

Declaration

public virtual void Assemble(ByteBuffer bb)

Parameters

Type	Name	Description
ByteBuffer	bb

CompareFieldValue(Int32, String)

Declaration

public bool CompareFieldValue(int tag, string value)

Parameters

Type	Name	Description
Int32	tag
String	value

Returns

Type	Description
Boolean

Contains(Int32)

Checks the field presence.

Note: the checking excludes nested repeating groups

Declaration

public bool Contains(int tag)

Parameters

Type	Name	Description
Int32	tag	Tag number

Returns

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

Contains(Int32, Boolean)

Checks the field presence.

Declaration

public virtual bool Contains(int tag, bool nested)

Parameters

Type	Name	Description
Int32	tag	Tag number
Boolean	nested	true for checking nested repeating groups recursively, otherwise - false

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()

Declaration

public void Dispose()

EnsureNotDisposed()

Declaration

protected void EnsureNotDisposed()

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, StringBuilder)

Declaration

public void Get(int tag, StringBuilder result)

Parameters

Type	Name	Description
Int32	tag
StringBuilder	result

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 char GetChar(int tag)

Parameters

Type	Name	Description
Int32	tag	Tag number

Returns

Type	Description
Char	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

GetEnumerator()

Declaration

public FieldSet.FieldEnumerator GetEnumerator()

Returns

Type	Description
FieldSet.FieldEnumerator

GetFields()

Returns message fields.

Declaration

public Field[] GetFields()

Returns

Type	Description
Field[]	Message fields

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

GetGroup(Int32)

Returns the repeating group.

Declaration

public Group GetGroup(int tag)

Parameters

Type	Name	Description
Int32	tag	Tag number of the field that defines the number of instances in this repeating group (the NoXXX field)

Returns

Type	Description
Group	Nested repeating group

Exceptions

Type	Condition
ParserException	the tag number does not identify a repeating group

GetGroupByPsn(Int32)

Declaration

protected Group GetGroupByPsn(int psn)

Parameters

Type	Name	Description
Int32	psn

Returns

Type	Description
Group

GetGroupsEnumerator()

Returns an iterator over groups of the current level excludes nested repeating groups.

Declaration

public IEnumerator<Group> GetGroupsEnumerator()

Returns

Type	Description
IEnumerator<Group>	Iterator over groups of the current level excludes nested repeating groups

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

GetMessage()

Declaration

protected abstract Message GetMessage()

Returns

Type	Description
Message

GetPosition(Int32)

Declaration

protected virtual int GetPosition(int tag)

Parameters

Type	Name	Description
Int32	tag

Returns

Type	Description
Int32

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

HasGroup(Int32)

Checks the pretense of the repeating group.

Note: the checking excludes nested repeating groups.

Declaration

public bool HasGroup(int tag)

Parameters

Type	Name	Description
Int32	tag	Tag number of the field that defines the number of instances in this repeating group (the NoXXX field)

Returns

Type	Description
Boolean	true if the group is set, false if the group is not set or is not defined for this message

Init(Message, FieldContainerInfo)

Declaration

protected void Init(Message parentMessage, FieldContainerInfo desc)

Parameters

Type	Name	Description
Message	parentMessage
FieldContainerInfo	desc

Init(Message, FieldSet)

Declaration

protected void Init(Message parentMessage, FieldSet fixBlock)

Parameters

Type	Name	Description
Message	parentMessage
FieldSet	fixBlock

InitGroup(FieldInfo)

Declaration

protected Group InitGroup(FieldInfo fieldDefinition)

Parameters

Type	Name	Description
FieldInfo	fieldDefinition

Returns

Type	Description
Group

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	true if the field is either absent or empty, otherwise - false

Remove(Int32)

Removes the field.

Declaration

public virtual bool Remove(int tag)

Parameters

Type	Name	Description
Int32	tag	Tag number

Returns

Type	Description
Boolean	true If the field was found and removed, otherwise false

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	true for 'Y', false for 'N'

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 Byte[] value.

Declaration

public IFieldSet Set(int tag, byte[] value)

Parameters

Type	Name	Description
Int32	tag	Tag number
Byte[]	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, Byte[], Int32, Int32)

Sets the Byte[] value.

Declaration

public virtual IFieldSet Set(int tag, byte[] value, int offset, int length)

Parameters

Type	Name	Description
Int32	tag	Tag number
Byte[]	value	Field value
Int32	offset	Value offset
Int32	length	Value length

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
ArgumentException	(offset < 0) or (offset + length > value.length) or (length < 0)

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)

Declaration

public IFieldSet Set(int tag, decimal value, int precision)

Parameters

Type	Name	Description
Int32	tag
Decimal	value
Int32	precision

Returns

Type	Description
IFieldSet

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>)

Sets the ReadOnlySpan<T> value.

Declaration

public virtual IFieldSet Set(int tag, ReadOnlySpan<byte> value)

Parameters

Type	Name	Description
Int32	tag	Tag number
ReadOnlySpan<Byte>	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, String)

Sets the String value.

Declaration

public virtual IFieldSet Set(int tag, string value)

Parameters

Type	Name	Description
Int32	tag	Tag number
String	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, StringBuilder)

Declaration

public virtual 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

SetFlag(Int32, Boolean)

Sets the flag value - 'Y' or 'N'.

Declaration

public IFieldSet SetFlag(int tag, bool value)

Parameters

Type	Name	Description
Int32	tag	Tag number
Boolean	value	true for 'Y', false for 'N'

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

SetGroup(Int32, Int32)

Creates a new repeating group or changes the number of repeated instances in the existing repeating group.

Declaration

public Group SetGroup(int tag, int numberOfInstances)

Parameters

Type	Name	Description
Int32	tag	Tag number of the field that defines the number of repeated instances in this repeating group
Int32	numberOfInstances	Number of repeated instances in this repeating group

Returns

Type	Description
Group	Repeating group

Exceptions

Type	Condition
TagNotDefinedForThisMessageTypeException	if field with the given tag is not defined for this message

ToRawFixString()

Declaration

public string ToRawFixString()

Returns

Type	Description
String

ToString()

Returns a string that represents the current Message object.

Declaration

public override string ToString()

Returns

Type	Description
String	A string that represents the current Message object

Overrides

Object.ToString()

ToString(FixStringFormat)

Returns a string that represents the current Message object in accordance with the specified FixStringFormat.

Declaration

public string ToString(FixStringFormat format)

Parameters

Type	Name	Description
FixStringFormat	format

Returns

Type	Description
String	A string that represents the current Message object in accordance with the specified FixStringFormat

ToString(Char, FixStringFormat)

Returns a string that represents the current Message object in accordance with the specified delimiter and FixStringFormat.

Declaration

public string ToString(char delimiter, FixStringFormat format = FixStringFormat.TagNumber)

Parameters

Type	Name	Description
Char	delimiter
FixStringFormat	format

Returns

Type	Description
String	A string that represents the current Message object in accordance with the specified delimiter and FixStringFormat

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

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 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

TryGetGroup(Int32, out Group)

Returns the repeating group. A return value indicates whether the operation succeeded.

Declaration

public bool TryGetGroup(int tag, out Group result)

Parameters

Type	Name	Description
Int32	tag	Tag number of the field that defines the number of instances in this repeating group (the NoXXX field)
Group	result	Contains the repeating group instance, if the conversion succeeded. The conversion fails if the field value is absent or is not of the correct format. This parameter is passed uninitialized.

Returns

Type	Description
Boolean	true if the repeating group was found, 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

Exceptions

Type	Condition
IncorrectFieldValueException	if the value cannot be parsed to an Integer

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

Explicit Interface Implementations

IEnumerable<Field>.GetEnumerator()

Declaration

IEnumerator<Field> IEnumerable<Field>.GetEnumerator()

Returns

Type	Description
IEnumerator<Field>

IEnumerable.GetEnumerator()

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
IEnumerator

Implements

IFieldSet

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable

System.IDisposable