Click or drag to resize

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: 19.00.00
Syntax
C#
Copy
[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public sealed class DelimitedFormat : TelegramFormat, 
	IDelimited

The DelimitedFormat type exposes the following members.

Constructors
 NameDescription
Public methodDelimitedFormat Constructs a DelimitedFormat.
Top
Properties
 NameDescription
Public propertyEnd Format end delimiter.
Public propertyIsBuilt True if the format has been built into a data type.
(Inherited from TelegramFormat)
Public propertyLength Format byte length.
(Overrides TelegramFormatLength)
Public propertyName Format name.
(Inherited from TelegramFormat)
Public propertyStart Format start delimiter.
Top
Methods
 NameDescription
Public methodAddSegment Adds and appends a new TelegramFormatSegment.
(Overrides TelegramFormatAddSegment(TelegramFormatSegment))
Public methodBuild Builds the format into a usable data type.
(Overrides TelegramFormatBuild)
Public methodCreateInstance Creates an instance of the format data type, i.e., a formatted telegram.
(Inherited from TelegramFormat)
Public methodFindSegment Returns an identified TelegramFormatSegment, or null.
(Inherited from TelegramFormat)
Public methodGetDataType Gets the built data type representing the format.
(Inherited from TelegramFormat)
Public methodInsertSegment Inserts a new TelegramFormatSegment at the specified index.
(Overrides TelegramFormatInsertSegment(TelegramFormatSegment, Int32))
Public methodProcessInboundTelegram Processes an inbound telegram.
(Overrides TelegramFormatProcessInboundTelegram(BufferSegment))
Public methodProcessInboundTelegramToSegments Processes an inbound telegram into its segments.
(Overrides TelegramFormatProcessInboundTelegramToSegments(BufferSegment))
Public methodProcessOutboundTelegram Processes an outbound telegram.
(Overrides TelegramFormatProcessOutboundTelegram(BufferSegment))
Public methodProcessSegmentsToOutboundTelegram Processes telegram segments into an outbound telegram.
(Overrides TelegramFormatProcessSegmentsToOutboundTelegram(IListBufferSegment))
Public methodRemoveSegment Removes a TelegramFormatSegment by name.
(Inherited from TelegramFormat)
Public methodReplaceSegments Replace all current segments with the provided.
(Overrides TelegramFormatReplaceSegments(IEnumerableTelegramFormatSegment))
Public methodToStringReturns a string that represents the current object.
(Inherited from TelegramFormat)
Top
Events
 NameDescription
Public eventPropertyChanged Raised when a property changes.
(Inherited from TelegramFormat)
Public eventSegmentPropertyChanged Raised when the properties of a segment is changed.
(Inherited from TelegramFormat)
Public eventSegmentsChanged Raised when Segments has changed.
(Inherited from TelegramFormat)
Top
Extension Methods
 NameDescription
Public Extension MethodDelimit Delimits data.
(Defined by IDelimitedExtensions)
Public Extension MethodUndelimit 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.

See Also