VICUS::SupplySystem Class Reference

#include <VICUS_SupplySystem.h>

Inheritance diagram for VICUS::SupplySystem:

Public Types
enum	SupplyType {   ST_StandAlone , ST_SubNetwork , ST_DatabaseFMU , ST_UserDefinedFMU ,   NUM_ST }
enum	para_t {   P_MaximumMassFlux , P_SupplyTemperature , P_MaximumMassFluxFMU , P_HeatingPowerFMU ,   NUM_P }
Public Types inherited from VICUS::AbstractDBElement
enum	ComparisonResult { Equal , OnlyMetaDataDiffers , Different }

Public Member Functions
void	readXML (const TiXmlElement *element) override
TiXmlElement *	writeXML (TiXmlElement *parent) const override
VICUS_COMPARE_WITH_ID bool	isValid (const Database< SubNetwork > &subNetworkDB, const Database< VICUS::NetworkComponent > &compDB, const Database< VICUS::NetworkController > &ctrlDB, const Database< VICUS::Schedule > &scheduleDB) const
ComparisonResult	equal (const AbstractDBElement *other) const override
Public Member Functions inherited from VICUS::AbstractDBElement
	AbstractDBElement ()=default
	AbstractDBElement (unsigned int id, const IBK::MultiLanguageString &name)
virtual	~AbstractDBElement ()
void	collectChildren (std::set< const AbstractDBElement * > &allChildrenRefs) const
void	collectLocalChildren (std::set< AbstractDBElement * > &localChildrenRefs) const
const QString	sourceName () const

Public Attributes
SupplyType	m_supplyType = ST_StandAlone
IBK::Parameter	m_para [NUM_P]
QString	m_supplyFMUPath
IDType	m_idSupplyFMU = VICUS::INVALID_ID
IDType	m_idSubNetwork = VICUS::INVALID_ID
const VICUS::SubNetwork *	m_subNetwork = nullptr
Public Attributes inherited from VICUS::AbstractDBElement
unsigned int	m_id = INVALID_ID
IBK::MultiLanguageString	m_displayName
QColor	m_color
bool	m_builtIn = false
bool	m_local = true
std::set< AbstractDBElement * >	m_childrenRefs
bool	m_isReferenced = false
std::string	m_errorMsg

Detailed Description

Defines the base structure of a generic network: A generic network may be generated for surface heating FMU export. We bundle all heatings by a hydraulically balanced network and support FMI-coupling at a single demand network branch.

Member Enumeration Documentation

para_t

enum VICUS::SupplySystem::para_t

Network parameters.

Enumerator
P_MaximumMassFlux
P_SupplyTemperature
P_MaximumMassFluxFMU
P_HeatingPowerFMU
NUM_P

SupplyType

enum VICUS::SupplySystem::SupplyType

Supplier supported by the generic network model.

Enumerator
ST_StandAlone
ST_SubNetwork
ST_DatabaseFMU
ST_UserDefinedFMU
NUM_ST

Member Function Documentation

equal()

AbstractDBElement::ComparisonResult VICUS::SupplySystem::equal ( const AbstractDBElement *  other ) const

overridevirtual

Comparison operator

Implements VICUS::AbstractDBElement.

isValid()

bool VICUS::SupplySystem::isValid	(	const Database< SubNetwork > &	subNetworkDB,
		const Database< VICUS::NetworkComponent > &	compDB,
		const Database< VICUS::NetworkController > &	ctrlDB,
		const Database< VICUS::Schedule > &	scheduleDB
	)		const

Checks if the network definition is valid.

readXML()

void VICUS::SupplySystem::readXML ( const TiXmlElement *  element )

overridevirtual

Implements VICUS::AbstractDBElement.

writeXML()

TiXmlElement * VICUS::SupplySystem::writeXML ( TiXmlElement *  parent ) const

overridevirtual

Implements VICUS::AbstractDBElement.

Member Data Documentation

m_idSubNetwork

IDType VICUS::SupplySystem::m_idSubNetwork = VICUS::INVALID_ID

Id of vicus sub network

m_idSupplyFMU

IDType VICUS::SupplySystem::m_idSupplyFMU = VICUS::INVALID_ID

Id for database FMU.

m_para

IBK::Parameter VICUS::SupplySystem::m_para[NUM_P]

Parameters for stand alone mode.

m_subNetwork

const VICUS::SubNetwork* VICUS::SupplySystem::m_subNetwork = nullptr

mutable

m_supplyFMUPath

QString VICUS::SupplySystem::m_supplyFMUPath

FMU path for Database FMU mode.

m_supplyType

SupplyType VICUS::SupplySystem::m_supplyType = ST_StandAlone

Network supply type.

---

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

• /home/hirth/git/SIM-VICUS.master2/externals/Vicus/src/VICUS_SupplySystem.h
• /home/hirth/git/SIM-VICUS.master2/externals/Vicus/src/ncg/ncg_VICUS_SupplySystem.cpp
• /home/hirth/git/SIM-VICUS.master2/externals/Vicus/src/VICUS_SupplySystem.cpp