Class TemplateLibrary

Class represent SBE template description.

Inheritance

System.Object

TemplateLibrary

Namespace: OnixS.SimpleBinaryEncoding.Templates

Assembly: OnixS.SimpleBinaryEncoding.dll

Syntax

public class TemplateLibrary : object

Constructors

TemplateLibrary()

Default constructor.

Declaration

public TemplateLibrary()

Properties

ByteOrder

Gets byte order.

Declaration

public ByteOrder ByteOrder { get; }

Property Value

Type	Description
ByteOrder

CompositeTypes

Registered composite types.

Declaration

public IReadOnlyDictionary<string, Type> CompositeTypes { get; }

Property Value

Type	Description
IReadOnlyDictionary<System.String, Type>

Description

Gets template schema description.

Declaration

public string Description { get; }

Property Value

Type	Description
System.String

Id

Gets template schema id.

Declaration

public ushort Id { get; }

Property Value

Type	Description
System.UInt16

LicensePath

Path to the directory where the license file is located.

Declaration

public static string LicensePath { get; set; }

Property Value

Type	Description
System.String

MessagesByTemplateId

Gets a collection of registered messages description by the message (template) id.

Declaration

public IReadOnlyDictionary<int, MessageInfo> MessagesByTemplateId { get; }

Property Value

Type	Description
IReadOnlyDictionary<System.Int32, MessageInfo>

MessagesByTypes

Gets collection of registered messages description by the FIX message type.

Declaration

public IReadOnlyDictionary<string, MessageInfo> MessagesByTypes { get; }

Property Value

Type	Description
IReadOnlyDictionary<System.String, MessageInfo>

Package

Gets package name.

Declaration

public string Package { get; }

Property Value

Type	Description
System.String

SemanticVersion

Gets template schema semantic version.

Declaration

public string SemanticVersion { get; }

Property Value

Type	Description
System.String

Types

Gets a collection of registered types description by the type name.

Declaration

public IReadOnlyDictionary<string, TypeInfo> Types { get; }

Property Value

Type	Description
IReadOnlyDictionary<System.String, TypeInfo>

Version

Gets template schema version.

Declaration

public ushort Version { get; }

Property Value

Type	Description
System.UInt16

Methods

AddComposite<T>(String)

Add composite type description.

Declaration

public void AddComposite<T>(string name)

    where T : IComposite

Parameters

Type	Name	Description
System.String	name	Composite type name

Type Parameters

Name	Description
T	Type which implement composite

AddMessage(MessageInfo)

Add message description.

Declaration

public void AddMessage(MessageInfo message)

Parameters

Type	Name	Description
MessageInfo	message	Message description.

AddType(TypeInfo)

Add type description.

Declaration

public void AddType(TypeInfo type)

Parameters

Type	Name	Description
TypeInfo	type	Type description.

AddType<T>(CompositeTypeInfo)

Add composite type description.

Declaration

public void AddType<T>(CompositeTypeInfo type)

    where T : IComposite

Parameters

Type	Name	Description
CompositeTypeInfo	type	Composite type information.

Type Parameters

Name	Description
T	Type which implement composite.

GetSemanticType(Int32)

Gets message semantic type.

Declaration

public string GetSemanticType(int templateId)

Parameters

Type	Name	Description
System.Int32	templateId	Template id.

Returns

Type	Description
System.String	Message semantic type

Parse(String)

Parses string as templates.

Declaration

public static TemplateLibrary Parse(string xmlTemplate)

Parameters

Type	Name	Description
System.String	xmlTemplate	The string contains templates description.

Returns

Type	Description
TemplateLibrary	Template library.

ToString()

Returns the string representation of an object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation of an object.