Documentation of UrbanFireXDT
Documentation of UrbanFireXDT
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
MeasurementUnit Class Reference

#include <units.h>

Inheritance diagram for MeasurementUnit:
Inheritance graph

Public Member Functions

 ~MeasurementUnit ()
 
const std::string * get_meterPointName () const
 Returns the name of the meter point.
 
unsigned long get_internal_id () const
 Returns the (consecutive) internal ID of the measurement unit.
 
unsigned long get_meUID () const
 Returns the ID as given in the system structe database.
 
unsigned long get_locationID () const
 Returns the ID of the location.
 
bool load_data ()
 Load the data as given by the member variable data_source_path. Returns false if an error happend during file loading.
 
bool has_demand () const
 
bool has_feedin () const
 
bool has_pv () const
 
bool has_pv_residential () const
 
bool has_pv_open_space () const
 
bool has_bs () const
 
bool has_hp () const
 
bool has_evchst () const
 
bool has_chp () const
 
bool has_wind () const
 
int get_expansion_combination () const
 
double get_total_demand_kWh () const
 Returns the total demand of the measurement unit over the complete time span of data.
 
bool compute_next_value (unsigned long ts)
 
float get_current_ts_rsm_value () const
 
float get_rsm_load_at_ts (unsigned long ts) const
 
float get_rsm_demand_at_ts (unsigned long ts) const
 
float get_rsm_feedin_at_ts (unsigned long ts) const
 

Static Public Member Functions

static bool InstantiateNewMeasurementUnit (size_t meUID, size_t public_unitID, std::string *meterPointName, size_t locID, bool has_demand, bool has_feedin, bool has_pv_resid, bool has_pv_opens, bool has_bess, bool has_hp, bool has_wind, bool has_evchst, bool has_chp, const std::string &data_source_path)
 
static void InitializeStaticVariables (unsigned long n_MUs)
 
static void VacuumInstancesAndStaticVariables ()
 
static size_t GetNumberOfInstances ()
 
static bool LoadDataForAllInstances ()
 Loads the data for all created instances.
 
static MeasurementUnitGetInstancePublicID (unsigned long meUID)
 Returns instance with public id meUID (or NULL, if the ID is not available)
 

Detailed Description

The measurement unit represents an existing unit, which is measured by an existing smart meter where we have real measured data for. If there exist additional components, like PV, in reality, an instance of this class knows this.

Constructor & Destructor Documentation

◆ ~MeasurementUnit()

MeasurementUnit::~MeasurementUnit ( )

Member Function Documentation

◆ compute_next_value()

bool MeasurementUnit::compute_next_value ( unsigned long  ts)

◆ get_current_ts_rsm_value()

float MeasurementUnit::get_current_ts_rsm_value ( ) const
inline

◆ get_expansion_combination()

int MeasurementUnit::get_expansion_combination ( ) const
inline

◆ get_internal_id()

unsigned long MeasurementUnit::get_internal_id ( ) const
inline

Returns the (consecutive) internal ID of the measurement unit.

◆ get_locationID()

unsigned long MeasurementUnit::get_locationID ( ) const
inline

Returns the ID of the location.

◆ get_meterPointName()

const std::string * MeasurementUnit::get_meterPointName ( ) const
inline

Returns the name of the meter point.

◆ get_meUID()

unsigned long MeasurementUnit::get_meUID ( ) const
inline

Returns the ID as given in the system structe database.

◆ get_rsm_demand_at_ts()

float MeasurementUnit::get_rsm_demand_at_ts ( unsigned long  ts) const

Returns the demand at the smart meter at a given time step in kW. In contrast to MeasurementUnit::get_rsm_load_at_ts(), it ignores feed-in. If there is no data available, it returns 0.0. This method does not change the object.

Parameters
tsThe time step for which the load should be computed
See also
get_current_ts_rsm_value(), get_rsm_feedin_at_ts()

◆ get_rsm_feedin_at_ts()

float MeasurementUnit::get_rsm_feedin_at_ts ( unsigned long  ts) const

Returns the feed-in at the smart meter at a given time step in kW. In contrast to MeasurementUnit::get_rsm_load_at_ts(), it ignores the demand. If there is no data available, it returns 0.0. This method does not change the object.

Returns
only positive numbers (for a feedin - in contrast to get_rsm_load_at_ts()), or 0.0
Parameters
tsThe time step for which the load should be computed
See also
get_current_ts_rsm_value(), get_rsm_demand_at_ts()

◆ get_rsm_load_at_ts()

float MeasurementUnit::get_rsm_load_at_ts ( unsigned long  ts) const

Returns the load at the smart meter at a given time step in kW. If there is no data available, it returns 0.0. This method does not change the object. The results equals to get_rsm_demand_at_ts(ts) - get_rsm_feedin_at_ts(ts)

Parameters
tsThe time step for which the load should be computed
See also
get_rsm_demand_at_ts(), get_rsm_feedin_at_ts()

◆ get_total_demand_kWh()

double MeasurementUnit::get_total_demand_kWh ( ) const

Returns the total demand of the measurement unit over the complete time span of data.

◆ GetInstancePublicID()

MeasurementUnit * MeasurementUnit::GetInstancePublicID ( unsigned long  meUID)
static

Returns instance with public id meUID (or NULL, if the ID is not available)

◆ GetNumberOfInstances()

static size_t MeasurementUnit::GetNumberOfInstances ( )
inlinestatic

◆ has_bs()

bool MeasurementUnit::has_bs ( ) const
inline

◆ has_chp()

bool MeasurementUnit::has_chp ( ) const
inline

◆ has_demand()

bool MeasurementUnit::has_demand ( ) const
inline

◆ has_evchst()

bool MeasurementUnit::has_evchst ( ) const
inline

◆ has_feedin()

bool MeasurementUnit::has_feedin ( ) const
inline

◆ has_hp()

bool MeasurementUnit::has_hp ( ) const
inline

◆ has_pv()

bool MeasurementUnit::has_pv ( ) const
inline

◆ has_pv_open_space()

bool MeasurementUnit::has_pv_open_space ( ) const
inline

◆ has_pv_residential()

bool MeasurementUnit::has_pv_residential ( ) const
inline

◆ has_wind()

bool MeasurementUnit::has_wind ( ) const
inline

◆ InitializeStaticVariables()

void MeasurementUnit::InitializeStaticVariables ( unsigned long  n_MUs)
static

◆ InstantiateNewMeasurementUnit()

bool MeasurementUnit::InstantiateNewMeasurementUnit ( size_t  meUID,
size_t  public_unitID,
std::string *  meterPointName,
size_t  locID,
bool  has_demand,
bool  has_feedin,
bool  has_pv_resid,
bool  has_pv_opens,
bool  has_bess,
bool  has_hp,
bool  has_wind,
bool  has_evchst,
bool  has_chp,
const std::string &  data_source_path 
)
static

Instantiates a new measurement unit. Returns false, if the meUID is already defined.

◆ load_data()

bool MeasurementUnit::load_data ( )

Load the data as given by the member variable data_source_path. Returns false if an error happend during file loading.

◆ LoadDataForAllInstances()

bool MeasurementUnit::LoadDataForAllInstances ( )
static

Loads the data for all created instances.

◆ VacuumInstancesAndStaticVariables()

void MeasurementUnit::VacuumInstancesAndStaticVariables ( )
static

The documentation for this class was generated from the following files: