TelegramFormat Class

Defines the format of a telegram.

Inheritance Hierarchy

Namespace: Demo3D.HLE.Comms.Telegram
Assembly: Demo3D.HLE (in Demo3D.HLE.dll) Version: 15.0.2.11458

Syntax

[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public abstract class TelegramFormat : INotifyPropertyChanged, 
	IDisposable

The TelegramFormat type exposes the following members.

Constructors

	Name	Description
	TelegramFormat	Constructs a new TelegramFormat.
	TelegramFormat(String)	Constructs a new TelegramFormat.

Properties

	Name	Description
	IsBuilt	True if the format has been built into a data type.
	Length	Format byte length. -1 for dynamic length.
	Logger	Message logger.
	Name	Format name.
	Segments	List of TelegramFormatSegment in order.

Methods

	Name	Description
	AddSegment	Adds and appends a new TelegramFormatSegment.
	Build	Builds the format into a usable data type.
	CreateInstance	Creates an instance of the format data type, i.e., a formatted telegram.
	FindSegment	Returns an identified TelegramFormatSegment, or null.
	GetDataType	Gets the built data type representing the format.
	InsertSegment	Inserts a new TelegramFormatSegment at the specified index.
	ProcessInboundTelegram	Processes an inbound telegram.
	ProcessInboundTelegramToSegments	Processes an inbound telegram into its segments.
	ProcessOutboundTelegram	Processes an outbound telegram.
	ProcessSegmentsToOutboundTelegram	Processes telegram segments into an outbound telegram.
	RemoveSegment	Removes a TelegramFormatSegment by name.
	ReplaceSegments	Replace all current segments with the provided.
	SetPropertyT
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)

Events

	Name	Description
	PropertiesChanged	Raised when any property changes.
	PropertyChanged	Raised when a property changes.
	SegmentPropertyChanged	Raised when the properties of a segment is changed.
	SegmentsChanged	Raised when Segments has changed.

Remarks

Custom building logic can also be implemented by overriding Build.