DelimitedFormat Class

Defines a TelegramFormat that can be delimited.

Inheritance Hierarchy

SystemObject
Demo3D.HLE.Comms.TelegramTelegramFormat
Demo3D.HLE.Comms.TelegramDelimitedFormat

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

Syntax

Copy

[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public sealed class DelimitedFormat : TelegramFormat, 
	IDelimited

The DelimitedFormat type exposes the following members.

Constructors

	Name	Description
	DelimitedFormat	FOR INTERNAL USE ONLY.
	DelimitedFormat(String)	Constructs a DelimitedFormat.

Top

Properties

	Name	Description
	End	Format end delimiter.
	IsBuilt	True if the format has been built into a data type. (Inherited from TelegramFormat.)
	Length	Format byte length. (Overrides TelegramFormatLength.)
	Logger	Message logger. (Inherited from TelegramFormat.)
	Name	Format name. (Inherited from TelegramFormat.)
	Segments	List of TelegramFormatSegment in order. (Inherited from TelegramFormat.)
	Start	Format start delimiter.

Top

Methods

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

Top

Events

	Name	Description
	PropertyChanged	Raised when a property changes. (Inherited from TelegramFormat.)
	SegmentPropertyChanged	Raised when the properties of a segment is changed. (Inherited from TelegramFormat.)
	SegmentsChanged	Raised when Segments has changed. (Inherited from TelegramFormat.)

Top

Extension Methods

	Name	Description
	Delimit	Delimits data. (Defined by IDelimitedExtensions.)
	Undelimit	Undelimits delimited data. Returns the contained data only. (Defined by IDelimitedExtensions.)

Top

Remarks

Telegram byte length is always dynamic (-1).

Can accept segments of type DelimitedSegment, AlignedSegment or FixedSegment.

Reference

Demo3D.HLE.Comms.Telegram Namespace