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

#include <VICUS_SubSurfaceComponent.h>

Inheritance diagram for VICUS::SubSurfaceComponent:
[legend]

Public Types

enum  SubSurfaceComponentType { CT_Window , CT_Door , 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< VICUS::Window > &windows, const VICUS::Database< VICUS::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

SubSurfaceComponentType m_type = CT_Miscellaneous
 
unsigned int m_idWindow = INVALID_ID
 
unsigned int m_idConstruction = INVALID_ID
 
unsigned int m_idSideABoundaryCondition = INVALID_ID
 
unsigned int m_idSideBBoundaryCondition = 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

◆ SubSurfaceComponentType

SubSurfaceComponent types.

Enumerator
CT_Window 
CT_Door 
CT_Miscellaneous 
NUM_CT 

Member Function Documentation

◆ equal()

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

Comparison operator

Implements VICUS::AbstractDBElement.

◆ isValid()

bool VICUS::SubSurfaceComponent::isValid ( const VICUS::Database< VICUS::Window > &  windows,
const VICUS::Database< VICUS::BoundaryCondition > &  bcs,
const VICUS::Database< Schedule > &  scheduleDB 
) const

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

Member Data Documentation

◆ m_idConstruction

unsigned int VICUS::SubSurfaceComponent::m_idConstruction = INVALID_ID

Construction type ID in case of opaque component/door (used for all types but CT_Window).

◆ m_idSideABoundaryCondition

unsigned int VICUS::SubSurfaceComponent::m_idSideABoundaryCondition = INVALID_ID

Boundary condition ID for Side A (usually outside).

◆ m_idSideBBoundaryCondition

unsigned int VICUS::SubSurfaceComponent::m_idSideBBoundaryCondition = INVALID_ID

Boundary condition ID for Side B (usually inside).

◆ m_idWindow

unsigned int VICUS::SubSurfaceComponent::m_idWindow = INVALID_ID

Transparent construction ID (used for CT_Window).

◆ m_type

SubSurfaceComponentType VICUS::SubSurfaceComponent::m_type = CT_Miscellaneous

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