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

#include <VICUS_Construction.h>

Inheritance diagram for VICUS::Construction:
[legend]

Public Types

enum  UsageType {
  UT_OutsideWall , UT_OutsideWallToGround , UT_InsideWall , UT_FloorToCellar ,
  UT_FloorToGround , UT_Ceiling , UT_SlopedRoof , UT_FlatRoof ,
  NUM_UT
}
 
enum  InsulationKind {
  IK_NotInsulated , IK_InsideInsulation , IK_CoreInsulation , IK_OutsideInsulation ,
  NUM_IK
}
 
enum  MaterialKind {
  MK_BrickMasonry , MK_NaturalStoneMasonry , MK_Concrete , MK_Wood ,
  MK_FrameWork , MK_Loam , NUM_MK
}
 
- 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< VICUS::Material > &materials) const
 
bool calculateUValue (double &UValue, const VICUS::Database< Material > &materials, double ri, double re) 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

UsageType m_usageType = NUM_UT
 
InsulationKind m_insulationKind = NUM_IK
 
MaterialKind m_materialKind = NUM_MK
 
IBK::MultiLanguageString m_notes
 
IBK::MultiLanguageString m_dataSource
 
std::vector< MaterialLayerm_materialLayers
 
- 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

◆ InsulationKind

Enumerator
IK_NotInsulated 
IK_InsideInsulation 
IK_CoreInsulation 
IK_OutsideInsulation 
NUM_IK 

◆ MaterialKind

Enumerator
MK_BrickMasonry 
MK_NaturalStoneMasonry 
MK_Concrete 
MK_Wood 
MK_FrameWork 
MK_Loam 
NUM_MK 

◆ UsageType

Enumerator
UT_OutsideWall 
UT_OutsideWallToGround 
UT_InsideWall 
UT_FloorToCellar 
UT_FloorToGround 
UT_Ceiling 
UT_SlopedRoof 
UT_FlatRoof 
NUM_UT 

Member Function Documentation

◆ calculateUValue()

bool VICUS::Construction::calculateUValue ( double &  UValue,
const VICUS::Database< Material > &  materials,
double  ri,
double  re 
) const

Computes the u-value.

◆ equal()

AbstractDBElement::ComparisonResult VICUS::Construction::equal ( const AbstractDBElement other) const
overridevirtual

Comparison operator

Implements VICUS::AbstractDBElement.

◆ isValid()

bool VICUS::Construction::isValid ( const VICUS::Database< VICUS::Material > &  materials) const

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

Member Data Documentation

◆ m_dataSource

IBK::MultiLanguageString VICUS::Construction::m_dataSource

Data source.

◆ m_insulationKind

InsulationKind VICUS::Construction::m_insulationKind = NUM_IK

The type of insulation used (classification property).

◆ m_materialKind

MaterialKind VICUS::Construction::m_materialKind = NUM_MK

The main/load bearing material (classification property).

◆ m_materialLayers

std::vector<MaterialLayer> VICUS::Construction::m_materialLayers

The individual material layers.

◆ m_notes

IBK::MultiLanguageString VICUS::Construction::m_notes

Notes.

◆ m_usageType

UsageType VICUS::Construction::m_usageType = NUM_UT

The usage type (classification property).


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