Release: | 3.1.0.0 |
Date: | 2015-09-09+02:00 |
Author: | WG FEF |
Company: | MOST Cooperation |
Modifications | |
---|---|
Change | Reason |
FBlock Overview | |
---|---|
FBlockID | Name |
0xF0 | Additional_Properties_MultipeParameters |
0xF1 | Additional_Properties_SingleParameter |
Release: | 3.1.0.0 |
Date: | 2015-09-09+02:00 |
Author: | WG FEF |
Company: | MOST Cooperation |
Modifications | |
---|---|
Change | Reason |
Initial version |
Contains additional example functions of multiple parameter function classes.
Function Overview | ||
---|---|---|
FktID | Name | Occurrence |
0xC00 | RecordProperty | Optional |
0xC01 | RecordProperty_WithArray | Optional |
0xC02 | ArrayProperty | Optional |
0xC03 | ArrayProperty_WithRecord | Optional |
0xC04 | MapProperty | Optional |
0xC05 | UnclassifiedProperty_WithStreamSignals | Optional |
0xC06 | UnclassifiedProperty_WithShortStream | Optional |
0xC07 | UnclassifiedProperty_WithNestedStreams | Optional |
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.
Function class: Record of { Unsigned Byte Boolean String }
FBlock | Function | OPType | Parameter |
---|---|---|---|
Additional_Properties_MultipeParameters (0xF0) | RecordProperty (0xC00) | Set | Position, RecordParam |
Get | Position | ||
SetGet | Position, RecordParam | ||
Increment | Position, NSteps | ||
Decrement | Position, NSteps | ||
Status | Position, RecordParam | ||
Error | ErrorCode, ErrorInfo |
Position
Position description for a record or an array.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
RecordParam
Example record with an Unsigned Byte, a Boolean and a String parameter.
Basis data type | Description | |
---|---|---|
Record | Pos | Data |
{ x=0 } | UnsignedByteParam, BooleanParam, StringParam |
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 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.
Function class: Record of { Unsigned Byte Boolean String Array of { Signed Word } }
FBlock | Function | OPType | Parameter |
---|---|---|---|
Additional_Properties_MultipeParameters (0xF0) | RecordProperty_WithArray (0xC01) | Set | Position, LegacyRecordParam_WithArray |
Get | Position | ||
SetGet | Position, LegacyRecordParam_WithArray | ||
Increment | Position, NSteps | ||
Decrement | Position, NSteps | ||
Status | Position, LegacyRecordParam_WithArray | ||
Error | ErrorCode, ErrorInfo |
Position
Position description for a record or an array.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
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 type | Description | |
---|---|---|
Record | Pos | Data |
{ x=0 } | UnsignedByteParam, BooleanParam, StringParam, ArrayParam_SignedWord |
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 |
An array of Signed Word parameters.
Basis data type | Element type | Element name |
---|---|---|
Array | Signed Word | 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 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.
Function class: Array of { Signed Word }
FBlock | Function | OPType | Parameter |
---|---|---|---|
Additional_Properties_MultipeParameters (0xF0) | ArrayProperty (0xC02) | Set | Position, ArrayParam_SignedWord |
Get | Position | ||
SetGet | Position, ArrayParam_SignedWord | ||
Increment | Position, NSteps | ||
Decrement | Position, NSteps | ||
Status | Position, ArrayParam_SignedWord | ||
Error | ErrorCode, ErrorInfo |
Position
Position description for a record or an array.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
ArrayParam_SignedWord
An array of Signed Word parameters.
Basis data type | Description | |
---|---|---|
Array | Pos | Data |
{ x=0 } | SignedWordParam[1], SignedWordParam[2],..., SignedWordParam[NMax] | |
{ x>0 } | SignedWordParam[x] |
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 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.
Function class: Array of { Record of { Unsigned Byte Boolean String } }
FBlock | Function | OPType | Parameter |
---|---|---|---|
Additional_Properties_MultipeParameters (0xF0) | ArrayProperty_WithRecord (0xC03) | Set | Position, ArrayParam_RecordElements |
Get | Position | ||
SetGet | Position, ArrayParam_RecordElements | ||
Increment | Position, NSteps | ||
Decrement | Position, NSteps | ||
Status | Position, ArrayParam_RecordElements | ||
Error | ErrorCode, ErrorInfo |
Position
Position description for a record or an array.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Word | none | 0 | 1 |
ArrayParam_RecordElements
An array of records (an Unsigned Byte, a Boolean and a String parameter).
Basis data type | Description | |
---|---|---|
Array | Pos | Data |
{ 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] |
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 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.
Function class: Map of { Record of { Unsigned Word Unsigned Byte Boolean String } }
FBlock | Function | OPType | Parameter |
---|---|---|---|
Additional_Properties_MultipeParameters (0xF0) | MapProperty (0xC04) | 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 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.
Function class: Unclassified Property
FBlock | Function | OPType | Parameter |
---|---|---|---|
Additional_Properties_MultipeParameters (0xF0) | UnclassifiedProperty_WithStreamSignals (0xC05) | Get | |
Status | StreamParam_WithSignals | ||
Error | ErrorCode, ErrorInfo |
StreamParam_WithSignals
A Stream parameter with three signals.
Basis data type | Length | Description |
---|---|---|
Stream | 2 | Stream signals: Signal3Bit, Signal3Bit, Signal4Bit Signal3Bit, Signal3Bit, Signal4Bit |
Stream Signals
Signal Name | Bit position | Signedness | Number of bits | Description |
---|---|---|---|---|
Signal3Bit | 0 | Unsigned | 3 | A signal with three bits. |
Signal3Bit | 3 | Unsigned | 3 | A signal with three bits. |
Signal4Bit | 6 | Unsigned | 4 | A signal with four bits. |
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.
Function class: Unclassified Property
FBlock | Function | OPType | Parameter |
---|---|---|---|
Additional_Properties_MultipeParameters (0xF0) | UnclassifiedProperty_WithShortStream (0xC06) | Get | |
Status | ShortStreamParam | ||
Error | ErrorCode, ErrorInfo |
ShortStreamParam
Simple Short Stream parameter.
Basis data type | Max. Length | Description |
---|---|---|
Short Stream | 255 |
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.
Function class: Unclassified Property
FBlock | Function | OPType | Parameter |
---|---|---|---|
Additional_Properties_MultipeParameters (0xF0) | UnclassifiedProperty_WithNestedStreams (0xC07) | Set | UnsignedByteParam_Selector, StreamParam_Composed |
Get | |||
SetGet | UnsignedByteParam_Selector, StreamParam_Composed | ||
Status | UnsignedByteParam_Selector, StreamParam_Composed | ||
Error | ErrorCode, ErrorInfo |
UnsignedByteParam_Selector
Unsigned Byte parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
StreamParam_Composed
"Composed" Stream parameter, that is, a Stream parameter with stream cases.
Basis data type | Length | Condition | Description |
---|---|---|---|
Stream | UnsignedByteParam_Selector = 0x0 | ||
UnsignedByteParam_Selector = 0x1 | Content: StreamParam_EnclosedSimple
|
StreamParam_Composed.StreamParam_EnclosedSimple
Simple Stream parameter.
Basis data type | Length | Description |
---|---|---|
Stream | Content: UnsignedByteParam
|
StreamParam_EnclosedSimple.UnsignedByteParam
Unsigned Byte parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
Release: | 3.1.0.0 |
Date: | 2015-09-09+02:00 |
Author: | WG FEF |
Company: | MOST Cooperation |
Modifications | |
---|---|
Change | Reason |
Initial version |
Contains additional example functions of single parameter function classes.
Function Overview | ||
---|---|---|
FktID | Name | Occurrence |
0xC00 | BitSetPropertyWord | Optional |
0xC01 | BoolFieldProperty_UnsignedWord | Optional |
0xC03 | TextProperty_String | Optional |
0xC30 | ContainerProperty_ClassifiedStream | Optional |
0xC31 | ContainerProperty_ShortStream | Optional |
0xC32 | ContainerProperty_SimpleStream | Optional |
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.
Function class: BitSet
FBlock | Function | OPType | Parameter |
---|---|---|---|
Additional_Properties_SingleParameter (0xF1) | BitSetPropertyWord (0xC00) | Set | BitSetParameter_Word |
Get | |||
SetGet | BitSetParameter_Word | ||
Status | BitSetParameter_Word | ||
Error | ErrorCode, ErrorInfo |
BitSetParameter_Word
BitSet parameter. Can contain eight bits of information at maximum. The other eight bits are reserved for the Mask
Basis data type | Name | Position (Bit) | Length (Bit) | Value | Description |
---|---|---|---|---|---|
BitField Size: 2 | 0 | 0 | 2 | False | fct0_off |
True | fct0_on | ||||
1 | 1 | 2 | False | fct1_off | |
True | fct1_on | ||||
2 | 2 | 2 | False | fct2_off | |
True | fct2_on | ||||
3 | 3 | 2 | False | fct3_off | |
True | fct3_on | ||||
4 | 4 | 2 | False | fct4_off | |
True | fct4_on | ||||
5 | 5 | 2 | False | fct5_off | |
True | fct5_on | ||||
6 | 6 | 2 | False | fct6_off | |
True | fct6_on | ||||
7 | 7 | 2 | False | fct7_off | |
True | fct7_on |
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.
Function class: BoolField
FBlock | Function | OPType | Parameter |
---|---|---|---|
Additional_Properties_SingleParameter (0xF1) | BoolFieldProperty_UnsignedWord (0xC01) | 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 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.
Function class: Text
FBlock | Function | OPType | Parameter |
---|---|---|---|
Additional_Properties_SingleParameter (0xF1) | TextProperty_String (0xC03) | Set | StringParam |
Get | |||
SetGet | StringParam | ||
Status | StringParam | ||
Error | ErrorCode, ErrorInfo |
StringParam
A String parameter.
Basis data type | MaxSize |
---|---|
String |
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.
Function class: Unclassified Property
FBlock | Function | OPType | Parameter |
---|---|---|---|
Additional_Properties_SingleParameter (0xF1) | ContainerProperty_ClassifiedStream (0xC30) | Get | |
Status | ClassifiedStreamParam | ||
Error | ErrorCode, ErrorInfo |
ClassifiedStreamParam
Classified Stream parameter.
Basis data type | Length | Media type |
---|---|---|
Classified Stream |
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.
Function class: Container
FBlock | Function | OPType | Parameter |
---|---|---|---|
Additional_Properties_SingleParameter (0xF1) | ContainerProperty_ShortStream (0xC31) | Set | ShortStreamParam |
Get | |||
SetGet | ShortStreamParam | ||
Status | ShortStreamParam | ||
Error | ErrorCode, ErrorInfo |
ShortStreamParam
Short Stream parameter.
Basis data type | Max. Length | Description |
---|---|---|
Short Stream |
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.
Function class: Container
FBlock | Function | OPType | Parameter |
---|---|---|---|
Additional_Properties_SingleParameter (0xF1) | ContainerProperty_SimpleStream (0xC32) | Set | StreamParam_WithRepetition |
Get | |||
SetGet | StreamParam_WithRepetition | ||
Status | StreamParam_WithRepetition | ||
Error | ErrorCode, ErrorInfo |
StreamParam_WithRepetition
Simple (i.e., not composed) Stream parameter with parameter repetition.
Basis data type | Length | Description |
---|---|---|
Stream | Content: {UnsignedByteParam, UnsignedLongParam}[repeated] |
StreamParam_WithRepetition.UnsignedByteParam
Unsigned Byte parameter.
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Byte | none | 0 | 1 |
StreamParam_WithRepetition.UnsignedLongParam
Unsigned Long parameter
Basis data type | Unit | Exp. | Step |
---|---|---|---|
Unsigned Long | none | 0 | 1 |