Release: | 3.1.0.0 |
Date: | 2017-02-15+02:00 |
Author: | WG FEF |
Company: | MOST Cooperation |
Modifications | |
---|---|
Change | Reason |
FBlock Overview | |
---|---|
FBlockID | Name |
0xA0 | Properties_WithSingleParameter |
0xA1 | Properties_WithMultipleParameters |
0xA2 | Methods |
Release: | 3.1.0.0 |
Date: | 2017-02-15+02:00 |
Author: | WG FEF |
Company: | MOST Cooperation |
Modifications | |
---|---|
Change | Reason |
Initial version |
Contains example functions of property function classes with a single parameter.
Function Overview | ||
---|---|---|
FktID | Name | Occurrence |
0xC00 | SwitchProperty | Optional |
0xC01 | NumberProperty_UnsignedByte | Optional |
0xC03 | NumberProperty_UnsignedWord_ValueRange | Optional |
0xC04 | NumberProperty_UnsignedWord_BitOriented | Optional |
0xC06 | NumberProperty_UnsignedLong | Optional |
0xC07 | NumberProperty_UnsignedLongLong | Optional |
0xC12 | NumberProperty_SignedByte | Optional |
0xC14 | NumberProperty_SignedWord | Optional |
0xC16 | NumberProperty_SignedLong | Optional |
0xC17 | NumberProperty_SignedLongLong | Optional |
0xC2A | NumberProperty_Float | Optional |
0xC2B | NumberProperty_Double | Optional |
0xC30 | TextProperty_LengthCodedString | Optional |
0xC31 | EnumerationProperty | Optional |
0xC32 | ContainerProperty_ComposedStream | Optional |
Occurrence: Optional
Example function for the property function class Switch.
Function class: Switch
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithSingleParameter (0xA0) | SwitchProperty (0xC00) | Set | BooleanParam |
Get | |||
SetGet | BooleanParam | ||
Status | BooleanParam | ||
Error | ErrorCode, ErrorInfo |
BooleanParam
One-bit Boolean parameter, can be either true or false.
Basis data type |
---|
Boolean |
Occurrence: Optional
Example function for the property function class Number with a parameter of type Unsigned Byte. The number parameter can have any unit from the "International System of Units" table in the MOST specification.
Function class: Number
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithSingleParameter (0xA0) | NumberProperty_UnsignedByte (0xC01) | Set | UnsignedByteParam |
Get | |||
SetGet | UnsignedByteParam | ||
Increment | NSteps | ||
Decrement | NSteps | ||
Status | UnsignedByteParam | ||
Error | ErrorCode, ErrorInfo |
UnsignedByteParam
Unsigned Byte parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
NSteps
Number of steps, as defined under "Step width for adjusting". Default value is 1, value 0 is not allowed. NSteps has no exponent, but has the same unit as the Number parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
Occurrence: Optional
Example function for the property function class Number with a parameter of type Unsigned Word. The number parameter can have any unit from the "International System of Units" table in the MOST specification.
Function class: Number
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithSingleParameter (0xA0) | NumberProperty_UnsignedWord_ValueRange (0xC03) | Set | UnsignedWordParam_ValueRange |
Get | |||
SetGet | UnsignedWordParam_ValueRange | ||
Increment | NSteps | ||
Decrement | NSteps | ||
Status | UnsignedWordParam_ValueRange | ||
Error | ErrorCode, ErrorInfo |
UnsignedWordParam_ValueRange
Unsigned Word parameter with a limited range of values.
Basis data type | Unit | Exp. | Step | Range of values | Name | Range description |
---|---|---|---|---|---|---|
Unsigned Word | none | 0 | 1 | 0...255 | LowRange | 0x0000...0x00FF |
61440...65535 | HighRange | 0xF000...0xFFFF |
NSteps
Number of steps, as defined under "Step width for adjusting". Default value is 1, value 0 is not allowed. NSteps has no exponent, but has the same unit as the Number parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
Occurrence: Optional
Example function for the property function class Number with a parameter of type Unsigned Word that uses the bit-oriented representation. For the bit-oriented representation, the unsigned integer parameter must have the unit attribute set to "none".
Function class: Number
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithSingleParameter (0xA0) | NumberProperty_UnsignedWord_BitOriented (0xC04) | Set | UnsignedWordParam_BitOriented |
Get | |||
SetGet | UnsignedWordParam_BitOriented | ||
Status | UnsignedWordParam_BitOriented | ||
Error | ErrorCode, ErrorInfo |
UnsignedWordParam_BitOriented
Unsigned Word parameter with bit-oriented coding.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
Bit-oriented values for UnsignedWordParam_BitOriented
Name | Position (Bit) | Length (Bit) | Description |
---|---|---|---|
Bit0 | 0 | 1 | A one bit flag. |
Bit1 | 1 | 1 | Another one bit flag. |
Bit234 | 2 | 3 | A flag that is 3 bits wide. |
Occurrence: Optional
Example function for the property function class Number with a parameter of type Unsigned Long. The number parameter can have any unit from the "International System of Units" table in the MOST specification.
Function class: Number
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithSingleParameter (0xA0) | NumberProperty_UnsignedLong (0xC06) | Set | UnsignedLongParam |
Get | |||
SetGet | UnsignedLongParam | ||
Increment | NSteps | ||
Decrement | NSteps | ||
Status | UnsignedLongParam | ||
Error | ErrorCode, ErrorInfo |
UnsignedLongParam
Unsigned Long parameter
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Long | none | 0 | 1 |
NSteps
Number of steps, as defined under "Step width for adjusting". Default value is 1, value 0 is not allowed. NSteps has no exponent, but has the same unit as the Number parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
Occurrence: Optional
Example function for the property function class Number with a parameter of type Unsigned Long Long. The number parameter can have any unit from the "International System of Units" table in the MOST specification.
Function class: Number
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithSingleParameter (0xA0) | NumberProperty_UnsignedLongLong (0xC07) | Set | UnsignedLongLongParam |
Get | |||
SetGet | UnsignedLongLongParam | ||
Increment | NSteps | ||
Decrement | NSteps | ||
Status | UnsignedLongLongParam | ||
Error | ErrorCode, ErrorInfo |
UnsignedLongLongParam
Unsigned Long parameter
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Long Long | none | 0 | 1 |
NSteps
Number of steps, as defined under "Step width for adjusting". Default value is 1, value 0 is not allowed. NSteps has no exponent, but has the same unit as the Number parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
Occurrence: Optional
Example function for the property function class Number with a parameter of type Signed Byte. The number parameter can have any unit from the "International System of Units" table in the MOST specification.
Function class: Number
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithSingleParameter (0xA0) | NumberProperty_SignedByte (0xC12) | Set | SignedByteParam |
Get | |||
SetGet | SignedByteParam | ||
Increment | NSteps | ||
Decrement | NSteps | ||
Status | SignedByteParam | ||
Error | ErrorCode, ErrorInfo |
SignedByteParam
Signed Byte parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Signed Byte | none | 0 | 1 |
NSteps
Number of steps, as defined under "Step width for adjusting". Default value is 1, value 0 is not allowed. NSteps has no exponent, but has the same unit as the Number parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
Occurrence: Optional
Example function for the property function class Number with a parameter of type Signed Word. The number parameter can have any unit from the "International System of Units" table in the MOST specification.
Function class: Number
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithSingleParameter (0xA0) | NumberProperty_SignedWord (0xC14) | Set | SignedWordParam |
Get | |||
SetGet | SignedWordParam | ||
Increment | NSteps | ||
Decrement | NSteps | ||
Status | SignedWordParam | ||
Error | ErrorCode, ErrorInfo |
SignedWordParam
Signed Word parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Signed Word | none | 0 | 1 |
NSteps
Number of steps, as defined under "Step width for adjusting". Default value is 1, value 0 is not allowed. NSteps has no exponent, but has the same unit as the Number parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
Occurrence: Optional
Example function for the property function class Number with a parameter of type Signed Long. The number parameter can have any unit from the "International System of Units" table in the MOST specification.
Function class: Number
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithSingleParameter (0xA0) | NumberProperty_SignedLong (0xC16) | Set | SignedLongParam |
Get | |||
SetGet | SignedLongParam | ||
Increment | NSteps | ||
Decrement | NSteps | ||
Status | SignedLongParam | ||
Error | ErrorCode, ErrorInfo |
SignedLongParam
Signed Long parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Signed Long | none | 0 | 1 |
NSteps
Number of steps, as defined under "Step width for adjusting". Default value is 1, value 0 is not allowed. NSteps has no exponent, but has the same unit as the Number parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
Occurrence: Optional
Example function for the property function class Number with a parameter of type Signed Long Long. The number parameter can have any unit from the "International System of Units" table in the MOST specification.
Function class: Number
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithSingleParameter (0xA0) | NumberProperty_SignedLongLong (0xC17) | Set | SignedLongLongParam |
Get | |||
SetGet | SignedLongLongParam | ||
Increment | NSteps | ||
Decrement | NSteps | ||
Status | SignedLongLongParam | ||
Error | ErrorCode, ErrorInfo |
SignedLongLongParam
Signed Long parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Signed Long Long | none | 0 | 1 |
NSteps
Number of steps, as defined under "Step width for adjusting". Default value is 1, value 0 is not allowed. NSteps has no exponent, but has the same unit as the Number parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
Occurrence: Optional
Example function for the property function class Number with a parameter of type Float. The number parameter can have any unit from the "International System of Units" table in the MOST specification.
Function class: Number
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithSingleParameter (0xA0) | NumberProperty_Float (0xC2A) | Set | FloatParam |
Get | |||
SetGet | FloatParam | ||
Increment | NSteps | ||
Decrement | NSteps | ||
Status | FloatParam | ||
Error | ErrorCode, ErrorInfo |
FloatParam
Unsigned Long parameter
Basis data type | Unit |
---|---|
Float | none |
NSteps
Number of steps, as defined under "Step width for adjusting". Default value is 1, value 0 is not allowed. NSteps has no exponent, but has the same unit as the Number parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
Occurrence: Optional
Example function for the property function class Number with a parameter of type Double. The number parameter can have any unit from the "International System of Units" table in the MOST specification.
Function class: Number
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithSingleParameter (0xA0) | NumberProperty_Double (0xC2B) | Set | DoubleParam |
Get | |||
SetGet | DoubleParam | ||
Increment | NSteps | ||
Decrement | NSteps | ||
Status | DoubleParam | ||
Error | ErrorCode, ErrorInfo |
DoubleParam
Unsigned Long parameter
Basis data type | Unit |
---|---|
Double | none |
NSteps
Number of steps, as defined under "Step width for adjusting". Default value is 1, value 0 is not allowed. NSteps has no exponent, but has the same unit as the Number parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
Occurrence: Optional
Example function for the property function class Text with a Length-coded String.
Function class: Text
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithSingleParameter (0xA0) | TextProperty_LengthCodedString (0xC30) | Set | LengthCodedStringParam |
Get | |||
SetGet | LengthCodedStringParam | ||
Status | LengthCodedStringParam | ||
Error | ErrorCode, ErrorInfo |
LengthCodedStringParam
A String parameter.
Basis data type | MaxSize |
---|---|
Length-coded String |
Occurrence: Optional
Example function for the property function class Enumeration.
Function class: Enumeration
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithSingleParameter (0xA0) | EnumerationProperty (0xC31) | Set | EnumParam |
Get | |||
SetGet | EnumParam | ||
Status | EnumParam | ||
Error | ErrorCode, ErrorInfo |
EnumParam
A parameter of data type Enum.
Basis data type | Code | Name | Description |
---|---|---|---|
Enum (1 byte) |
0x0 | zero | zero |
0x1 | one | one | |
0x2 | two | two | |
0x3 | three | three |
Occurrence: Optional
Example function for the property function class Container. The included parameter is of type Stream but "simple", that is, it does not depend on a Stream selector. The use of simple and unstructured Streams is not recommended.
Function class: Container
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithSingleParameter (0xA0) | ContainerProperty_ComposedStream (0xC32) | Set | StreamParam_Enclosing |
Get | |||
SetGet | StreamParam_Enclosing | ||
Status | StreamParam_Enclosing | ||
Error | ErrorCode, ErrorInfo |
StreamParam_Enclosing
Composed Stream parameter.
Basis data type | Length | Description |
---|---|---|
Stream |
Content: UnsignedByteParam,
StreamParam_EnclosedComposed
|
StreamParam_Enclosing.UnsignedByteParam
Unsigned Byte parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
StreamParam_Enclosing.StreamParam_EnclosedComposed
Composed Stream parameter.
Basis data type | Length | Condition | Description |
---|---|---|---|
Stream | UnsignedByteParam = 0x0...0xF |
Content: UnsignedLongLongParam
|
|
UnsignedByteParam = 0x10 |
Content: UnsignedByteParam,
UnsignedLongParam
|
StreamParam_EnclosedComposed.UnsignedLongLongParam
Unsigned Long parameter
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Long Long | none | 0 | 1 |
StreamParam_EnclosedComposed.UnsignedByteParam
Unsigned Byte parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
StreamParam_EnclosedComposed.UnsignedLongParam
Unsigned Long parameter
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Long | none | 0 | 1 |
Release: | 3.1.0.0 |
Date: | 2017-02-15+02:00 |
Author: | WG FEF |
Company: | MOST Cooperation |
Modifications | |
---|---|
Change | Reason |
Initial version |
Contains example functions of property function classes with multiple parameters.
Function Overview | ||
---|---|---|
FktID | Name | Occurrence |
0xC00 | DynamicArrayProperty | Optional |
0xC01 | LongArrayProperty | Optional |
0xC02 | SequenceProperty | Optional |
0xC03 | CollectionProperty | Optional |
0xC04 | CollectionProperty_ArrayType | Optional |
0xC05 | CollectionProperty_RecordType | Optional |
0xC14 | UnclassifiedProperty_WithStreamCases | Optional |
Occurrence: Optional
Example function for the property function class DynamicArray (where the record contains an Unsigned Byte, a Boolean and a String parameter).
Function class: DynamicArray of { Record of { Unsigned Word Unsigned Byte Boolean String } }
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithMultipleParameters (0xA1) | DynamicArrayProperty (0xC00) | Set | Tag, PosY, ArrayParam_WithTaggedRecord |
Get | Tag, PosY | ||
SetGet | Tag, PosY, ArrayParam_WithTaggedRecord | ||
Increment | Tag, PosY, NSteps | ||
Decrement | Tag, PosY, NSteps | ||
Status | Tag, PosY, ArrayParam_WithTaggedRecord | ||
Error | ErrorCode, ErrorInfo |
Tag
Tag parameter for Dynamic Array and similar function classes like Long Array and Map. It is used to uniquely identify an entry.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
PosY
Column indicator for dynamic arrays.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
ArrayParam_WithTaggedRecord
An array of tagged records (a tag, an Unsigned Byte, a Boolean and a String parameter). Can be used for DynamicArrays, LongArrays, and Maps.
Basis data type | Description | |
---|---|---|
Array | Pos | Data |
{ x=0, y=0 } | Tag[1], UnsignedByteParam[1], BooleanParam[1], StringParam[1],..., Tag[NMax], UnsignedByteParam[NMax], BooleanParam[NMax], StringParam[NMax] | |
{ x>0, y=0 } | Tag[x], UnsignedByteParam[x], BooleanParam[x], StringParam[x] | |
{ x>0, y=1 } | Tag[x] | |
{ x>0, y=2 } | UnsignedByteParam[x] | |
{ x>0, y=3 } | BooleanParam[x] | |
{ x>0, y=4 } | StringParam[x] |
Tag parameter for Dynamic Array and similar function classes like Long Array and Map. It is used to uniquely identify an entry.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
Unsigned Byte parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
One-bit Boolean parameter, can be either true or false.
Basis data type |
---|
Boolean |
A String parameter.
Basis data type | MaxSize |
---|---|
String |
NSteps
Number of steps, as defined under "Step width for adjusting". Default value is 1, value 0 is not allowed. NSteps has no exponent, but has the same unit as the Number parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
Occurrence: Optional
Example function for the property function classLongArray (where the record contains an Unsigned Byte, a Boolean and a String parameter).
Function class: LongArray of { Record of { Unsigned Word Unsigned Byte Boolean String } }
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithMultipleParameters (0xA1) | LongArrayProperty (0xC01) | Set | Tag, PosY, ArrayParam_WithTaggedRecord |
Get | Tag, PosY | ||
SetGet | Tag, PosY, ArrayParam_WithTaggedRecord | ||
Increment | Tag, PosY, NSteps | ||
Decrement | Tag, PosY, NSteps | ||
Status | Tag, PosY, CurrentSize, AbsolutePosition, ArrayParam_WithTaggedRecord | ||
Error | ErrorCode, ErrorInfo |
Tag
Tag parameter for Dynamic Array and similar function classes like Long Array and Map. It is used to uniquely identify an entry.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
PosY
Column indicator for dynamic arrays.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
ArrayParam_WithTaggedRecord
An array of tagged records (a tag, an Unsigned Byte, a Boolean and a String parameter). Can be used for DynamicArrays, LongArrays, and Maps.
Basis data type | Description | |
---|---|---|
Array | Pos | Data |
{ x=0, y=0 } | Tag[1], UnsignedByteParam[1], BooleanParam[1], StringParam[1],..., Tag[NMax], UnsignedByteParam[NMax], BooleanParam[NMax], StringParam[NMax] | |
{ x>0, y=0 } | Tag[x], UnsignedByteParam[x], BooleanParam[x], StringParam[x] | |
{ x>0, y=1 } | Tag[x] | |
{ x>0, y=2 } | UnsignedByteParam[x] | |
{ x>0, y=3 } | BooleanParam[x] | |
{ x>0, y=4 } | StringParam[x] |
Tag parameter for Dynamic Array and similar function classes like Long Array and Map. It is used to uniquely identify an entry.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
Unsigned Byte parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
One-bit Boolean parameter, can be either true or false.
Basis data type |
---|
Boolean |
A String parameter.
Basis data type | MaxSize |
---|---|
String |
NSteps
Number of steps, as defined under "Step width for adjusting". Default value is 1, value 0 is not allowed. NSteps has no exponent, but has the same unit as the Number parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
CurrentSize
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
AbsolutePosition
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
Occurrence: Optional
Example function for the property function class Sequence (with a Signed Long and an Unsigned Word parameter).
Function class: Sequence Property
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithMultipleParameters (0xA1) | SequenceProperty (0xC02) | Set | SignedLongParam, UnsignedWordParam |
Get | |||
SetGet | SignedLongParam, UnsignedWordParam | ||
Status | SignedLongParam, UnsignedByteParam | ||
Error | ErrorCode, ErrorInfo |
SignedLongParam
Signed Long parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Signed Long | none | 0 | 1 |
UnsignedWordParam
Unsigned Word parameter
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
UnsignedByteParam
Unsigned Byte parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
Occurrence: Optional
Example function for the property function class Collection with a nested structure.
Function class: Collection
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithMultipleParameters (0xA1) | CollectionProperty (0xC03) | Set | AccessPath, PersonList |
Get | AccessPath | ||
SetGet | AccessPath, PersonList | ||
Status | AccessPath, PersonList | ||
Error | ErrorCode, ErrorInfo |
AccessPath
Path selection parameter for Collection function class.
Basis data type | ElementCount size | Max. element count | Element type | Element name |
---|---|---|---|---|
Array Type | 4 | 4 | Unsigned Long | AccessPathEntry |
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Long | none | 0 | 1 |
PersonList
An array representing a people directory with phone numbers and pictures.
Basis data type | ElementCount size | Element type | Element name |
---|---|---|---|
Array Type | 2 | Record Type | Person |
Basis data type | Description | |
---|---|---|
Record Type | FirstName, LastName, PhoneNumberList, Picture |
First name.
Basis data type | MaxSize |
---|---|
Length-coded String |
Last name.
Basis data type | MaxSize |
---|---|
Length-coded String |
An array of phone number records.
Basis data type | ElementCount size | Element type | Element name |
---|---|---|---|
Array Type | 1 | Record Type | PhoneNumber |
Basis data type | Description | |
---|---|---|
Record Type | EntryType, CountryCode, RegionCode, Number |
The type of phone number, for example, "Home", "Business", or "Mobile".
Basis data type | MaxSize |
---|---|
Length-coded String |
The country code of a phone number.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
The region code of a phone number.
Basis data type | MaxSize |
---|---|
Length-coded String |
The actual phone number, typically without country code or region code.
Basis data type | MaxSize |
---|---|
Length-coded String |
Basis data type | ElementCount size | Element type | Element name |
---|---|---|---|
Array Type | 4 | Unsigned Byte | PictureByte |
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
Occurrence: Optional
Example function for the property function class Collection using a parameter of data type Array Type.
Function class: Unclassified Property
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithMultipleParameters (0xA1) | CollectionProperty_ArrayType (0xC04) | Set | AccessPath, ArrayTypeParam |
Get | AccessPath | ||
SetGet | AccessPath, ArrayTypeParam | ||
Status | AccessPath, ArrayTypeParam | ||
Error | ErrorCode, ErrorInfo |
AccessPath
Path selection parameter for Collection function class.
Basis data type | ElementCount size | Max. element count | Element type | Element name |
---|---|---|---|---|
Array Type | 4 | 1 | Unsigned Long | AccessPathEntry |
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Long | none | 0 | 1 |
ArrayTypeParam
Array Type parameter with element count field size set to 2.
Basis data type | ElementCount size | Element type | Element name |
---|---|---|---|
Array Type | 2 | Unsigned Byte | UnsignedByteParam |
Unsigned Byte parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
Occurrence: Optional
Example function for the property function class Collection using a parameter of data type Array Type.
Function class: Unclassified Property
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithMultipleParameters (0xA1) | CollectionProperty_RecordType (0xC05) | Set | AccessPath, RecordTypeParam |
Get | AccessPath | ||
SetGet | AccessPath, RecordTypeParam | ||
Status | AccessPath, RecordTypeParam | ||
Error | ErrorCode, ErrorInfo |
AccessPath
Path selection parameter for Collection function class.
Basis data type | ElementCount size | Max. element count | Element type | Element name |
---|---|---|---|---|
Array Type | 4 | 1 | Unsigned Long | AccessPathEntry |
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Long | none | 0 | 1 |
RecordTypeParam
Record Type parameter.
Basis data type | Description | |
---|---|---|
Record Type | UnsignedByteParam, DoubleParam, LengthCodedStringParam |
Unsigned Byte parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
Unsigned Long parameter
Basis data type | Unit |
---|---|
Double | none |
A String parameter.
Basis data type | MaxSize |
---|---|
Length-coded String |
Occurrence: Optional
Example function for the Unclassified Property function class.
Function class: Unclassified Property
FBlock | Function | OPType | Parameter |
---|---|---|---|
Properties_WithMultipleParameters (0xA1) | UnclassifiedProperty_WithStreamCases (0xC14) | Get | UnsignedByteParameter |
Status | DataType, DataDescription | ||
Error | ErrorCode, ErrorInfo |
UnsignedByteParameter
Unsigned Byte parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
DataType
An enumeration parameter used as a selector for streamcases.
Basis data type | Code | Name | Description |
---|---|---|---|
Enum (1 byte) |
0x0 | EnumCode0 | Description of code 0. |
0x1 | EnumCode1 | Description of code 1. |
DataDescription
A stream with stream cases.
Basis data type | Length | Condition | Description |
---|---|---|---|
Stream | 63 | DataType = 0x0 |
Content: UnsignedByteParam,
LengthCodedStringParam
|
DataType = 0x1 |
Content: SignedByteParam
|
DataDescription.UnsignedByteParam
Unsigned Byte parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
DataDescription.LengthCodedStringParam
A String parameter.
Basis data type | MaxSize |
---|---|
Length-coded String |
DataDescription.SignedByteParam
Signed Byte parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Signed Byte | none | 0 | 1 |
Release: | 3.1.0.0 |
Date: | 2017-02-15+02:00 |
Author: | WG FEF |
Company: | MOST Cooperation |
Modifications | |
---|---|
Change | Reason |
Initial version |
Contains example functions of method function classes.
Function Overview | ||
---|---|---|
FktID | Name | Occurrence |
0xC00 | TriggerMethod | Optional |
0xC01 | SequenceMethod | Optional |
0xC02 | UnclassifiedMethod | Optional |
Occurrence: Optional
Example function for the method function class Trigger Method.
Function class: Trigger Method
FBlock | Function | OPType | Parameter |
---|---|---|---|
Methods (0xA2) | TriggerMethod (0xC00) | Start | |
StartResult | |||
StartResultAck | SenderHandle | ||
ErrorAck | SenderHandle, ErrorCode, ErrorInfo | ||
ProcessingAck | SenderHandle | ||
Processing | |||
Result | |||
ResultAck | SenderHandle | ||
Error | ErrorCode, ErrorInfo |
SenderHandle
Characterizes the sender in more detail (task, process, ...).
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
Occurrence: Optional
Example function for the function class Sequence Method. The parameter lists for commands and reports differ, which is permissible for a Sequence Method.
Function class: Sequence Method
FBlock | Function | OPType | Parameter |
---|---|---|---|
Methods (0xA2) | SequenceMethod (0xC01) | Start | SignedLongParam, UnsignedWordParam |
StartResultAck | SenderHandle, SignedLongParam, UnsignedWordParam | ||
AbortAck | SenderHandle | ||
ErrorAck | SenderHandle, ErrorCode, ErrorInfo | ||
ProcessingAck | SenderHandle | ||
ResultAck | SenderHandle, SignedLongParam | ||
Error | ErrorCode, ErrorInfo |
SignedLongParam
Signed Long parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Signed Long | none | 0 | 1 |
UnsignedWordParam
Unsigned Word parameter
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
SenderHandle
Characterizes the sender in more detail (task, process, ...).
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
Occurrence: Optional
An unclassified method is used when no other method function class matches the desired function signature.
Function class: Unclassified Method
FBlock | Function | OPType | Parameter |
---|---|---|---|
Methods (0xA2) | UnclassifiedMethod (0xC02) | StartResultAck | SenderHandle, UnsignedByteParameter |
Processing | |||
ResultAck | SenderHandle | ||
Error | SenderHandle |
SenderHandle
Characterizes the sender in more detail (task, process, ...).
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
UnsignedByteParameter
Unsigned Byte parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |