Attribute Accessor

Description

Access sub-data of the argument.

Accessor on Scalar<Event>

Scalar<Event>::Value             : Scalar<Number>
Scalar<Event>::DeviceId          : Scalar<Text>
Scalar<Event>::DeviceName        : Scalar<Text>
Scalar<Event>::Timestamp         : Scalar<Time>
Scalar<Event>::ForecastTimestamp : Scalar<Time>

Returns

Returns the event value, device id, device name, timestamp or forecast timestamp.

Remark: if there is no forecast timestamp, "0" is returned

Examples

Get the value of the event stored in the PowerConsumption Variable.

$PowerConsumption::Value
$PowerConsumption::Timestamp

---

Accessor on Vector<any>

Vector<any>::First : Scalar<any>
Vector<any>::Last  : Scalar<any>

Returns

Returns the first or last element of the Vector as Scalar<any>

Examples

Get the first Event from the $PowerGeneration vector.

$PowerConsumption::First

---

Accessor on Vector<Event>

Vector<Event>::Value             : Vector<Number>
Vector<Event>::DeviceId          : Vector<Text>
Vector<Event>::DeviceName        : Vector<Text>
Vector<Event>::Timestamp         : Vector<Time>
Vector<Event>::ForecastTimestamp : Vector<Time>

Returns

Returns the set of event values, device ids, device names, timestamps or forecast timestamps.

Remark: if there is no forecast timestamp, "0" is returned

Examples

Get the values of all events in the vector $PowerConsumption as new Vector<Number>

$PowerConsumption::Value

---

Accessor on GroupedScalar<any, Event>

GroupedScalar<any, Event>::Value             : Vector<Number>
GroupedScalar<any, Event>::DeviceId          : Vector<Text>
GroupedScalar<any, Event>::DeviceName        : Vector<Text>
GroupedScalar<any, Event>::Timestamp         : Vector<Time>
GroupedScalar<any, Event>::ForecastTimestamp : Vector<Time>

Returns

Returns the set of event values, device ids, device names, timestamps or forecast timestamps, grouped by device or time spans.

Examples

Get the values of all events in the group $PowerConsumption as new Vector<Number>

GROUP_BY_DEVICE($PowerConsumption)::Value

---

Accessor on GroupedScalar<Device, any>

GroupedScalar<Device, any>::GroupKeyDeviceId   : Vector<Text>
GroupedScalar<Device, any>::GroupKeyDeviceName : Vector<Text>

Returns

Returns the device id or name of the device which is part of the GroupedScalar key.

Examples

Get all device names from all the devices in the $PowerConsumption group.

GROUP_BY_DEVICE($PowerConsumption)::GroupKeyDeviceName

---

Accessor on GroupedScalar<any, any>

GroupedScalar<any, any>::GroupKeyValue : Vector<any>

Returns

Returns the value of the group as new Vector<any>.

Examples

Get all Values from the $PowerConsumption group.

GROUP_BY_DEVICE($PowerConsumption)::GroupValue

---

Accessor on GroupedVector<any, any>

GroupedVector<any, any>::First : GroupedScalar<any, any>
GroupedVector<any, any>::Last  : GroupedScalar<any, any>

Returns

Returns a GroupedScalar, which holds the first or last value of each group.

Examples

Get all Values from the $PowerConsumption group.

GROUP_BY_DEVICE($PowerConsumption)::First

---

Accessor on GroupedVector<any, Event>

GroupedVector<any, Event>::Value             : GroupedVector<Number>
GroupedVector<any, Event>::DeviceId          : GroupedVector<Text>
GroupedVector<any, Event>::DeviceName        : GroupedVector<Text>
GroupedVector<any, Event>::Timestamp         : GroupedVector<Time>
GroupedVector<any, Event>::ForecastTimestamp : GroupedVector<Time>

Returns

Returns the values, device ids, device names, timestamps or forecast timestamps of all events in the group and return as new GroupedVector<Number>.

Examples

Get the values of all events in the group $PowerConsumption as new Vector<Number>

GROUP_BY_DEVICE($PowerConsumption)::Value

---

Accessor on GroupedVector<Device, any>

GroupedVector<Device, any>::GroupKeyDeviceId   : Vector<Text>
GroupedVector<Device, any>::GroupKeyDeviceName : Vector<Text>

Returns

Returns the device ids or device names of all devices which are the groups key, and return as new Vector<Text>.

Examples

Get all device names from all the devices in the $PowerConsumption group.

GROUP_BY_DEVICE($PowerConsumption)::GroupKeyDeviceName