VICUS::Component Class Reference

#include <VICUS_Component.h>

Inheritance diagram for VICUS::Component:

Public Types
enum	ComponentType {   CT_OutsideWall , CT_OutsideWallToGround , CT_InsideWall , CT_FloorToCellar ,   CT_FloorToAir , CT_FloorToGround , CT_Ceiling , CT_SlopedRoof ,   CT_FlatRoof , CT_ColdRoof , CT_WarmRoof , CT_Miscellaneous ,   NUM_CT }
Public Types inherited from VICUS::AbstractDBElement
enum	ComparisonResult { Equal , OnlyMetaDataDiffers , Different }

Public Member Functions
VICUS_READWRITE_OVERRIDE VICUS_COMPARE_WITH_ID bool	isValid (const VICUS::Database< Material > &materials, const VICUS::Database< Construction > &constructions, const VICUS::Database< BoundaryCondition > &bcs, const VICUS::Database< 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 ()
virtual void	readXML (const TiXmlElement *element)=0
virtual TiXmlElement *	writeXML (TiXmlElement *parent) const =0
void	collectChildren (std::set< const AbstractDBElement * > &allChildrenRefs) const
void	collectLocalChildren (std::set< AbstractDBElement * > &localChildrenRefs) const
const QString	sourceName () const

Public Attributes
IBK::MultiLanguageString	m_notes
IBK::MultiLanguageString	m_manufacturer
IBK::MultiLanguageString	m_dataSource
ComponentType	m_type = CT_Miscellaneous
unsigned int	m_idConstruction = INVALID_ID
unsigned int	m_idSideABoundaryCondition = INVALID_ID
unsigned int	m_idSideBBoundaryCondition = INVALID_ID
unsigned int	m_idSurfaceProperty = INVALID_ID
unsigned int	m_activeLayerIndex = INVALID_ID
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

Member Enumeration Documentation

ComponentType

enum VICUS::Component::ComponentType

Component types.

Enumerator
CT_OutsideWall
CT_OutsideWallToGround
CT_InsideWall
CT_FloorToCellar
CT_FloorToAir
CT_FloorToGround
CT_Ceiling
CT_SlopedRoof
CT_FlatRoof
CT_ColdRoof
CT_WarmRoof
CT_Miscellaneous
NUM_CT

Member Function Documentation

equal()

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

overridevirtual

Comparison operator

Implements VICUS::AbstractDBElement.

isValid()

bool VICUS::Component::isValid	(	const VICUS::Database< Material > &	materials,
		const VICUS::Database< Construction > &	constructions,
		const VICUS::Database< BoundaryCondition > &	bcs,
		const VICUS::Database< Schedule > &	scheduleDB
	)		const

Checks if all referenced materials exist and if their parameters are valid.

Member Data Documentation

m_activeLayerIndex

unsigned int VICUS::Component::m_activeLayerIndex = INVALID_ID

Identifies the layer of the construction (counting from side A, from index 0), that shall be used for floor heating/cooling.

m_dataSource

IBK::MultiLanguageString VICUS::Component::m_dataSource

Data source.

m_idConstruction

unsigned int VICUS::Component::m_idConstruction = INVALID_ID

Opaque construction ID.

m_idSideABoundaryCondition

unsigned int VICUS::Component::m_idSideABoundaryCondition = INVALID_ID

Boundary condition ID for Side A (usually outside).

m_idSideBBoundaryCondition

unsigned int VICUS::Component::m_idSideBBoundaryCondition = INVALID_ID

Boundary condition ID for Side B (usually inside).

m_idSurfaceProperty

unsigned int VICUS::Component::m_idSurfaceProperty = INVALID_ID

Surface property ID. TODO Dirk, kann das weg?

m_manufacturer

IBK::MultiLanguageString VICUS::Component::m_manufacturer

Manufacturer.

m_notes

IBK::MultiLanguageString VICUS::Component::m_notes

Notes.

m_type

ComponentType VICUS::Component::m_type = CT_Miscellaneous

Component type.

---

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

• /home/hirth/git/SIM-VICUS.master2/externals/Vicus/src/VICUS_Component.h
• /home/hirth/git/SIM-VICUS.master2/externals/Vicus/src/VICUS_Component.cpp