preheat_open.loadable_types.ComponentData

class preheat_open.loadable_types.ComponentData(measurements=<factory>)

Bases: LoadableDataType

Represents data for a component, including measurements and date range.

Variables:
  • date_range (DateRange) – The date range for the component data.

  • measurements (pd.Series) – The measurements for the component data.

__init__(measurements=<factory>)

Methods

__init__([measurements])

add_data(data)

Adds measurements to the component data.

get_data(date_range)

Retrieves measurements for the specified date range.

Attributes

measurements

add_data(data)

Adds measurements to the component data.

Parameters:

data (pd.Series | None) – The measurements to add.

Return type:

None

get_data(date_range)

Retrieves measurements for the specified date range.

Parameters:

date_range (DateRange) – The date range for which to retrieve measurements.

Returns:

A tuple containing the date range and the measurements.

Return type:

tuple[DateRange, pd.Series]