VICUS Library
Documentation of Vicus library
Loading...
Searching...
No Matches
VICUS::Room Class Reference

#include <VICUS_Room.h>

Inheritance diagram for VICUS::Room:
[legend]

Public Types

enum  para_t { P_Area , P_Volume , NUM_P }
 

Public Member Functions

const char * typeinfo () const override
 
VICUS_READWRITE VICUS_COMPARE_WITH_ID void calculateFloorArea ()
 
void calculateVolume ()
 
void updateParents ()
 
- Public Member Functions inherited from VICUS::Object
 Object ()=default
 
 Object (Object const &)=default
 
virtual ~Object ()
 
ObjectfindChild (unsigned int ID)
 
const ObjectfindChild (unsigned int ID) const
 
void collectChildIDs (std::set< unsigned int > &nodeContainer) const
 
QString info () const
 

Public Attributes

IDType m_idZoneTemplate = INVALID_ID
 
IDType m_idAcousticTemplate = INVALID_ID
 
IBK::Parameter m_para [NUM_P]
 
std::vector< Surfacem_surfaces
 
double m_netFloorArea = -1
 
double m_volume = -1
 
- Public Attributes inherited from VICUS::Object
Objectm_parent = nullptr
 
unsigned int m_id = INVALID_ID
 
bool m_selected = false
 
bool m_visible = true
 
QString m_displayName
 
std::string m_ifcGUID
 

Additional Inherited Members

- Protected Attributes inherited from VICUS::Object
std::vector< Object * > m_children
 

Detailed Description

Stores all data for a room.

Member Enumeration Documentation

◆ para_t

Room parameters. These parameters are either automatically computed when zone is created/modified, or manually entered/adjusted by user.

Enumerator
P_Area 

Floor usable area of the zone, used for zone load definition.

P_Volume 

Geometrical violume of the zone, used for air exchange calulation + energy balance.

NUM_P 

Member Function Documentation

◆ calculateFloorArea()

void VICUS::Room::calculateFloorArea ( )

Calculates the floor area of the room.

◆ calculateVolume()

void VICUS::Room::calculateVolume ( )

Calculates the volume of the room. Room must have a closed shell.

◆ typeinfo()

const char * VICUS::Room::typeinfo ( ) const
inlineoverridevirtual

Type-info string.

Implements VICUS::Object.

◆ updateParents()

void VICUS::Room::updateParents ( )
inline

Member Data Documentation

◆ m_idAcousticTemplate

IDType VICUS::Room::m_idAcousticTemplate = INVALID_ID

Reference to assigned acoustic template (optional).

◆ m_idZoneTemplate

IDType VICUS::Room::m_idZoneTemplate = INVALID_ID

Reference to assigned zone template (optional).

◆ m_netFloorArea

double VICUS::Room::m_netFloorArea = -1

Whole room net floor area in m2. This area is updated either from user-defined area in m_para or automatically computed from zone geometry. If the latter is not possible, user must enter a floor area.

◆ m_para

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

Zone parameters.

◆ m_surfaces

std::vector<Surface> VICUS::Room::m_surfaces

Surfaces of the room.

◆ m_volume

double VICUS::Room::m_volume = -1

Whole room volume in m3. This volume is updated either from user-defined volume in m_para or automatically computed from zone geometry. If the latter is not possible, user must enter a valid volume.


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