Click or drag to resize

AlignedFormat Class

Defines a TelegramFormat where data is aligned with fixed byte length.
Inheritance Hierarchy
SystemObject
  Demo3D.HLE.Comms.TelegramTelegramFormat
    Demo3D.HLE.Comms.TelegramAlignedFormat

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 AlignedFormat : TelegramFormat, 
	IAligned

The AlignedFormat type exposes the following members.

Constructors
 NameDescription
Public methodAlignedFormat Constructs a FixedFormat.
Top
Properties
 NameDescription
Public propertyAlignment Alignment type.
Public propertyFill Fill byte.
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)
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 MethodAlign Aligns data with fill bytes.
(Defined by IAlignedExtensions)
Public Extension MethodUnalign Unaligns data. Returns data with fill bytes removed.
(Defined by IAlignedExtensions)
Top
Remarks

Can accept segments of type AlignedSegment or FixedSegment.

Fixed length must be equal or greater than the sum of segment lengths. Higher length results in data alignment.

See Also