Function Catalog

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

FBlock Overview
FBlockIDName
0xF0Additional_Properties_MultipeParameters
0xF1Additional_Properties_SingleParameter

Additional_Properties_MultipeParameters (FBlockID = 0xF0)

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

Contains additional example functions of multiple parameter function classes.

Function Overview
FktIDNameOccurrence
0xC00RecordPropertyOptional
0xC01RecordProperty_WithArrayOptional
0xC02ArrayPropertyOptional
0xC03ArrayProperty_WithRecordOptional
0xC04MapPropertyOptional
0xC05UnclassifiedProperty_WithStreamSignalsOptional
0xC06UnclassifiedProperty_WithShortStreamOptional
0xC07UnclassifiedProperty_WithNestedStreamsOptional

RecordProperty (0xC00)

Occurrence: Optional

Example function for the property function class Record (with an Unsigned Byte, a Boolean and a String element).

For this scenario, instead of using the Record function class, the Collection function class with a Record Type parameter could be used.

Format of Function

Function class: Record of { Unsigned Byte Boolean String }

FBlockFunctionOPTypeParameter
Additional_Properties_MultipeParameters (0xF0)RecordProperty (0xC00)SetPosition, RecordParam
GetPosition
SetGetPosition, RecordParam
IncrementPosition, NSteps
DecrementPosition, NSteps
StatusPosition, RecordParam
ErrorErrorCode, ErrorInfo

Parameter

Position


Position description for a record or an array.

Basis data typeUnitExp.Step
Unsigned Wordnone01

RecordParam


Example record with an Unsigned Byte, a Boolean and a String parameter.

Basis data typeDescription
RecordPosData
{ x=0 }UnsignedByteParam, BooleanParam, StringParam

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

RecordProperty_WithArray (0xC01)

Occurrence: Optional

Example function for the property function class Record of Array(with an Unsigned Byte, a Boolean, a String element, and an array of Signed Word elements).

For this scenario, instead of using the Record function class, the Collection function class with a Record Type parameter that contains an Array Type parameter could be used.

Format of Function

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

FBlockFunctionOPTypeParameter
Additional_Properties_MultipeParameters (0xF0)RecordProperty_WithArray (0xC01)SetPosition, LegacyRecordParam_WithArray
GetPosition
SetGetPosition, LegacyRecordParam_WithArray
IncrementPosition, NSteps
DecrementPosition, NSteps
StatusPosition, LegacyRecordParam_WithArray
ErrorErrorCode, ErrorInfo

Parameter

Position


Position description for a record or an array.

Basis data typeUnitExp.Step
Unsigned Wordnone01

LegacyRecordParam_WithArray


Example of a record with an array parameter (an unsigned byte, a boolean, a string parameter, and an array of signed word).

Basis data typeDescription
RecordPosData
{ x=0 }UnsignedByteParam, BooleanParam, StringParam, ArrayParam_SignedWord

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

ArrayParam_SignedWord


An array of Signed Word parameters.

Basis data typeElement typeElement name
ArraySigned Word SignedWordParam

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

ArrayProperty (0xC02)

Occurrence: Optional

Example function for the property function class Array (with Signed Word elements).

For this scenario, instead of using the Array function class, the Collection function class with an Array Type parameter could be used.

Format of Function

Function class: Array of { Signed Word }

FBlockFunctionOPTypeParameter
Additional_Properties_MultipeParameters (0xF0)ArrayProperty (0xC02)SetPosition, ArrayParam_SignedWord
GetPosition
SetGetPosition, ArrayParam_SignedWord
IncrementPosition, NSteps
DecrementPosition, NSteps
StatusPosition, ArrayParam_SignedWord
ErrorErrorCode, ErrorInfo

Parameter

Position


Position description for a record or an array.

Basis data typeUnitExp.Step
Unsigned Wordnone01

ArrayParam_SignedWord


An array of Signed Word parameters.

Basis data typeDescription
ArrayPosData
{ x=0 }SignedWordParam[1], SignedWordParam[2],..., SignedWordParam[NMax]
{ x>0 }SignedWordParam[x]

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

ArrayProperty_WithRecord (0xC03)

Occurrence: Optional

Example function for the property function class Array with a record as parameter (an Unsigned Byte, a Boolean and a String parameter).

For this scenario, instead of using the Array function class, the Collection function class with an Array Type parameter that contains Record Type elements could be used. Also, the String parameter could be replaced with a Length-coded String parameter so that it does not have to be parsed for the terminating character.

Format of Function

Function class: Array of { Record of { Unsigned Byte Boolean String } }

FBlockFunctionOPTypeParameter
Additional_Properties_MultipeParameters (0xF0)ArrayProperty_WithRecord (0xC03)SetPosition, ArrayParam_RecordElements
GetPosition
SetGetPosition, ArrayParam_RecordElements
IncrementPosition, NSteps
DecrementPosition, NSteps
StatusPosition, ArrayParam_RecordElements
ErrorErrorCode, ErrorInfo

Parameter

Position


Position description for a record or an array.

Basis data typeUnitExp.Step
Unsigned Wordnone01

ArrayParam_RecordElements


An array of records (an Unsigned Byte, a Boolean and a String parameter).

Basis data typeDescription
ArrayPosData
{ x=0, y=0 }UnsignedByteParam[1], BooleanParam[1], StringParam[1],..., UnsignedByteParam[NMax], BooleanParam[NMax], StringParam[NMax]
{ x>0, y=0 }UnsignedByteParam[x], BooleanParam[x], StringParam[x]
{ x>0, y=1 }UnsignedByteParam[x]
{ x>0, y=2 }BooleanParam[x]
{ x>0, y=3 }StringParam[x]

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

MapProperty (0xC04)

Occurrence: Optional

Example function for the property function class Map.

For this scenario, instead of using the Map function class, the Collection function class with a combination of Array Type and Record Type parameters could be used.

Format of Function

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

FBlockFunctionOPTypeParameter
Additional_Properties_MultipeParameters (0xF0)MapProperty (0xC04)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

UnclassifiedProperty_WithStreamSignals (0xC05)

Occurrence: Optional

Example function for the Unclassified Property function class with stream signals.

For this scenario, instead of using an Unclassified Property with stream signals, the Number function class with a bit-encoded Integer parameter could be used.

Format of Function

Function class: Unclassified Property

FBlockFunctionOPTypeParameter
Additional_Properties_MultipeParameters (0xF0)UnclassifiedProperty_WithStreamSignals (0xC05)Get
StatusStreamParam_WithSignals
ErrorErrorCode, ErrorInfo

Parameter

StreamParam_WithSignals


A Stream parameter with three signals.

Basis data typeLengthDescription
Stream2Stream signals: Signal3Bit, Signal3Bit, Signal4Bit
Signal3Bit, Signal3Bit, Signal4Bit

Stream Signals

Signal NameBit positionSignednessNumber of bitsDescription
Signal3Bit0Unsigned3A signal with three bits.
Signal3Bit3Unsigned3A signal with three bits.
Signal4Bit6Unsigned4A signal with four bits.

UnclassifiedProperty_WithShortStream (0xC06)

Occurrence: Optional

Example function for the Unclassified Property function class.

For this scenario, instead of using the Short Stream parameter, an Array Type parameter could be used.

Format of Function

Function class: Unclassified Property

FBlockFunctionOPTypeParameter
Additional_Properties_MultipeParameters (0xF0)UnclassifiedProperty_WithShortStream (0xC06)Get
StatusShortStreamParam
ErrorErrorCode, ErrorInfo

Parameter

ShortStreamParam


Simple Short Stream parameter.

Basis data typeMax. LengthDescription
Short Stream255

UnclassifiedProperty_WithNestedStreams (0xC07)

Occurrence: Optional

Example function for function class Unclassified Property that uses nested streams. The inner Stream is "simple", that is, it does not depend on a Stream selector.

For this scenario, instead of using the simple Stream parameter, an Array Type parameter could be used.

Format of Function

Function class: Unclassified Property

FBlockFunctionOPTypeParameter
Additional_Properties_MultipeParameters (0xF0)UnclassifiedProperty_WithNestedStreams (0xC07)SetUnsignedByteParam_Selector, StreamParam_Composed
Get
SetGetUnsignedByteParam_Selector, StreamParam_Composed
StatusUnsignedByteParam_Selector, StreamParam_Composed
ErrorErrorCode, ErrorInfo

Parameter

UnsignedByteParam_Selector


Unsigned Byte parameter.

Basis data typeUnitExp.Step
Unsigned Bytenone01

StreamParam_Composed


"Composed" Stream parameter, that is, a Stream parameter with stream cases.

Basis data typeLengthConditionDescription
StreamUnsignedByteParam_Selector = 0x0
UnsignedByteParam_Selector = 0x1Content: StreamParam_EnclosedSimple

StreamParam_Composed.StreamParam_EnclosedSimple


Simple Stream parameter.

Basis data typeLengthDescription
StreamContent: UnsignedByteParam

StreamParam_EnclosedSimple.UnsignedByteParam


Unsigned Byte parameter.

Basis data typeUnitExp.Step
Unsigned Bytenone01

Additional_Properties_SingleParameter (FBlockID = 0xF1)

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

Contains additional example functions of single parameter function classes.

Function Overview
FktIDNameOccurrence
0xC00BitSetPropertyWordOptional
0xC01BoolFieldProperty_UnsignedWordOptional
0xC03TextProperty_StringOptional
0xC30ContainerProperty_ClassifiedStreamOptional
0xC31ContainerProperty_ShortStreamOptional
0xC32ContainerProperty_SimpleStreamOptional

BitSetPropertyWord (0xC00)

Occurrence: Optional

Example function for the property function class BitSet with a two Byte BitField.

For this scenario, instead of using the BitSet function class, the Number function class with a bit-oriented Integer representation or the Collection function class with a Record Type parameter could be used.

Format of Function

Function class: BitSet

FBlockFunctionOPTypeParameter
Additional_Properties_SingleParameter (0xF1)BitSetPropertyWord (0xC00)SetBitSetParameter_Word
Get
SetGetBitSetParameter_Word
StatusBitSetParameter_Word
ErrorErrorCode, ErrorInfo

Parameter

BitSetParameter_Word


BitSet parameter. Can contain eight bits of information at maximum. The other eight bits are reserved for the Mask

Basis data typeNamePosition (Bit)Length (Bit)ValueDescription
BitField
Size: 2
002Falsefct0_off
Truefct0_on
112Falsefct1_off
Truefct1_on
222Falsefct2_off
Truefct2_on
332Falsefct3_off
Truefct3_on
442Falsefct4_off
Truefct4_on
552Falsefct5_off
Truefct5_on
662Falsefct6_off
Truefct6_on
772Falsefct7_off
Truefct7_on

BoolFieldProperty_UnsignedWord (0xC01)

Occurrence: Optional

Example function for the property function class BoolField with a parameter of type Unsigned Word.

For this scenario, instead of using the BoolField function class, the Number function class with could be used with the same parameter.

Format of Function

Function class: BoolField

FBlockFunctionOPTypeParameter
Additional_Properties_SingleParameter (0xF1)BoolFieldProperty_UnsignedWord (0xC01)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.

TextProperty_String (0xC03)

Occurrence: Optional

Example function for the property function class Text with a String param.

The use of function class Text in conjunction with data type String requires parsing of the string to determine the length. Using function class with a Length-coded String parameter avoids this.

Format of Function

Function class: Text

FBlockFunctionOPTypeParameter
Additional_Properties_SingleParameter (0xF1)TextProperty_String (0xC03)SetStringParam
Get
SetGetStringParam
StatusStringParam
ErrorErrorCode, ErrorInfo

Parameter

StringParam


A String parameter.

Basis data typeMaxSize
String

ContainerProperty_ClassifiedStream (0xC30)

Occurrence: Optional

Example function for the Container function class.

For this scenario, instead of using the Container function class, the Collection function class with a Record Type parameter and Array Type parameters could be used.

Format of Function

Function class: Unclassified Property

FBlockFunctionOPTypeParameter
Additional_Properties_SingleParameter (0xF1)ContainerProperty_ClassifiedStream (0xC30)Get
StatusClassifiedStreamParam
ErrorErrorCode, ErrorInfo

Parameter

ClassifiedStreamParam


Classified Stream parameter.

Basis data typeLengthMedia type
Classified Stream

ContainerProperty_ShortStream (0xC31)

Occurrence: Optional

Example function for the property function class Container.

For this scenario, instead of using the Container function class, the Collection function class with an Array Type parameter could be used.

Format of Function

Function class: Container

FBlockFunctionOPTypeParameter
Additional_Properties_SingleParameter (0xF1)ContainerProperty_ShortStream (0xC31)SetShortStreamParam
Get
SetGetShortStreamParam
StatusShortStreamParam
ErrorErrorCode, ErrorInfo

Parameter

ShortStreamParam


Short Stream parameter.

Basis data typeMax. LengthDescription
Short Stream

ContainerProperty_SimpleStream (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.

For this scenario, instead of using the Container function class, the Collection function class with an Array Type parameter could be used.

Format of Function

Function class: Container

FBlockFunctionOPTypeParameter
Additional_Properties_SingleParameter (0xF1)ContainerProperty_SimpleStream (0xC32)SetStreamParam_WithRepetition
Get
SetGetStreamParam_WithRepetition
StatusStreamParam_WithRepetition
ErrorErrorCode, ErrorInfo

Parameter

StreamParam_WithRepetition


Simple (i.e., not composed) Stream parameter with parameter repetition.

Basis data typeLengthDescription
StreamContent: {UnsignedByteParam, UnsignedLongParam}[repeated]

StreamParam_WithRepetition.UnsignedByteParam


Unsigned Byte parameter.

Basis data typeUnitExp.Step
Unsigned Bytenone01

StreamParam_WithRepetition.UnsignedLongParam


Unsigned Long parameter

Basis data typeUnitExp.Step
Unsigned Longnone01