Class: OpenHAB::Core::Items::Persistence::PersistedState

Inherits:

SimpleDelegator

• Object
• SimpleDelegator
• OpenHAB::Core::Items::Persistence::PersistedState

Defined in:

lib/openhab/core/items/persistence.rb

Overview

A wrapper for HistoricItem that delegates to its state.

A PersistedState object can be directly used in arithmetic operations with State and other PersistedState objects.

Examples:

max = Power_Usage.maximum_since(LocalTime::MIDNIGHT)
logger.info "Highest power usage: #{max} occurred at #{max.timestamp}" if max > 5 | "kW"

Arithmetic operations

todays_rate = Energy_Prices.persisted_state(Date.today) # Energy_Prices' unit is "<CURRENCY>/kWh"
todays_cost = Daily_Energy_Consumption.state * todays_rate

Instance Attribute Summary

• #name ⇒ String readonly

  Item name.

• #timestamp ⇒ ZonedDateTime readonly

Instance Method Summary

• #initialize(historic_item, state = nil) ⇒ PersistedState constructor

  A new instance of PersistedState.

Constructor Details

#initialize(historic_item, state = nil) ⇒ PersistedState

Returns a new instance of PersistedState.

# File 'lib/openhab/core/items/persistence.rb', line 96

def initialize(historic_item, state = nil)
  @historic_item = historic_item
  super(state || historic_item.state)
end

Instance Attribute Details

#name ⇒ String (readonly)

Returns Item name.

Returns:

• (String) —

  Item name

# File 'lib/openhab/core/items/persistence.rb', line 94

delegate %i[timestamp name] => :@historic_item

#timestamp ⇒ ZonedDateTime (readonly)

Returns:

• (ZonedDateTime)

# File 'lib/openhab/core/items/persistence.rb', line 88