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

#include <units.h>

Inheritance diagram for Substation:
Inheritance graph

Public Member Functions

 ~Substation ()
 
unsigned long get_internal_id () const
 Returns the internal ID of the substation.
 
unsigned long get_id () const
 Returns the ID of the substation as defined in the system structure database.
 
const std::string * get_name () const
 Returns the name of the substation.
 
double get_station_load () const
 Returns the current load at the substation in kW.
 
double get_residential_load () const
 Returns the current load at the substation in kW, generated by residential control units only.
 
double get_residential_demand () const
 Returns the accumulated demand (i.e., only the positive virtual smart meter readings) of all residential control units at this substation in kW.
 
double get_other_demand () const
 Returns the accumulated demand (i.e., only the positive virtual smart meter readings) of all non-residential control units at this substation in kW.
 
double get_current_demand_no_BESS () const
 Returns the current demand of all connected units without considering the local generation OR the BESS
 
double get_current_BESS_demand () const
 Returns the current charging demand of all BESS in all connected units.
 
double get_current_PV_generation_total_kW () const
 Returns the current generation (without consideration of self-consumption) in kW that is generated by all connected PV installations.
 
double get_current_BS_generation_total_kW () const
 Returns the current generation (without consideration of self-consumption) in kW that is generated by all connected battery storage systems.
 
double get_current_CHP_generation_total_kW () const
 Returns the current generation (without consideration of self-consumption) in kW that is generated by all connected CHPs.
 
double get_current_wind_generation_total_kW () const
 Returns the current generation (without consideration of self-consumption) in kW that is generated by all connected wind turbines.
 
double get_current_unknown_generation_total_kW () const
 Returns the current generation (without consideration of self-consumption) in kW that is generated by unknown components or not attributable to any generation technology.
 
double get_current_PV_feedin_to_grid_kW () const
 Returns the current feed-in into the grid in kW that is generated by all connected PV installations.
 
double get_current_BS_feedin_to_grid_kW () const
 Returns the current feed-in into the grid in kW that is generated by all connected battery storage systems.
 
double get_current_CHP_feedin_to_grid_kW () const
 Returns the current feed-in into the grid in kW that is generated by all connected CHPs.
 
double get_current_wind_feedin_to_grid_kW () const
 Returns the current feed-in into the grid in kW that is generated by all connected wind turbines.
 
double get_current_unknown_feedin_to_grid_kW () const
 Returns the current feed-in into the grid in kW that is generated by unknown components or not attributable to any generation technology.
 
void add_unit (ControlUnit *unit)
 
void calc_load ()
 
const std::list< ControlUnit * > * get_connected_units ()
 Return the list of connected units (as read only list)
 

Static Public Member Functions

static bool InstantiateNewSubstation (unsigned long public_id, std::string *name)
 
static void InitializeStaticVariables (unsigned long n_substations)
 
static void VacuumInstancesAndStaticVariables ()
 
static SubstationGetInstancePublicID (unsigned long public_id)
 Returns the instance with a given public_id.
 
static SubstationGetInstanceInternalID (unsigned long internal_id)
 Returns the instance with a given public_id.
 
static const std::vector< Substation * > & GetArrayOfInstances ()
 Returns the std::vector of all substation instances. The objects itself are mutable, but the vector is const.
 
static size_t GetNumberOfInstances ()
 

Detailed Description

This class represents a substation. One or more control units are connected to one instance of this class.

Constructor & Destructor Documentation

◆ ~Substation()

Substation::~Substation ( )

Member Function Documentation

◆ add_unit()

void Substation::add_unit ( ControlUnit unit)

◆ calc_load()

void Substation::calc_load ( )

◆ get_connected_units()

const std::list< ControlUnit * > * Substation::get_connected_units ( )
inline

Return the list of connected units (as read only list)

◆ get_current_BESS_demand()

double Substation::get_current_BESS_demand ( ) const
inline

Returns the current charging demand of all BESS in all connected units.

◆ get_current_BS_feedin_to_grid_kW()

double Substation::get_current_BS_feedin_to_grid_kW ( ) const
inline

Returns the current feed-in into the grid in kW that is generated by all connected battery storage systems.

◆ get_current_BS_generation_total_kW()

double Substation::get_current_BS_generation_total_kW ( ) const
inline

Returns the current generation (without consideration of self-consumption) in kW that is generated by all connected battery storage systems.

◆ get_current_CHP_feedin_to_grid_kW()

double Substation::get_current_CHP_feedin_to_grid_kW ( ) const
inline

Returns the current feed-in into the grid in kW that is generated by all connected CHPs.

◆ get_current_CHP_generation_total_kW()

double Substation::get_current_CHP_generation_total_kW ( ) const
inline

Returns the current generation (without consideration of self-consumption) in kW that is generated by all connected CHPs.

◆ get_current_demand_no_BESS()

double Substation::get_current_demand_no_BESS ( ) const
inline

Returns the current demand of all connected units without considering the local generation OR the BESS

◆ get_current_PV_feedin_to_grid_kW()

double Substation::get_current_PV_feedin_to_grid_kW ( ) const
inline

Returns the current feed-in into the grid in kW that is generated by all connected PV installations.

◆ get_current_PV_generation_total_kW()

double Substation::get_current_PV_generation_total_kW ( ) const
inline

Returns the current generation (without consideration of self-consumption) in kW that is generated by all connected PV installations.

◆ get_current_unknown_feedin_to_grid_kW()

double Substation::get_current_unknown_feedin_to_grid_kW ( ) const
inline

Returns the current feed-in into the grid in kW that is generated by unknown components or not attributable to any generation technology.

◆ get_current_unknown_generation_total_kW()

double Substation::get_current_unknown_generation_total_kW ( ) const
inline

Returns the current generation (without consideration of self-consumption) in kW that is generated by unknown components or not attributable to any generation technology.

◆ get_current_wind_feedin_to_grid_kW()

double Substation::get_current_wind_feedin_to_grid_kW ( ) const
inline

Returns the current feed-in into the grid in kW that is generated by all connected wind turbines.

◆ get_current_wind_generation_total_kW()

double Substation::get_current_wind_generation_total_kW ( ) const
inline

Returns the current generation (without consideration of self-consumption) in kW that is generated by all connected wind turbines.

◆ get_id()

unsigned long Substation::get_id ( ) const
inline

Returns the ID of the substation as defined in the system structure database.

◆ get_internal_id()

unsigned long Substation::get_internal_id ( ) const
inline

Returns the internal ID of the substation.

◆ get_name()

const std::string * Substation::get_name ( ) const
inline

Returns the name of the substation.

◆ get_other_demand()

double Substation::get_other_demand ( ) const
inline

Returns the accumulated demand (i.e., only the positive virtual smart meter readings) of all non-residential control units at this substation in kW.

◆ get_residential_demand()

double Substation::get_residential_demand ( ) const
inline

Returns the accumulated demand (i.e., only the positive virtual smart meter readings) of all residential control units at this substation in kW.

◆ get_residential_load()

double Substation::get_residential_load ( ) const
inline

Returns the current load at the substation in kW, generated by residential control units only.

◆ get_station_load()

double Substation::get_station_load ( ) const
inline

Returns the current load at the substation in kW.

◆ GetArrayOfInstances()

static const std::vector< Substation * > & Substation::GetArrayOfInstances ( )
inlinestatic

Returns the std::vector of all substation instances. The objects itself are mutable, but the vector is const.

◆ GetInstanceInternalID()

static Substation * Substation::GetInstanceInternalID ( unsigned long  internal_id)
inlinestatic

Returns the instance with a given public_id.

◆ GetInstancePublicID()

Substation * Substation::GetInstancePublicID ( unsigned long  public_id)
static

Returns the instance with a given public_id.

◆ GetNumberOfInstances()

static size_t Substation::GetNumberOfInstances ( )
inlinestatic

◆ InitializeStaticVariables()

void Substation::InitializeStaticVariables ( unsigned long  n_substations)
static

◆ InstantiateNewSubstation()

bool Substation::InstantiateNewSubstation ( unsigned long  public_id,
std::string *  name 
)
static

Instantiates a new substation object. Returns false, if the ID is already defined.

◆ VacuumInstancesAndStaticVariables()

void Substation::VacuumInstancesAndStaticVariables ( )
static

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