An electrochemical energy storage device. More...

#include <BatteryUnit.hpp>

Inheritance diagram for CIMPP::BatteryUnit:

[legend]

Collaboration diagram for CIMPP::BatteryUnit:

[legend]

Public Member Functions
const char *	debugString () const override
const std::list< std::string > &	getAttributeNames () const override
const std::string &	getClassNamespaceUrl () const override
const std::string &	getAttributeNamespaceUrl (const std::string &attrName) const override
const std::list< CGMESProfile > &	getPossibleProfiles () const override
const CGMESProfile &	getRecommendedProfile () const override
const std::list< CGMESProfile > &	getPossibleAttributeProfiles (const std::string &attrName) const override
const std::list< CGMESProfile > &	getPossibleProfilesIncludingAttributes () const override
void	addPrimitiveGetFnsToMap (std::map< std::string, get_function > &get_map) const override
void	addClassGetFnsToMap (std::map< std::string, class_get_function > &get_map) const override
void	addEnumGetFnsToMap (std::map< std::string, get_function > &get_map) const override
bool	isAssignableFrom (BaseClass *otherObject) const override
Public Member Functions inherited from CIMPP::PowerElectronicsUnit
const char *	debugString () const override
const std::list< std::string > &	getAttributeNames () const override
const std::string &	getClassNamespaceUrl () const override
const std::string &	getAttributeNamespaceUrl (const std::string &attrName) const override
const std::list< CGMESProfile > &	getPossibleProfiles () const override
const CGMESProfile &	getRecommendedProfile () const override
const std::list< CGMESProfile > &	getPossibleAttributeProfiles (const std::string &attrName) const override
const std::list< CGMESProfile > &	getPossibleProfilesIncludingAttributes () const override
void	addPrimitiveGetFnsToMap (std::map< std::string, get_function > &get_map) const override
void	addClassGetFnsToMap (std::map< std::string, class_get_function > &get_map) const override
void	addEnumGetFnsToMap (std::map< std::string, get_function > &get_map) const override
bool	isAssignableFrom (BaseClass *otherObject) const override
Public Member Functions inherited from CIMPP::PowerSystemResource
const char *	debugString () const override
const std::list< std::string > &	getAttributeNames () const override
const std::string &	getClassNamespaceUrl () const override
const std::string &	getAttributeNamespaceUrl (const std::string &attrName) const override
const std::list< CGMESProfile > &	getPossibleProfiles () const override
const CGMESProfile &	getRecommendedProfile () const override
const std::list< CGMESProfile > &	getPossibleAttributeProfiles (const std::string &attrName) const override
const std::list< CGMESProfile > &	getPossibleProfilesIncludingAttributes () const override
void	addPrimitiveGetFnsToMap (std::map< std::string, get_function > &get_map) const override
void	addClassGetFnsToMap (std::map< std::string, class_get_function > &get_map) const override
void	addEnumGetFnsToMap (std::map< std::string, get_function > &get_map) const override
bool	isAssignableFrom (BaseClass *otherObject) const override
Public Member Functions inherited from BaseClass
void	setRdfid (const std::string &id)
std::string	getRdfid () const

Static Public Member Functions
static void	addConstructToMap (std::unordered_map< std::string, BaseClass ()()> &factory_map)
static void	addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void	addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner	declare ()
Static Public Member Functions inherited from CIMPP::PowerElectronicsUnit
static void	addConstructToMap (std::unordered_map< std::string, BaseClass ()()> &factory_map)
static void	addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void	addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner	declare ()
Static Public Member Functions inherited from CIMPP::Equipment
static void	addConstructToMap (std::unordered_map< std::string, BaseClass ()()> &factory_map)
static void	addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void	addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner	declare ()
Static Public Member Functions inherited from CIMPP::PowerSystemResource
static void	addConstructToMap (std::unordered_map< std::string, BaseClass ()()> &factory_map)
static void	addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void	addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner	declare ()
Static Public Member Functions inherited from CIMPP::IdentifiedObject
static void	addConstructToMap (std::unordered_map< std::string, BaseClass ()()> &factory_map)
static void	addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void	addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner	declare ()
Static Public Member Functions inherited from BaseClass
static void	addConstructToMap (std::unordered_map< std::string, BaseClass ()()> &factory_map)
static void	addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void	addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const CIMPP::BaseClassDefiner	declare ()

Public Attributes
CIMPP::BatteryStateKind	batteryState
	The current state of the battery (charging, full, etc.). Default: 0.
CIMPP::RealEnergy	ratedE
	Full energy storage capacity of the battery. The attribute shall be a positive value. Default: 0.0.
CIMPP::RealEnergy	storedE
	Amount of energy currently stored. The attribute shall be a positive value or zero and lower than BatteryUnit.ratedE. Default: 0.0.
Public Attributes inherited from CIMPP::PowerElectronicsUnit
CIMPP::PowerElectronicsConnection *	PowerElectronicsConnection
	A power electronics unit has a connection to the AC network. Default: nullptr.
CIMPP::ActivePower	maxP
	Maximum active power limit. This is the maximum (nameplate) limit for the unit. Default: 0.0.
CIMPP::ActivePower	minP
	Minimum active power limit. This is the minimum (nameplate) limit for the unit. Default: 0.0.
Public Attributes inherited from CIMPP::Equipment
CIMPP::EquipmentContainer *	EquipmentContainer
	Container of this equipment. Default: nullptr.
std::list< CIMPP::OperationalLimitSet * >	OperationalLimitSet
	The operational limit sets associated with this equipment. Default: {}.
CIMPP::Boolean	aggregate
	The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to true the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine. The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection. Default: false.
CIMPP::Boolean	inService
	Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model. Default: false.
CIMPP::Boolean	normallyInService
	Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model. Default: false.
Public Attributes inherited from CIMPP::PowerSystemResource
std::list< CIMPP::Control * >	Controls
	The controller outputs used to actually govern a regulating device, e.g. the magnetization of a synchronous machine or capacitor bank breaker actuator. Default: {}.
CIMPP::Location *	Location
	Location of this power system resource. Default: nullptr.
std::list< CIMPP::Measurement * >	Measurements
	The measurements associated with this power system resource. Default: {}.
Public Attributes inherited from CIMPP::IdentifiedObject
std::list< CIMPP::DiagramObject * >	DiagramObjects
	The diagram objects that are associated with the domain object. Default: {}.
CIMPP::String	description
	The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy. Default: "".
CIMPP::String	energyIdentCodeEic
	The attribute is used for an exchange of the EIC code (Energy identification Code). The length of the string is 16 characters as defined by the EIC code. For details on EIC scheme please refer to ENTSO-E web site. Default: "".
CIMPP::String	mRID
	Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended. For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements. Default: "".
CIMPP::String	name
	The name is any free human readable and possibly non unique text naming the object. Default: "".
CIMPP::String	shortName
	The attribute is used for an exchange of a human readable short name with length of the string 12 characters maximum. Default: "".

Static Public Attributes
static const char	debugName [] = "BatteryUnit"
Static Public Attributes inherited from CIMPP::PowerElectronicsUnit
static const char	debugName [] = "PowerElectronicsUnit"
Static Public Attributes inherited from CIMPP::Equipment
static const char	debugName [] = "Equipment"
Static Public Attributes inherited from CIMPP::PowerSystemResource
static const char	debugName [] = "PowerSystemResource"
Static Public Attributes inherited from CIMPP::IdentifiedObject
static const char	debugName [] = "IdentifiedObject"
Static Public Attributes inherited from BaseClass
static const char	debugName [] = "BaseClass"

Protected Member Functions
std::map< std::string, AttrDetails >	allAttrDetailsMap () const override
Protected Member Functions inherited from CIMPP::PowerElectronicsUnit
std::map< std::string, AttrDetails >	allAttrDetailsMap () const override
Protected Member Functions inherited from CIMPP::PowerSystemResource
std::map< std::string, AttrDetails >	allAttrDetailsMap () const override

Detailed Description

An electrochemical energy storage device.

Member Function Documentation

◆ addClassGetFnsToMap()

void BatteryUnit::addClassGetFnsToMap ( std::map< std::string, class_get_function > & get_map ) const

overridevirtual

Reimplemented from BaseClass.

◆ addEnumGetFnsToMap()

void BatteryUnit::addEnumGetFnsToMap ( std::map< std::string, get_function > & get_map ) const

overridevirtual

Reimplemented from BaseClass.

◆ addPrimitiveGetFnsToMap()

void BatteryUnit::addPrimitiveGetFnsToMap ( std::map< std::string, get_function > & get_map ) const

overridevirtual

Reimplemented from BaseClass.

◆ allAttrDetailsMap()

std::map< std::string, AttrDetails > BatteryUnit::allAttrDetailsMap ( ) const

overrideprotectedvirtual

Reimplemented from BaseClass.

◆ debugString()

const char * BatteryUnit::debugString ( ) const

overridevirtual

Reimplemented from BaseClass.

◆ getAttributeNames()

const std::list< std::string > & BatteryUnit::getAttributeNames ( ) const

overridevirtual

Reimplemented from BaseClass.

◆ getAttributeNamespaceUrl()

const std::string & BatteryUnit::getAttributeNamespaceUrl ( const std::string & attrName ) const

overridevirtual

Reimplemented from BaseClass.

◆ getClassNamespaceUrl()

const std::string & BatteryUnit::getClassNamespaceUrl ( ) const

overridevirtual

Reimplemented from BaseClass.

◆ getPossibleAttributeProfiles()

const std::list< CGMESProfile > & BatteryUnit::getPossibleAttributeProfiles ( const std::string & attrName ) const

overridevirtual

Reimplemented from BaseClass.

◆ getPossibleProfiles()

const std::list< CGMESProfile > & BatteryUnit::getPossibleProfiles ( ) const

overridevirtual

Reimplemented from BaseClass.

◆ getPossibleProfilesIncludingAttributes()

const std::list< CGMESProfile > & BatteryUnit::getPossibleProfilesIncludingAttributes ( ) const

overridevirtual

Reimplemented from BaseClass.

◆ getRecommendedProfile()

const CGMESProfile & BatteryUnit::getRecommendedProfile ( ) const

overridevirtual

Reimplemented from BaseClass.

◆ isAssignableFrom()

bool BatteryUnit::isAssignableFrom ( BaseClass * otherObject ) const

overridevirtual

Reimplemented from BaseClass.

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

CGMES_3.0.0/BatteryUnit.hpp
CGMES_3.0.0/BatteryUnit.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ addClassGetFnsToMap()

◆ addEnumGetFnsToMap()

◆ addPrimitiveGetFnsToMap()

◆ allAttrDetailsMap()

◆ debugString()

◆ getAttributeNames()

◆ getAttributeNamespaceUrl()

◆ getClassNamespaceUrl()

◆ getPossibleAttributeProfiles()

◆ getPossibleProfiles()

◆ getPossibleProfilesIncludingAttributes()

◆ getRecommendedProfile()

◆ isAssignableFrom()