/AWS1/CL_IOSPROPERTY¶
Contains asset property information.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_id TYPE /AWS1/IOSID /AWS1/IOSID¶
The ID of the asset property.
iv_name TYPE /AWS1/IOSNAME /AWS1/IOSNAME¶
The name of the property.
iv_datatype TYPE /AWS1/IOSPROPERTYDATATYPE /AWS1/IOSPROPERTYDATATYPE¶
The property data type.
Optional arguments:¶
iv_externalid TYPE /AWS1/IOSEXTERNALID /AWS1/IOSEXTERNALID¶
The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
iv_alias TYPE /AWS1/IOSPROPERTYALIAS /AWS1/IOSPROPERTYALIAS¶
The alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
io_notification TYPE REF TO /AWS1/CL_IOSPROPERTYNOTIF /AWS1/CL_IOSPROPERTYNOTIF¶
The asset property's notification topic and state. For more information, see UpdateAssetProperty.
iv_unit TYPE /AWS1/IOSPROPERTYUNIT /AWS1/IOSPROPERTYUNIT¶
The unit (such as
NewtonsorRPM) of the asset property.
io_type TYPE REF TO /AWS1/CL_IOSPROPERTYTYPE /AWS1/CL_IOSPROPERTYTYPE¶
The property type (see
PropertyType). A property contains one type.
it_path TYPE /AWS1/CL_IOSASTPRPPATHSEGMENT=>TT_ASSETPROPERTYPATH TT_ASSETPROPERTYPATH¶
The structured path to the property from the root of the asset.
Queryable Attributes¶
id¶
The ID of the asset property.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
externalId¶
The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXTERNALID() |
Getter for EXTERNALID, with configurable default |
ASK_EXTERNALID() |
Getter for EXTERNALID w/ exceptions if field has no value |
HAS_EXTERNALID() |
Determine if EXTERNALID has a value |
name¶
The name of the property.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
alias¶
The alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ALIAS() |
Getter for ALIAS, with configurable default |
ASK_ALIAS() |
Getter for ALIAS w/ exceptions if field has no value |
HAS_ALIAS() |
Determine if ALIAS has a value |
notification¶
The asset property's notification topic and state. For more information, see UpdateAssetProperty.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NOTIFICATION() |
Getter for NOTIFICATION |
dataType¶
The property data type.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATATYPE() |
Getter for DATATYPE, with configurable default |
ASK_DATATYPE() |
Getter for DATATYPE w/ exceptions if field has no value |
HAS_DATATYPE() |
Determine if DATATYPE has a value |
unit¶
The unit (such as
NewtonsorRPM) of the asset property.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UNIT() |
Getter for UNIT, with configurable default |
ASK_UNIT() |
Getter for UNIT w/ exceptions if field has no value |
HAS_UNIT() |
Determine if UNIT has a value |
type¶
The property type (see
PropertyType). A property contains one type.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE |
path¶
The structured path to the property from the root of the asset.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PATH() |
Getter for PATH, with configurable default |
ASK_PATH() |
Getter for PATH w/ exceptions if field has no value |
HAS_PATH() |
Determine if PATH has a value |