Function Catalog

Release:3.1.0.0
Date:2015-09-09+02:00
Author:WG FEF
Company:MOST Cooperation
Modifications
ChangeReason

FBlock Overview
FBlockIDName
0xA0Properties_WithSingleParameter
0xA1Properties_WithMultipleParameters
0xA2Methods

Properties_WithSingleParameter (FBlockID = 0xA0)

Release:3.1.0.0
Date:2015-09-09+02:00
Author:WG FEF
Company:MOST Cooperation
Modifications
ChangeReason
Initial version

Contains example functions of property function classes with a single parameter.

Function Overview
FktIDNameOccurrence
0xC00SwitchPropertyOptional
0xC01NumberProperty_UnsignedByteOptional
0xC03NumberProperty_UnsignedWord_ValueRangeOptional
0xC04NumberProperty_UnsignedWord_BitOrientedOptional
0xC06NumberProperty_UnsignedLongOptional
0xC07NumberProperty_UnsignedLongLongOptional
0xC12NumberProperty_SignedByteOptional
0xC14NumberProperty_SignedWordOptional
0xC16NumberProperty_SignedLongOptional
0xC17NumberProperty_SignedLongLongOptional
0xC2ANumberProperty_FloatOptional
0xC2BNumberProperty_DoubleOptional
0xC30TextProperty_LengthCodedStringOptional
0xC31EnumerationPropertyOptional
0xC32ContainerProperty_ComposedStreamOptional

SwitchProperty (0xC00)

Occurrence: Optional

Example function for the property function class Switch.

Format of Function

Function class: Switch

FBlockFunctionOPTypeParameter
Properties_WithSingleParameter (0xA0)SwitchProperty (0xC00)SetBooleanParam
Get
SetGetBooleanParam
StatusBooleanParam
ErrorErrorCode, ErrorInfo

Parameter

BooleanParam


One-bit Boolean parameter, can be either true or false.

Basis data type
Boolean

NumberProperty_UnsignedByte (0xC01)

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.

Format of Function

Function class: Number

FBlockFunctionOPTypeParameter
Properties_WithSingleParameter (0xA0)NumberProperty_UnsignedByte (0xC01)SetUnsignedByteParam
Get
SetGetUnsignedByteParam
IncrementNSteps
DecrementNSteps
StatusUnsignedByteParam
ErrorErrorCode, ErrorInfo

Parameter

UnsignedByteParam


Unsigned Byte parameter.

Basis data typeUnitExp.Step
Unsigned Bytenone01

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 typeUnitExp.Step
Unsigned Bytenone01

NumberProperty_UnsignedWord_ValueRange (0xC03)

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.

Format of Function

Function class: Number

FBlockFunctionOPTypeParameter
Properties_WithSingleParameter (0xA0)NumberProperty_UnsignedWord_ValueRange (0xC03)SetUnsignedWordParam_ValueRange
Get
SetGetUnsignedWordParam_ValueRange
IncrementNSteps
DecrementNSteps
StatusUnsignedWordParam_ValueRange
ErrorErrorCode, ErrorInfo

Parameter

UnsignedWordParam_ValueRange


Unsigned Word parameter with a limited range of values.

Basis data typeUnitExp.StepRange of valuesNameRange description
Unsigned Wordnone010...255LowRange0x0000...0x00FF
61440...65535HighRange0xF000...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 typeUnitExp.Step
Unsigned Bytenone01

NumberProperty_UnsignedWord_BitOriented (0xC04)

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".

Format of Function

Function class: Number

FBlockFunctionOPTypeParameter
Properties_WithSingleParameter (0xA0)NumberProperty_UnsignedWord_BitOriented (0xC04)SetUnsignedWordParam_BitOriented
Get
SetGetUnsignedWordParam_BitOriented
StatusUnsignedWordParam_BitOriented
ErrorErrorCode, ErrorInfo

Parameter

UnsignedWordParam_BitOriented


Unsigned Word parameter with bit-oriented coding.

Basis data typeUnitExp.Step
Unsigned Wordnone01

Bit-oriented values for UnsignedWordParam_BitOriented

NamePosition (Bit)Length (Bit)Description
Bit001A one bit flag.
Bit111Another one bit flag.
Bit23423A flag that is 3 bits wide.

NumberProperty_UnsignedLong (0xC06)

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.

Format of Function

Function class: Number

FBlockFunctionOPTypeParameter
Properties_WithSingleParameter (0xA0)NumberProperty_UnsignedLong (0xC06)SetUnsignedLongParam
Get
SetGetUnsignedLongParam
IncrementNSteps
DecrementNSteps
StatusUnsignedLongParam
ErrorErrorCode, ErrorInfo

Parameter

UnsignedLongParam


Unsigned Long parameter

Basis data typeUnitExp.Step
Unsigned Longnone01

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 typeUnitExp.Step
Unsigned Bytenone01

NumberProperty_UnsignedLongLong (0xC07)

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.

Format of Function

Function class: Number

FBlockFunctionOPTypeParameter
Properties_WithSingleParameter (0xA0)NumberProperty_UnsignedLongLong (0xC07)SetUnsignedLongLongParam
Get
SetGetUnsignedLongLongParam
IncrementNSteps
DecrementNSteps
StatusUnsignedLongLongParam
ErrorErrorCode, ErrorInfo

Parameter

UnsignedLongLongParam


Unsigned Long parameter

Basis data typeUnitExp.Step
Unsigned Long Longnone01

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 typeUnitExp.Step
Unsigned Bytenone01

NumberProperty_SignedByte (0xC12)

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.

Format of Function

Function class: Number

FBlockFunctionOPTypeParameter
Properties_WithSingleParameter (0xA0)NumberProperty_SignedByte (0xC12)SetSignedByteParam
Get
SetGetSignedByteParam
IncrementNSteps
DecrementNSteps
StatusSignedByteParam
ErrorErrorCode, ErrorInfo

Parameter

SignedByteParam


Signed Byte parameter.

Basis data typeUnitExp.Step
Signed Bytenone01

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 typeUnitExp.Step
Unsigned Bytenone01

NumberProperty_SignedWord (0xC14)

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.

Format of Function

Function class: Number

FBlockFunctionOPTypeParameter
Properties_WithSingleParameter (0xA0)NumberProperty_SignedWord (0xC14)SetSignedWordParam
Get
SetGetSignedWordParam
IncrementNSteps
DecrementNSteps
StatusSignedWordParam
ErrorErrorCode, ErrorInfo

Parameter

SignedWordParam


Signed Word parameter.

Basis data typeUnitExp.Step
Signed Wordnone01

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 typeUnitExp.Step
Unsigned Bytenone01

NumberProperty_SignedLong (0xC16)

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.

Format of Function

Function class: Number

FBlockFunctionOPTypeParameter
Properties_WithSingleParameter (0xA0)NumberProperty_SignedLong (0xC16)SetSignedLongParam
Get
SetGetSignedLongParam
IncrementNSteps
DecrementNSteps
StatusSignedLongParam
ErrorErrorCode, ErrorInfo

Parameter

SignedLongParam


Signed Long parameter.

Basis data typeUnitExp.Step
Signed Longnone01

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 typeUnitExp.Step
Unsigned Bytenone01

NumberProperty_SignedLongLong (0xC17)

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.

Format of Function

Function class: Number

FBlockFunctionOPTypeParameter
Properties_WithSingleParameter (0xA0)NumberProperty_SignedLongLong (0xC17)SetSignedLongLongParam
Get
SetGetSignedLongLongParam
IncrementNSteps
DecrementNSteps
StatusSignedLongLongParam
ErrorErrorCode, ErrorInfo

Parameter

SignedLongLongParam


Signed Long parameter.

Basis data typeUnitExp.Step
Signed Long Longnone01

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 typeUnitExp.Step
Unsigned Bytenone01

NumberProperty_Float (0xC2A)

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.

Format of Function

Function class: Number

FBlockFunctionOPTypeParameter
Properties_WithSingleParameter (0xA0)NumberProperty_Float (0xC2A)SetFloatParam
Get
SetGetFloatParam
IncrementNSteps
DecrementNSteps
StatusFloatParam
ErrorErrorCode, ErrorInfo

Parameter

FloatParam


Unsigned Long parameter

Basis data typeUnit
Floatnone

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 typeUnitExp.Step
Unsigned Bytenone01

NumberProperty_Double (0xC2B)

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.

Format of Function

Function class: Number

FBlockFunctionOPTypeParameter
Properties_WithSingleParameter (0xA0)NumberProperty_Double (0xC2B)SetDoubleParam
Get
SetGetDoubleParam
IncrementNSteps
DecrementNSteps
StatusDoubleParam
ErrorErrorCode, ErrorInfo

Parameter

DoubleParam


Unsigned Long parameter

Basis data typeUnit
Doublenone

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 typeUnitExp.Step
Unsigned Bytenone01

TextProperty_LengthCodedString (0xC30)

Occurrence: Optional

Example function for the property function class Text with a Length-coded String.

Format of Function

Function class: Text

FBlockFunctionOPTypeParameter
Properties_WithSingleParameter (0xA0)TextProperty_LengthCodedString (0xC30)SetLengthCodedStringParam
Get
SetGetLengthCodedStringParam
StatusLengthCodedStringParam
ErrorErrorCode, ErrorInfo

Parameter

LengthCodedStringParam


A String parameter.

Basis data typeMaxSize
Length-coded String

EnumerationProperty (0xC31)

Occurrence: Optional

Example function for the property function class Enumeration.

Format of Function

Function class: Enumeration

FBlockFunctionOPTypeParameter
Properties_WithSingleParameter (0xA0)EnumerationProperty (0xC31)SetEnumParam
Get
SetGetEnumParam
StatusEnumParam
ErrorErrorCode, ErrorInfo

Parameter

EnumParam


A parameter of data type Enum.

Basis data typeCodeNameDescription
Enum
(1 byte)
0x0zerozero
0x1oneone
0x2twotwo
0x3threethree

ContainerProperty_ComposedStream (0xC32)

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.

Format of Function

Function class: Container

FBlockFunctionOPTypeParameter
Properties_WithSingleParameter (0xA0)ContainerProperty_ComposedStream (0xC32)SetStreamParam_Enclosing
Get
SetGetStreamParam_Enclosing
StatusStreamParam_Enclosing
ErrorErrorCode, ErrorInfo

Parameter

StreamParam_Enclosing


Composed Stream parameter.

Basis data typeLengthDescription
StreamContent: UnsignedByteParam, StreamParam_EnclosedComposed

StreamParam_Enclosing.UnsignedByteParam


Unsigned Byte parameter.

Basis data typeUnitExp.Step
Unsigned Bytenone01

StreamParam_Enclosing.StreamParam_EnclosedComposed


Composed Stream parameter.

Basis data typeLengthConditionDescription
StreamUnsignedByteParam = 0x0...0xFContent: UnsignedLongLongParam
UnsignedByteParam = 0x10Content: UnsignedByteParam, UnsignedLongParam

StreamParam_EnclosedComposed.UnsignedLongLongParam


Unsigned Long parameter

Basis data typeUnitExp.Step
Unsigned Long Longnone01

StreamParam_EnclosedComposed.UnsignedByteParam


Unsigned Byte parameter.

Basis data typeUnitExp.Step
Unsigned Bytenone01

StreamParam_EnclosedComposed.UnsignedLongParam


Unsigned Long parameter

Basis data typeUnitExp.Step
Unsigned Longnone01

Properties_WithMultipleParameters (FBlockID = 0xA1)

Release:3.1.0.0
Date:2015-09-09+02:00
Author:WG FEF
Company:MOST Cooperation
Modifications
ChangeReason
Initial version

Contains example functions of property function classes with multiple parameters.

Function Overview
FktIDNameOccurrence
0xC00DynamicArrayPropertyOptional
0xC01LongArrayPropertyOptional
0xC02SequencePropertyOptional
0xC03CollectionPropertyOptional
0xC04CollectionProperty_ArrayTypeOptional
0xC05CollectionProperty_RecordTypeOptional
0xC14UnclassifiedProperty_WithStreamCasesOptional

DynamicArrayProperty (0xC00)

Occurrence: Optional

Example function for the property function class DynamicArray (where the record contains an Unsigned Byte, a Boolean and a String parameter).

Format of Function

Function class: DynamicArray of { Record of { Unsigned Word Unsigned Byte Boolean String } }

FBlockFunctionOPTypeParameter
Properties_WithMultipleParameters (0xA1)DynamicArrayProperty (0xC00)SetTag, PosY, ArrayParam_WithTaggedRecord
GetTag, PosY
SetGetTag, PosY, ArrayParam_WithTaggedRecord
IncrementTag, PosY, NSteps
DecrementTag, PosY, NSteps
StatusTag, PosY, ArrayParam_WithTaggedRecord
ErrorErrorCode, ErrorInfo

Parameter

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 typeUnitExp.Step
Unsigned Wordnone01

PosY


Column indicator for dynamic arrays.

Basis data typeUnitExp.Step
Unsigned Bytenone01

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 typeDescription
ArrayPosData
{ 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


Tag parameter for Dynamic Array and similar function classes like Long Array and Map. It is used to uniquely identify an entry.

Basis data typeUnitExp.Step
Unsigned Wordnone01

UnsignedByteParam


Unsigned Byte parameter.

Basis data typeUnitExp.Step
Unsigned Bytenone01

BooleanParam


One-bit Boolean parameter, can be either true or false.

Basis data type
Boolean

StringParam


A String parameter.

Basis data typeMaxSize
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 typeUnitExp.Step
Unsigned Bytenone01

LongArrayProperty (0xC01)

Occurrence: Optional

Example function for the property function classLongArray (where the record contains an Unsigned Byte, a Boolean and a String parameter).

Format of Function

Function class: LongArray of { Record of { Unsigned Word Unsigned Byte Boolean String } }

FBlockFunctionOPTypeParameter
Properties_WithMultipleParameters (0xA1)LongArrayProperty (0xC01)SetTag, PosY, ArrayParam_WithTaggedRecord
GetTag, PosY
SetGetTag, PosY, ArrayParam_WithTaggedRecord
IncrementTag, PosY, NSteps
DecrementTag, PosY, NSteps
StatusTag, PosY, CurrentSize, AbsolutePosition, ArrayParam_WithTaggedRecord
ErrorErrorCode, ErrorInfo

Parameter

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 typeUnitExp.Step
Unsigned Wordnone01

PosY


Column indicator for dynamic arrays.

Basis data typeUnitExp.Step
Unsigned Bytenone01

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 typeDescription
ArrayPosData
{ 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


Tag parameter for Dynamic Array and similar function classes like Long Array and Map. It is used to uniquely identify an entry.

Basis data typeUnitExp.Step
Unsigned Wordnone01

UnsignedByteParam


Unsigned Byte parameter.

Basis data typeUnitExp.Step
Unsigned Bytenone01

BooleanParam


One-bit Boolean parameter, can be either true or false.

Basis data type
Boolean

StringParam


A String parameter.

Basis data typeMaxSize
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 typeUnitExp.Step
Unsigned Bytenone01

CurrentSize


Basis data typeUnitExp.Step
Unsigned Wordnone01

AbsolutePosition


Basis data typeUnitExp.Step
Unsigned Wordnone01

SequenceProperty (0xC02)

Occurrence: Optional

Example function for the property function class Sequence (with a Signed Long and an Unsigned Word parameter).

Format of Function

Function class: Sequence Property

FBlockFunctionOPTypeParameter
Properties_WithMultipleParameters (0xA1)SequenceProperty (0xC02)SetSignedLongParam, UnsignedWordParam
Get
SetGetSignedLongParam, UnsignedWordParam
StatusSignedLongParam, UnsignedByteParam
ErrorErrorCode, ErrorInfo

Parameter

SignedLongParam


Signed Long parameter.

Basis data typeUnitExp.Step
Signed Longnone01

UnsignedWordParam


Unsigned Word parameter

Basis data typeUnitExp.Step
Unsigned Wordnone01

UnsignedByteParam


Unsigned Byte parameter.

Basis data typeUnitExp.Step
Unsigned Bytenone01

CollectionProperty (0xC03)

Occurrence: Optional

Example function for the property function class Collection with a nested structure.

Format of Function

Function class: Collection

FBlockFunctionOPTypeParameter
Properties_WithMultipleParameters (0xA1)CollectionProperty (0xC03)SetAccessPath, PersonList
GetAccessPath
SetGetAccessPath, PersonList
StatusAccessPath, PersonList
ErrorErrorCode, ErrorInfo

Parameter

AccessPath


Path selection parameter for Collection function class.

Basis data typeElementCount sizeMax. element countElement typeElement name
Array Type44Unsigned Long AccessPathEntry

AccessPathEntry


Basis data typeUnitExp.Step
Unsigned Longnone01

PersonList


An array representing a people directory with phone numbers and pictures.

Basis data typeElementCount sizeElement typeElement name
Array Type2Record Type Person

Person


Basis data typeDescription
Record TypeFirstName, LastName, PhoneNumberList, Picture

FirstName


First name.

Basis data typeMaxSize
Length-coded String

LastName


Last name.

Basis data typeMaxSize
Length-coded String

PhoneNumberList


An array of phone number records.

Basis data typeElementCount sizeElement typeElement name
Array Type1Record Type PhoneNumber

PhoneNumber


Basis data typeDescription
Record TypeEntryType, CountryCode, RegionCode, Number

EntryType


The type of phone number, for example, "Home", "Business", or "Mobile".

Basis data typeMaxSize
Length-coded String

CountryCode


The country code of a phone number.

Basis data typeUnitExp.Step
Unsigned Wordnone01

RegionCode


The region code of a phone number.

Basis data typeMaxSize
Length-coded String

Number


The actual phone number, typically without country code or region code.

Basis data typeMaxSize
Length-coded String

Picture


Basis data typeElementCount sizeElement typeElement name
Array Type4Unsigned Byte PictureByte

PictureByte


Basis data typeUnitExp.Step
Unsigned Bytenone01

CollectionProperty_ArrayType (0xC04)

Occurrence: Optional

Example function for the property function class Collection using a parameter of data type Array Type.

Format of Function

Function class: Unclassified Property

FBlockFunctionOPTypeParameter
Properties_WithMultipleParameters (0xA1)CollectionProperty_ArrayType (0xC04)SetAccessPath, ArrayTypeParam
GetAccessPath
SetGetAccessPath, ArrayTypeParam
StatusAccessPath, ArrayTypeParam
ErrorErrorCode, ErrorInfo

Parameter

AccessPath


Path selection parameter for Collection function class.

Basis data typeElementCount sizeMax. element countElement typeElement name
Array Type41Unsigned Long AccessPathEntry

AccessPathEntry


Basis data typeUnitExp.Step
Unsigned Longnone01

ArrayTypeParam


Array Type parameter with element count field size set to 2.

Basis data typeElementCount sizeElement typeElement name
Array Type2Unsigned Byte UnsignedByteParam

UnsignedByteParam


Unsigned Byte parameter.

Basis data typeUnitExp.Step
Unsigned Bytenone01

CollectionProperty_RecordType (0xC05)

Occurrence: Optional

Example function for the property function class Collection using a parameter of data type Array Type.

Format of Function

Function class: Unclassified Property

FBlockFunctionOPTypeParameter
Properties_WithMultipleParameters (0xA1)CollectionProperty_RecordType (0xC05)SetAccessPath, RecordTypeParam
GetAccessPath
SetGetAccessPath, RecordTypeParam
StatusAccessPath, RecordTypeParam
ErrorErrorCode, ErrorInfo

Parameter

AccessPath


Path selection parameter for Collection function class.

Basis data typeElementCount sizeMax. element countElement typeElement name
Array Type41Unsigned Long AccessPathEntry

AccessPathEntry


Basis data typeUnitExp.Step
Unsigned Longnone01

RecordTypeParam


Record Type parameter.

Basis data typeDescription
Record TypeUnsignedByteParam, DoubleParam, LengthCodedStringParam

UnsignedByteParam


Unsigned Byte parameter.

Basis data typeUnitExp.Step
Unsigned Bytenone01

DoubleParam


Unsigned Long parameter

Basis data typeUnit
Doublenone

LengthCodedStringParam


A String parameter.

Basis data typeMaxSize
Length-coded String

UnclassifiedProperty_WithStreamCases (0xC14)

Occurrence: Optional

Example function for the Unclassified Property function class.

Format of Function

Function class: Unclassified Property

FBlockFunctionOPTypeParameter
Properties_WithMultipleParameters (0xA1)UnclassifiedProperty_WithStreamCases (0xC14)GetUnsignedByteParameter
StatusDataType, DataDescription
ErrorErrorCode, ErrorInfo

Parameter

UnsignedByteParameter


Unsigned Byte parameter.

Basis data typeUnitExp.Step
Unsigned Bytenone01

DataType


An enumeration parameter used as a selector for streamcases.

Basis data typeCodeNameDescription
Enum
(1 byte)
0x0EnumCode0Description of code 0.
0x1EnumCode1Description of code 1.

DataDescription


A stream with stream cases.

Basis data typeLengthConditionDescription
Stream63DataType = 0x0Content: UnsignedByteParam, LengthCodedStringParam
DataType = 0x1Content: SignedByteParam

DataDescription.UnsignedByteParam


Unsigned Byte parameter.

Basis data typeUnitExp.Step
Unsigned Bytenone01

DataDescription.LengthCodedStringParam


A String parameter.

Basis data typeMaxSize
Length-coded String

DataDescription.SignedByteParam


Signed Byte parameter.

Basis data typeUnitExp.Step
Signed Bytenone01

Methods (FBlockID = 0xA2)

Release:3.1.0.0
Date:2015-09-09+02:00
Author:WG FEF
Company:MOST Cooperation
Modifications
ChangeReason
Initial version

Contains example functions of method function classes.

Function Overview
FktIDNameOccurrence
0xC00TriggerMethodOptional
0xC01SequenceMethodOptional
0xC02UnclassifiedMethodOptional

TriggerMethod (0xC00)

Occurrence: Optional

Example function for the method function class Trigger Method.

Format of Function

Function class: Trigger Method

FBlockFunctionOPTypeParameter
Methods (0xA2)TriggerMethod (0xC00)Start
StartResult
StartResultAckSenderHandle
ErrorAckSenderHandle, ErrorCode, ErrorInfo
ProcessingAckSenderHandle
Processing
Result
ResultAckSenderHandle
ErrorErrorCode, ErrorInfo

Parameter

SenderHandle


Characterizes the sender in more detail (task, process, ...).

Basis data typeUnitExp.Step
Unsigned Wordnone01

SequenceMethod (0xC01)

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.

Format of Function

Function class: Sequence Method

FBlockFunctionOPTypeParameter
Methods (0xA2)SequenceMethod (0xC01)StartSignedLongParam, UnsignedWordParam
StartResultAckSenderHandle, SignedLongParam, UnsignedWordParam
AbortAckSenderHandle
ErrorAckSenderHandle, ErrorCode, ErrorInfo
ProcessingAckSenderHandle
ResultAckSenderHandle, SignedLongParam
ErrorErrorCode, ErrorInfo

Parameter

SignedLongParam


Signed Long parameter.

Basis data typeUnitExp.Step
Signed Longnone01

UnsignedWordParam


Unsigned Word parameter

Basis data typeUnitExp.Step
Unsigned Wordnone01

SenderHandle


Characterizes the sender in more detail (task, process, ...).

Basis data typeUnitExp.Step
Unsigned Wordnone01

UnclassifiedMethod (0xC02)

Occurrence: Optional

An unclassified method is used when no other method function class matches the desired function signature.

Format of Function

Function class: Unclassified Method

FBlockFunctionOPTypeParameter
Methods (0xA2)UnclassifiedMethod (0xC02)StartResultAckSenderHandle, UnsignedByteParameter
Processing
ResultAckSenderHandle
ErrorSenderHandle

Parameter

SenderHandle


Characterizes the sender in more detail (task, process, ...).

Basis data typeUnitExp.Step
Unsigned Wordnone01

UnsignedByteParameter


Unsigned Byte parameter.

Basis data typeUnitExp.Step
Unsigned Bytenone01