VICUS Library
Documentation of Vicus library
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
VICUS::Infiltration Class Reference

#include <VICUS_Infiltration.h>

Inheritance diagram for VICUS::Infiltration:
[legend]

Public Types

enum  para_t { P_AirChangeRate , P_ShieldingCoefficient , NUM_P }
 
enum  AirChangeType { AC_normal , AC_n50 , NUM_AC }
 
- Public Types inherited from VICUS::AbstractDBElement
enum  ComparisonResult { Equal , OnlyMetaDataDiffers , Different }
 

Public Member Functions

VICUS_READWRITE_OVERRIDE VICUS_COMPARE_WITH_ID bool isValid () 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

AirChangeType m_airChangeType = NUM_AC
 
IBK::Parameter m_para [NUM_P]
 
- 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

Infiltration model parameters.

Member Enumeration Documentation

◆ AirChangeType

enum VICUS::Infiltration::AirChangeType

Air Change Type.

Enumerator
AC_normal 
AC_n50 
NUM_AC 

◆ para_t

enum VICUS::Infiltration::para_t

Basic parameters.

Enumerator
P_AirChangeRate 

Air change rate.

P_ShieldingCoefficient 

Shielding coefficient, needed for air change model type 'n50'

NUM_P 

Member Function Documentation

◆ equal()

AbstractDBElement::ComparisonResult VICUS::Infiltration::equal ( const AbstractDBElement *  other) const
overridevirtual

Comparison operator

Implements VICUS::AbstractDBElement.

◆ isValid()

bool VICUS::Infiltration::isValid ( ) const

Checks if all parameters are valid.

Member Data Documentation

◆ m_airChangeType

AirChangeType VICUS::Infiltration::m_airChangeType = NUM_AC

Air change type.

◆ m_para

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

List of parameters.

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