Class RepeatingGroup

Class for work with repeating group data. All repeating group data are stored at IndexedStorage, instances of this class is only view for repeating group data.

Inheritance

System.Object

RepeatingGroup

Implements

System.Collections.Generic.IEnumerable<RepeatingGroup.Entry>

System.Collections.IEnumerable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: FixAntenna.Fix.Message.Rg

Assembly: FixAntenna.Message.dll

Syntax

public sealed class RepeatingGroup : IEnumerable<RepeatingGroup.Entry>, IEnumerable

Methods

AddEntry()

Adds entry to the end of group

Declaration

public RepeatingGroup.Entry AddEntry()

Returns

Type	Description
RepeatingGroup.Entry	instance of Entry from RepeatingGroupPool. There is no need to call release for this object.

AddEntry(Int32)

Adds entry to the specific index at group.

Declaration

public RepeatingGroup.Entry AddEntry(int index)

Parameters

Type	Name	Description
System.Int32	index	number of entry in group. In other words, if adds first entry, then index equals to 0, if adds second entry, then index equals to 1 and so on.

Returns

Type	Description
RepeatingGroup.Entry	instance of Entry from RepeatingGroupPool. There is no need to call release for this object.

AddEntry(Int32, RepeatingGroup.Entry)

Adds passed entry to the specific index at group.

Declaration

public void AddEntry(int index, RepeatingGroup.Entry entry)

Parameters

Type	Name	Description
System.Int32	index	number of entry in group. In other words, if adds first entry, then index equals to 0, if adds second entry, then index equals to 1 and so on.
RepeatingGroup.Entry	entry	entry for add

CopyEntry(RepeatingGroup.Entry)

Copy entry to end of repeating group

Declaration

public RepeatingGroup.Entry CopyEntry(RepeatingGroup.Entry src)

Parameters

Type	Name	Description
RepeatingGroup.Entry	src	entry for copy

Returns

Type	Description
RepeatingGroup.Entry	copied entry

CopyEntry(RepeatingGroup.Entry, RepeatingGroup.Entry)

Copy entry to end of repeating group

Declaration

public void CopyEntry(RepeatingGroup.Entry src, RepeatingGroup.Entry dst)

Parameters

Type	Name	Description
RepeatingGroup.Entry	src	entry for copy
RepeatingGroup.Entry	dst	entry for hold copied entry

CopyEntry(RepeatingGroup.Entry, RepeatingGroup.Entry, Int32)

Copy entry at specified index of repeating group

Declaration

public void CopyEntry(RepeatingGroup.Entry src, RepeatingGroup.Entry dst, int index)

Parameters

Type	Name	Description
RepeatingGroup.Entry	src	entry for copy
RepeatingGroup.Entry	dst	entry for hold copied entry
System.Int32	index	index at which the source entry is to be copied

CopyEntry(RepeatingGroup.Entry, Int32)

Copy entry at specified index of repeating group

Declaration

public RepeatingGroup.Entry CopyEntry(RepeatingGroup.Entry src, int index)

Parameters

Type	Name	Description
RepeatingGroup.Entry	src	entry for copy
System.Int32	index	index at which the source entry is to be copied

Returns

Type	Description
RepeatingGroup.Entry	copied entry

GetEntry(Int32)

Returns entry from specific instance.

Declaration

public RepeatingGroup.Entry GetEntry(int index)

Parameters

Type	Name	Description
System.Int32	index	number of entry in group. In other words, if adds first entry, then index equals to 0, if adds second entry, then index equals to 1 and so on.

Returns

Type	Description
RepeatingGroup.Entry	instance of Entry from RepeatingGroupPool, filled by entry data. There is no need to call release for this object.

GetEntry(Int32, RepeatingGroup.Entry)

Fills passed entry instance by entry data.

Declaration

public void GetEntry(int index, RepeatingGroup.Entry entry)

Parameters

Type	Name	Description
System.Int32	index	number of entry in group. In other words, if adds first entry, then index equals to 0, if adds second entry, then index equals to 1 and so on.
RepeatingGroup.Entry	entry	entry for fill.

GetEnumerator()

Returns iterator by entries of repeating group

Declaration

public IEnumerator<RepeatingGroup.Entry> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<RepeatingGroup.Entry>	iterator

GetLeadingTag()

Returns group's leading tag

Declaration

public int GetLeadingTag()

Returns

Type	Description
System.Int32	leading tag of group

GetLeadingTagValue()

Returns value of group's leading tag.

Declaration

public int GetLeadingTagValue()

Returns

Type	Description
System.Int32	value of group's leading tag

GetSize()

Returns number of entries in group.

Declaration

public int GetSize()

Returns

Type	Description
System.Int32	number of entries in group

isValidationTurnOn()

Returns true if validation turn of for this group

Declaration

public bool isValidationTurnOn()

Returns

Type	Description
System.Boolean	validation

Release()

Returns group to pool if group was got by GetRepeatingGroup(). If group was got by calling RepeatingGroup AddRepeatingGroup() method or RepeatingGroup GetRepeatingGroup(), then it does nothing.

Declaration

public void Release()

Remove()

Removes current group

Declaration

public void Remove()

RemoveEntry(RepeatingGroup.Entry)

Removes passed entry from group

Declaration

public void RemoveEntry(RepeatingGroup.Entry entry)

Parameters

Type	Name	Description
RepeatingGroup.Entry	entry	entry for remove

RemoveEntry(Int32)

Removes passed entry from the specific index.

Declaration

public void RemoveEntry(int index)

Parameters

Type	Name	Description
System.Int32	index	number of entry in group. In other words, if adds first entry, then index equals to 0, if adds second entry, then index equals to 1 and so on.

RemoveEntryAndClean(RepeatingGroup.Entry)

Removes passed entry from group and clean message - remove group instance if it is empty

Declaration

public void RemoveEntryAndClean(RepeatingGroup.Entry entry)

Parameters

Type	Name	Description
RepeatingGroup.Entry	entry	entry for remove

RemoveEntryAndClean(Int32)

Removes passed entry from the specific index.

Declaration

public void RemoveEntryAndClean(int index)

Parameters

Type	Name	Description
System.Int32	index	number of entry in group. In other words, if adds first entry, then index equals to 0, if adds second entry, then index equals to 1 and so on.

SetValidation(Boolean)

Turn on/off validation

Declaration

public void SetValidation(bool validation)

Parameters

Type	Name	Description
System.Boolean	validation	validation

ToByteArray()

Declaration

public byte[] ToByteArray()

Returns

Type	Description
System.Byte[]

ToPrintableString()

Declaration

public string ToPrintableString()

Returns

Type	Description
System.String

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Returns iterator by entries of repeating group

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator	iterator

Implements

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable