# Attribute Accessor ### Description Access sub-data of the argument. ### Accessor on Scalar\ ```java Scalar::Value : Scalar Scalar::DeviceId : Scalar Scalar::DeviceName : Scalar Scalar::Timestamp : Scalar Scalar::ForecastTimestamp : Scalar ``` #### 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. ```java $PowerConsumption::Value $PowerConsumption::Timestamp ``` *** ### Accessor on Vector\

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

#### Returns Returns the first or last element of the Vector as Scalar\ #### Examples Get the first Event from the $PowerGeneration vector. ```java $PowerConsumption::First ``` *** ### Accessor on Vector\

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\ ```java $PowerConsumption::Value ``` *** ### Accessor on GroupedScalar\

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\ ```java GROUP_BY_DEVICE($PowerConsumption)::Value ``` *** ### Accessor on GroupedScalar\

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. ```java GROUP_BY_DEVICE($PowerConsumption)::GroupKeyDeviceName ``` *** ### Accessor on GroupedScalar\

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

#### Returns Returns the value of the group as new Vector\. #### Examples Get all Values from the $PowerConsumption group. ```java GROUP_BY_DEVICE($PowerConsumption)::GroupValue ``` *** ### Accessor on GroupedVector\

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. ```java GROUP_BY_DEVICE($PowerConsumption)::First ``` *** ### Accessor on GroupedVector\

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\. #### Examples Get the values of all events in the group $PowerConsumption as new Vector\ ```java GROUP_BY_DEVICE($PowerConsumption)::Value ``` *** ### Accessor on GroupedVector\ ```java GroupedVector::GroupKeyDeviceId : Vector GroupedVector::GroupKeyDeviceName : Vector ``` #### Returns Returns the device ids or device names of all devices which are the groups key, and return as new Vector\. #### Examples Get all device names from all the devices in the $PowerConsumption group. ```java GROUP_BY_DEVICE($PowerConsumption)::GroupKeyDeviceName ``` *** ### Accessor on Scalar\ ```java Building::Id Building::RegistrationTimestamp Building::ActivationTimestamp Building::DaysSinceActivation Building::DeviceTypes Building::EconomicalMotivationScore Building::EcologicalMotivationScore Building::SelfSufficiencyMotivationScore Building::MultiPersonScore Building::CommercialBuildingScore Building::IsSelfSufficiencyMotivated Building::IsEcologicalMotivated Building::IsSelfSufficiencyMotivated Building::IsMultiPerson Building::IsSinglePerson Building::IsResidential Building::IsCommercial Building::IsInSameCountry Building::IsInSameConsumptionCategory Building::All ``` #### Returns Selects the event related building, and returns the specified building data, such as the building id, the registration date when the building was registered, the activation date when the building was activated on MOOST side, or the types of all devices. See [Data Types](/platform-manual/rules/rule-language/data-types.md#building) #### Examples Get all device types from the event related device. ```java Building::DeviceTypes ``` ### Properties Accessor on Scalar\ A special case is the Properties Accessor on the ScalayBuilding>. It allows to select the value that is defined in a customer property on a building and use it in the rule language. ```java Building::Properties[energyThreshold] ``` #### Returns Returns the value that is defined in the according properties entry on the building. When used in a rule condition the rule can only be trigger for buildings that have the according property set. #### Examples Use the value of the Property "energyThreshold" defined on the buildings to compare it against a dataset of type EnergyConsumption. ```java $EnergyConsumption > Building::Properties[energyThreshold] ``` ### Accessor on Scalar\ ```java DeliveredNotification::DeliveryTimestamp DeliveredNotification::InteractionTimestamp DeliveredNotification::InteractionType = ( 'OPENAPP' | 'OPENWEB' | 'DISMISS' | 'STOPDELIVERY' ) ``` #### Returns When used in Goal-achieved condition, selects the delivered notification, and returns * the time when the notification was delivered * the time when the interaction happened * the type of the interaction (e.g. `OPENAPP`) See [Literals](/platform-manual/rules/rule-language/literals.md#deliverednotification) #### Examples Get all device types from the event related device. ```java DeliveredNotification::InteractionType = 'OPENAPP' DeliveredNotification::InteractionTimestamp - DeliveredNotification::DeliveryTimestamp < 8h ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://doc.moost.io/platform-manual/rules/rule-language/operations/attribute-accessor.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.