VICUS::ComponentInstance Class Reference

#include <VICUS_ComponentInstance.h>

Public Member Functions
	ComponentInstance ()
	ComponentInstance (unsigned int id, unsigned int componentID, unsigned int sideASurfaceID, unsigned int sideBSurfaceID)
VICUS_READWRITE VICUS_COMPARE_WITH_ID bool	compare (const VICUS::ComponentInstance &ci) const

Public Attributes
unsigned int	m_id = INVALID_ID
unsigned int	m_idComponent = INVALID_ID
unsigned int	m_idSideASurface = INVALID_ID
unsigned int	m_idSideBSurface = INVALID_ID
unsigned int	m_idSurfaceHeating = INVALID_ID
unsigned int	m_idSurfaceHeatingControlZone = INVALID_ID
unsigned int	m_idSupplySystem = INVALID_ID
VICUS::Surface *	m_sideASurface = nullptr
VICUS::Surface *	m_sideBSurface = nullptr
VICUS::Room *	m_surfaceHeatingControlZone = nullptr

Detailed Description

Defines a construction/component of the building. It is basically just a connection data member and does not hold any physical parameters itself.

Constructor & Destructor Documentation

ComponentInstance() [1/2]

VICUS::ComponentInstance::ComponentInstance ( )

inline

Default c'tor.

ComponentInstance() [2/2]

VICUS::ComponentInstance::ComponentInstance ( unsigned int  id, unsigned int  componentID, unsigned int  sideASurfaceID, unsigned int  sideBSurfaceID  )

inline

Initializing constructor.

Member Function Documentation

compare()

VICUS_READWRITE VICUS_COMPARE_WITH_ID bool VICUS::ComponentInstance::compare ( const VICUS::ComponentInstance &  ci ) const

inline

Member Data Documentation

m_id

unsigned int VICUS::ComponentInstance::m_id = INVALID_ID

ID of component instance (will be used for NANDRAD::ConstructionInstance).

m_idComponent

unsigned int VICUS::ComponentInstance::m_idComponent = INVALID_ID

ID of referenced component.

m_idSideASurface

unsigned int VICUS::ComponentInstance::m_idSideASurface = INVALID_ID

ID of surface at side A (optional, ID = 0 reserved for "ambient", INVALID_ID means adiabatic).

m_idSideBSurface

unsigned int VICUS::ComponentInstance::m_idSideBSurface = INVALID_ID

ID of surface at side B (optional, ID = 0 reserved for "ambient", INVALID_ID means adiabatic).

m_idSupplySystem

unsigned int VICUS::ComponentInstance::m_idSupplySystem = INVALID_ID

ID of an external supply object.

m_idSurfaceHeating

unsigned int VICUS::ComponentInstance::m_idSurfaceHeating = INVALID_ID

ID of surface heating definition, to be used when component has active layer.

m_idSurfaceHeatingControlZone

unsigned int VICUS::ComponentInstance::m_idSurfaceHeatingControlZone = INVALID_ID

ID of zone containing thermostat for control of surface heating.

m_sideASurface

VICUS::Surface* VICUS::ComponentInstance::m_sideASurface = nullptr

m_sideBSurface

VICUS::Surface* VICUS::ComponentInstance::m_sideBSurface = nullptr

m_surfaceHeatingControlZone

VICUS::Room* VICUS::ComponentInstance::m_surfaceHeatingControlZone = nullptr

---

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

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