Class MessageStructure
Inheritance
System.Object
MessageStructure
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Assembly: FixAntenna.Core.dll
Syntax
public class MessageStructure
Fields
Lengths
Declaration
protected List<int> Lengths
Field Value
| Type |
Description |
| System.Collections.Generic.List<System.Int32> |
|
TagIds
Declaration
protected List<int> TagIds
Field Value
| Type |
Description |
| System.Collections.Generic.List<System.Int32> |
|
Types
Declaration
protected List<ValueType> Types
Field Value
| Type |
Description |
| System.Collections.Generic.List<ValueType> |
|
VariableLength
Special value for defining the size of field with variable value length
Declaration
public const int VariableLength = -1
Field Value
| Type |
Description |
| System.Int32 |
|
Methods
Append(MessageStructure)
Append fields to the end of current structure.
Declaration
public virtual void Append(MessageStructure struct)
Parameters
ContainsTagId(Int32)
Declaration
public virtual bool ContainsTagId(int tag)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tag |
|
Returns
| Type |
Description |
| System.Boolean |
|
Equals(Object)
Declaration
public override bool Equals(object o)
Parameters
| Type |
Name |
Description |
| System.Object |
o |
|
Returns
| Type |
Description |
| System.Boolean |
|
Overrides
System.Object.Equals(System.Object)
GetHashCode()
Declaration
public override int GetHashCode()
Returns
| Type |
Description |
| System.Int32 |
|
Overrides
System.Object.GetHashCode()
GetLength(Int32)
Declaration
public virtual int GetLength(int index)
Parameters
| Type |
Name |
Description |
| System.Int32 |
index |
|
Returns
| Type |
Description |
| System.Int32 |
|
GetSize()
Declaration
public virtual int GetSize()
Returns
| Type |
Description |
| System.Int32 |
|
GetTagId(Int32)
Declaration
public virtual int GetTagId(int index)
Parameters
| Type |
Name |
Description |
| System.Int32 |
index |
|
Returns
| Type |
Description |
| System.Int32 |
|
GetType(Int32)
Declaration
public virtual ValueType GetType(int index)
Parameters
| Type |
Name |
Description |
| System.Int32 |
index |
|
Returns
IndexOf(Int32)
Declaration
public virtual int IndexOf(int tagId)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tagId |
|
Returns
| Type |
Description |
| System.Int32 |
|
IndexOfTag(Int32)
Declaration
public virtual int IndexOfTag(int tag)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tag |
|
Returns
| Type |
Description |
| System.Int32 |
|
Merge(MessageStructure)
Declaration
public virtual void Merge(MessageStructure struct)
Parameters
Reserve(Int32, Int32)
Specifies tagId and size of the tag value. All tags should be reserved in order like in generated message.
Use MessageStructure.VariableLength to define the tag value that could be increased dynamically for concrete parameter.
Keep in mind, this will slow performance and spawn new Objects in runtime.
Reserved field will be added to the end of the structure.
Declaration
public virtual void Reserve(int tagId, int length)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tagId |
tagId
|
| System.Int32 |
length |
required amount of bytes for value or MessageStructure.VariableLength
|
Reserve(Int32, Int32, ValueType)
Declaration
public virtual void Reserve(int tagId, int length, ValueType type)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tagId |
|
| System.Int32 |
length |
|
| ValueType |
type |
|
Reserve(Int32, Int32, Int32)
Specifies tagId and size of the tag value. Reserved field will be inserted at specified position.
Declaration
public virtual void Reserve(int position, int tagId, int length)
Parameters
| Type |
Name |
Description |
| System.Int32 |
position |
position to insent the tag
|
| System.Int32 |
tagId |
tagId
|
| System.Int32 |
length |
required amount of bytes for value or VariableLength
|
See Also
Reserve(Int32, Int32, Int32, ValueType)
Declaration
public virtual void Reserve(int position, int tagId, int length, ValueType type)
Parameters
| Type |
Name |
Description |
| System.Int32 |
position |
|
| System.Int32 |
tagId |
|
| System.Int32 |
length |
|
| ValueType |
type |
|
ReserveLong(Int32, Int32)
Declaration
public virtual void ReserveLong(int tagId, int length)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tagId |
|
| System.Int32 |
length |
|
ReserveLong(Int32, Int32, Int32)
Declaration
public virtual void ReserveLong(int position, int tagId, int length)
Parameters
| Type |
Name |
Description |
| System.Int32 |
position |
|
| System.Int32 |
tagId |
|
| System.Int32 |
length |
|
ReserveString(Int32)
Declaration
public virtual void ReserveString(int tagId)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tagId |
|
ReserveString(Int32, Int32)
Declaration
public virtual void ReserveString(int tagId, int length)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tagId |
|
| System.Int32 |
length |
|
ReserveString(Int32, Int32, Int32)
Declaration
public virtual void ReserveString(int position, int tagId, int length)
Parameters
| Type |
Name |
Description |
| System.Int32 |
position |
|
| System.Int32 |
tagId |
|
| System.Int32 |
length |
|
SetLength(Int32, Int32)
Change the length for specific tag.
Declaration
public virtual void SetLength(int tagId, int length)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tagId |
|
| System.Int32 |
length |
required amount of bytes for value or VariableLength
|
SetLength(Int32, Int32, Int32)
Change the length for specific tag.
Declaration
public virtual void SetLength(int tagId, int occurance, int length)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tagId |
|
| System.Int32 |
occurance |
|
| System.Int32 |
length |
required amount of bytes for value or VariableLength
|
SetLengthAtIndex(Int32, Int32)
Declaration
public virtual void SetLengthAtIndex(int tagIndex, int length)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tagIndex |
|
| System.Int32 |
length |
|
SetType(Int32, ValueType)
Declaration
public virtual void SetType(int tagId, ValueType type)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tagId |
|
| ValueType |
type |
|
SetType(Int32, Int32, ValueType)
Declaration
public virtual void SetType(int tagId, int occurance, ValueType type)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tagId |
|
| System.Int32 |
occurance |
|
| ValueType |
type |
|
SetTypeAtIndex(Int32, ValueType)
Declaration
public virtual void SetTypeAtIndex(int tagIndex, ValueType type)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tagIndex |
|
| ValueType |
type |
|