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

#include <VICUS_ZoneControlShading.h>

Inheritance diagram for VICUS::ZoneControlShading:
[legend]

Public Types

enum  para_t {
  P_GlobalHorizontal , P_GlobalNorth , P_GlobalEast , P_GlobalSouth ,
  P_GlobalWest , P_DeadBand , NUM_P
}
 
enum  Category { C_GlobalHorizontalSensor , C_GlobalHorizontalAndVerticalSensors , NUM_C }
 
- 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

IBK::MultiLanguageString m_notes
 
IBK::MultiLanguageString m_dataSource
 
Category m_category = NUM_C
 
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

Zone control parameters for dynamic shading.

Member Enumeration Documentation

◆ Category

Categories.

Enumerator
C_GlobalHorizontalSensor 
C_GlobalHorizontalAndVerticalSensors 
NUM_C 

◆ para_t

Basic parameters.

Enumerator
P_GlobalHorizontal 

Global horizontal (upper) sensor value.

P_GlobalNorth 

Global north (upper) sensor value.

P_GlobalEast 

Global east (upper) sensor value.

P_GlobalSouth 

Global south (upper) sensor value.

P_GlobalWest 

Global west (upper) sensor value.

P_DeadBand 

Dead band value.

NUM_P 

Member Function Documentation

◆ equal()

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

Comparison operator

Implements VICUS::AbstractDBElement.

◆ isValid()

bool VICUS::ZoneControlShading::isValid ( ) const

Checks if all parameters are valid.

Member Data Documentation

◆ m_category

Category VICUS::ZoneControlShading::m_category = NUM_C

Category.

◆ m_dataSource

IBK::MultiLanguageString VICUS::ZoneControlShading::m_dataSource

Data source.

◆ m_notes

IBK::MultiLanguageString VICUS::ZoneControlShading::m_notes

Notes.

◆ m_para

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

List of parameters.


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