Class MessageInfoDictionaryManager

FIX Protocol Specification collection.

Inheritance
object
MessageInfoDictionaryManager
Implements
Inherited Members
Namespace: OnixS.Fix.Dictionaries
Assembly: OnixS.Fix.Engine.dll
Syntax
public class MessageInfoDictionaryManager : ICollection<IMessageInfoDictionary>, IReadOnlyCollection<IMessageInfoDictionary>, IEnumerable<IMessageInfoDictionary>, IEnumerable

Constructors

MessageInfoDictionaryManager(params MessageInfoDictionary[])

Constructor.

Declaration
public MessageInfoDictionaryManager(params MessageInfoDictionary[] dialects)
Parameters
Type Name Description
MessageInfoDictionary[] dialects

List of dictionaries.

Properties

Count

Gets the number of elements contained in the ICollection<T>.

Declaration
public int Count { get; }
Property Value
Type Description
int

Dictionaries

Returns all dictionaries.

Declaration
public IReadOnlyDictionary<string, IMessageInfoDictionary> Dictionaries { get; }
Property Value
Type Description
IReadOnlyDictionary<string, IMessageInfoDictionary>

All dictionaries

IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

Declaration
public bool IsReadOnly { get; }
Property Value
Type Description
bool

this[ProtocolVersion]

Returns dictionary for specified protocol version.

Declaration
public IMessageInfoDictionary this[ProtocolVersion version] { get; }
Parameters
Type Name Description
ProtocolVersion version

FIX protocol version.
Property Value
Type Description
IMessageInfoDictionary

Found dictionary, throws KeyNotFoundException if it is not found.

this[string]

Returns dictionary for specified dictionary id.

Declaration
public IMessageInfoDictionary this[string id] { get; }
Parameters
Type Name Description
string id

Dictionary id.
Property Value
Type Description
IMessageInfoDictionary

Found dictionary, throws KeyNotFoundException if it is not found.

Methods

Add(IMessageInfoDictionary)

Adds an item to the ICollection<T>.

Declaration
public void Add(IMessageInfoDictionary item)
Parameters
Type Name Description
IMessageInfoDictionary item

The object to add to the ICollection<T>.

Clear()

Removes all items from the ICollection<T>.

Declaration
public void Clear()

Contains(IMessageInfoDictionary)

Determines whether the ICollection<T> contains a specific value.

Declaration
public bool Contains(IMessageInfoDictionary item)
Parameters
Type Name Description
IMessageInfoDictionary item

The object to locate in the ICollection<T>.
Returns
Type Description
bool

true if item is found in the ICollection<T>; otherwise, false.

Contains(ProtocolVersion)

Determines whether the ICollection<T> contains a specific value.

Declaration
public bool Contains(ProtocolVersion version)
Parameters
Type Name Description
ProtocolVersion version

Protocol version to locate in the ICollection<T>.
Returns
Type Description
bool

true if item is found in the ICollection<T>; otherwise, false.

Contains(string)

Determines whether the ICollection<T> contains a specific value.

Declaration
public bool Contains(string id)
Parameters
Type Name Description
string id

Dictionary id to locate in the ICollection<T>.
Returns
Type Description
bool

true if item is found in the ICollection<T>; otherwise, false.

CopyTo(IMessageInfoDictionary[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

Declaration
public void CopyTo(IMessageInfoDictionary[] array, int arrayIndex)
Parameters
Type Name Description
IMessageInfoDictionary[] array

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.
int arrayIndex

The zero-based index in array at which copying begins.

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration
public IEnumerator<IMessageInfoDictionary> GetEnumerator()
Returns
Type Description
IEnumerator<IMessageInfoDictionary>

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

Init()

Loads all FIX Protocol versions.

Declaration
public void Init()

Init(IReadOnlyCollection<ProtocolVersion>, string)

Loads the specified FIX Protocol versions and dictionaries.

Declaration
public void Init(IReadOnlyCollection<ProtocolVersion> versions, string dictionaries)
Parameters
Type Name Description
IReadOnlyCollection<ProtocolVersion> versions

FIX Protocol versions to load
string dictionaries

Dictionary description files, separated with the '|' character

Init(IReadOnlyCollection<ProtocolVersion>, string, string)

Loads the specified FIX Protocol versions, dictionaries and the dictionary string.

Declaration
public void Init(IReadOnlyCollection<ProtocolVersion> versions, string dictionaries, string dictionaryString)
Parameters
Type Name Description
IReadOnlyCollection<ProtocolVersion> versions

FIX Protocol versions to load
string dictionaries

Dictionary description files, separated with the '|' character
string dictionaryString

The plain text string with the description of the FIX Dictionary

Init(string)

Loads all FIX Protocol versions and specified dictionaries.

The dictionary files are separated with the '|' character.

Declaration
public void Init(string dictionaries)
Parameters
Type Name Description
string dictionaries

Dictionary files

Remove(IMessageInfoDictionary)

Removes the first occurrence of a specific object from the ICollection<T>.

Declaration
public bool Remove(IMessageInfoDictionary item)
Parameters
Type Name Description
IMessageInfoDictionary item

The object to remove from the ICollection<T>.
Returns
Type Description
bool

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>.

Implements