Class TemplateLibrary
The SBE Template description.
Inherited Members
Namespace: OnixS.SimpleBinaryEncoding.Templates
Assembly: OnixS.SimpleBinaryEncoding.dll
Syntax
public class TemplateLibrary
Constructors
TemplateLibrary()
Constructor.
Declaration
public TemplateLibrary()
Properties
ByteOrder
Declaration
public ByteOrder ByteOrder { get; }
Property Value
Type | Description |
---|---|
ByteOrder | The byte order. |
Description
Declaration
public string Description { get; }
Property Value
Type | Description |
---|---|
string | The SBE Message Schema description. |
Id
Declaration
public ushort Id { get; }
Property Value
Type | Description |
---|---|
ushort | The SBE Message Schema identifier. |
LicensePath
Declaration
public static string LicensePath { get; set; }
Property Value
Type | Description |
---|---|
string | The path to the directory that contains the license file. |
MessagesByTemplateId
Declaration
public IReadOnlyDictionary<int, MessageInfo> MessagesByTemplateId { get; }
Property Value
Type | Description |
---|---|
IReadOnlyDictionary<int, MessageInfo> | Message descriptions by message template identifiers. |
MessagesByTypes
Declaration
public IReadOnlyDictionary<string, MessageInfo> MessagesByTypes { get; }
Property Value
Type | Description |
---|---|
IReadOnlyDictionary<string, MessageInfo> | Message descriptions by semantic types. |
Package
Declaration
public string Package { get; }
Property Value
Type | Description |
---|---|
string | The package name. |
SemanticVersion
Declaration
public string SemanticVersion { get; }
Property Value
Type | Description |
---|---|
string | The SBE Message Schema semantic version. |
Version
Declaration
public ushort Version { get; }
Property Value
Type | Description |
---|---|
ushort |
Methods
Parse(string)
Parses the given SBE template.
Declaration
public static TemplateLibrary Parse(string xmlTemplate)
Parameters
Type | Name | Description |
---|---|---|
string | xmlTemplate | The SBE template. |
Returns
Type | Description |
---|---|
TemplateLibrary | The template library. |
ToString()
Returns the text representation.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string | The text representation. |