Class DictionaryManager

FIX Protocol Specification collection.

Inheritance
Object
DictionaryManager
Inherited Members
Namespace: OnixS.Fix.Dictionaries
Assembly: OnixS.Fix.Engine.dll
Syntax
public class DictionaryManager : ICollection<Dictionary>, IReadOnlyCollection<Dictionary>, IEnumerable<Dictionary>, IEnumerable

Constructors

DictionaryManager(Dictionary[])

Constructor.

Declaration
public DictionaryManager(params Dictionary[] dialects)
Parameters
Type Name Description
Dictionary[] 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
Int32

Dictionaries

Returns all dictionaries.

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

All dictionaries

IsReadOnly

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

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

Item[ProtocolVersion]

Returns dictionary for specified protocol version.

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

FIX protocol version.
Property Value
Type Description
Dictionary

Found dictionary, throws KeyNotFoundException if it is not found.

Item[String]

Returns dictionary for specified dictionary id.

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

Dictionary id.
Property Value
Type Description
Dictionary

Found dictionary, throws KeyNotFoundException if it is not found.

Methods

Add(Dictionary)

Adds an item to the ICollection<T>.

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

The object to add to the ICollection<T>.

Clear()

Removes all items from the ICollection<T>.

Declaration
public void Clear()

Contains(Dictionary)

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

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

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

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
Boolean

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
Boolean

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

CopyTo(Dictionary[], Int32)

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

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

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

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

GetEnumerator()

Returns an enumerator that iterates through the collection.

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

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

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

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

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

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

Explicit Interface Implementations

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.

Implements