Click or drag to resize

Layout Class

Defines a collection of data items (fields) whose values can be stored in a Message.
Inheritance Hierarchy

Namespace:  OBCOM.NetClient
Assembly:  OBCOM.NetClient (in OBCOM.NetClient.dll) Version: 40.82.5945.17884 (40.82.5945.17884)
public sealed class Layout : IEnumerable

The Layout type exposes the following members.

Public methodLayout
Creates a new Layout instance.
Public methodLayout(String)
Creates a new Layout with the given name.
Public propertyIsComplete
Returns true if the Layout is complete.
Public propertyLength
Returns the sum of the sizes of all the fields of the Layout.
Public propertyName
Returns the name of the Layout.
Public propertySignature
Returns the signature (checksum) of the Layout.
Public methodAddField
Creates and appends a new LayoutField to the Layout.
Public methodCompile
Compiles the supplied Layout specification.
Public methodCompileEcu
Compiles the suplied ECUSER specification into a Layout. The {@code specification} is composed of a sequence of three or more lines separeted by a new-line character. The first of these lines specifies the name of the Layout. The last line specifies the signature of the Layout. The lines between the first and the last specify the fields of the Layout.
Public methodComplete
Completes the definition of the collection of fields of this Layout.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExists
Returns true if the field identified by fieldName exists in the Layout.
Public methodGetEnumerator
Returns a read-only enumerator over the collection of fields in the Layout.
Public methodGetField
Returns the Layout field identified by the supplied fieldName.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Creates and returns a string serialization of this Layout.
(Overrides ObjectToString.)

The collection of fields of a Layout is defined using a specific sequence of method calls. First, a Layout is created, and its name defined, using the New(String) constructor. Then, the AddField(FieldType, String, Int32, Int32, String) method must be called for each Layout field. Finally, the Complete(String) method must be called to complete the definition of the collection.

Alternatively, a Layout can be created using the New() constructor and its other properties can be defined using the Compile(String) method.

See Also