Extensions.ExternalServiceProvider.PropertyFlag

From emotive
Revision as of 11:27, 12 November 2019 by Nb (talk | contribs) (Created by Ngoc Tran.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Classification

Name PropertyFlag
Short Description Characteristics of values that access rights used in the ServiceProviderSignatures Properties
Class Simple Data Type
Base Data Type SimpleType
Default Value READ-ONLY
Provide a Literal Yes
SpecifiedBy ISO 13209-4
Standard Compliant Yes

Description

PropertyFlag is an enumeration type describing access rights used in the ServiceProviderSignatures Properties.

The list of allowed enumeration values is defined as follows:

Value Literal Description
READ-ONLY @PropertyFlag:READ-ONLY The property value, defined in PropertySignature, is read only. This is the default access right if the <init> of the PropertyFlag variable is not defined.
WRITE-ONLY @PropertyFlag:WRITE-ONLY The property value, defined in PropertySignature, is only writable.
READ-WRITE @PropertyFlag:READ-WRITE The property value, defined in PropertySignature, is readable as well writable.

Order Relation

PropertyFlag values may occur as operands of comparisons (cf. Part 2 of ISO 13209, relational operations). For this case, the following order relation will apply:

READ-ONLY < WRITE-ONLY < READ-WRITE

Literal

The syntax for Literals for complex data types will be used, where the member value is one of the values in the list.

@PropertyFlag:READ-ONLY|WRITE-ONLY|READ-WRITE

This optional element sets the hard-coded initialisation value of the identifier at declaration time.
This attribute shall contain one of the values defined in the ComChannelStates enumeration.

Exclamation.png Important: If the ComChannelState declaration is not explicitly initialized (omitted <init> element), the default value shall be OFFLINE.

Core Conversion

The following table shows the rules for conversion to another data type:

Conversion Result Sample
ToBoolean Undefined (should not be used)
ToInteger Returns the index of the value in the ComChannelStates enumeration (smallest index is 0) Integer val = ToInteger(@ComChannelState:COMMUNICATION); // Returns 0
ToFloat Undefined (should not be used)
ToString Returns the name of the enumeration value String s = ToString(@ComChannelState:OFFLINE); // Returns "OFFLINE"
ToByteField Undefined (should not be used)

Sample

DiagComPlus.ComChannelState ComChannelState1 = @ComChannelState:COMMUNICATION;