Class FieldTypeInfo
Provides information about FIX field type.
Inherited Members
Namespace: OnixS.Fix.Dictionaries
Assembly: OnixS.Fix.Engine.dll
Syntax
public class FieldTypeInfo : ICloneable, ICollection<FieldValueInfo>, IEnumerable<FieldValueInfo>, IEnumerable
Constructors
FieldTypeInfo(FieldType, string, string, params FieldValueInfo[])
Constructor.
Declaration
public FieldTypeInfo(FieldType type, string name = null, string description = null, params FieldValueInfo[] validValues)
Parameters
Type | Name | Description |
---|---|---|
FieldType | type | FIX type. |
string | name | Type name. |
string | description | |
FieldValueInfo[] | validValues | List of valid values for enumeration |
Properties
Count
Gets the number of elements contained in the ICollection<T>.
Declaration
public int Count { get; }
Property Value
Type | Description |
---|---|
int |
Description
Type description.
Declaration
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | Type description |
IsReadOnly
Gets a value indicating whether the ICollection<T> is read-only.
Declaration
public bool IsReadOnly { get; }
Property Value
Type | Description |
---|---|
bool |
Name
Type name.
Declaration
public string Name { get; }
Property Value
Type | Description |
---|---|
string | Type name |
Type
FIX type.
Declaration
public FieldType Type { get; }
Property Value
Type | Description |
---|---|
FieldType | FIX type |
Values
Dictionary of valid values for enumeration.
Declaration
public IReadOnlyDictionary<string, FieldValueInfo> Values { get; }
Property Value
Type | Description |
---|---|
IReadOnlyDictionary<string, FieldValueInfo> | List of valid values for enumeration |
ValuesList
List of valid values for enumeration.
Declaration
public IReadOnlyList<FieldValueInfo> ValuesList { get; }
Property Value
Type | Description |
---|---|
IReadOnlyList<FieldValueInfo> | List of valid values for enumeration |
Methods
Add(FieldValueInfo)
Adds an item to the ICollection<T>.
Declaration
public void Add(FieldValueInfo item)
Parameters
Type | Name | Description |
---|---|---|
FieldValueInfo | item | The object to add to the ICollection<T>. |
Clear()
Removes all items from the ICollection<T>.
Declaration
public void Clear()
Clone()
Creates a new object that is a copy of the current instance.
Declaration
public virtual object Clone()
Returns
Type | Description |
---|---|
object | A new object that is a copy of this instance. |
Contains(FieldValueInfo)
Determines whether the ICollection<T> contains a specific value.
Declaration
public bool Contains(FieldValueInfo item)
Parameters
Type | Name | Description |
---|---|---|
FieldValueInfo | item | The object to locate in the ICollection<T>. |
Returns
Type | Description |
---|---|
bool | true if item is found in the ICollection<T>; otherwise, false. |
CopyTo(FieldValueInfo[], int)
Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.
Declaration
public void CopyTo(FieldValueInfo[] array, int arrayIndex)
Parameters
Type | Name | Description |
---|---|---|
FieldValueInfo[] | 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<FieldValueInfo> GetEnumerator()
Returns
Type | Description |
---|---|
IEnumerator<FieldValueInfo> | An enumerator that can be used to iterate through the collection. |
Remove(FieldValueInfo)
Removes the first occurrence of a specific object from the ICollection<T>.
Declaration
public bool Remove(FieldValueInfo item)
Parameters
Type | Name | Description |
---|---|---|
FieldValueInfo | item |
Returns
Type | Description |
---|---|
bool |
ToString()
Returns a string that represents the current object.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string | A string that represents the current object. |