Detailed Description
Parameters for a intensity controlled shading model with hysteresis.
Definition at line 37 of file NANDRAD_ShadingControlModel.h.
#include <NANDRAD_ShadingControlModel.h>
Public Types | |
| enum | para_t { P_MaxIntensity, P_MinIntensity, NUM_P } |
| Model parameters. More... | |
Public Member Functions | |
| NANDRAD_READWRITE_IFNOT_INVALID_ID NANDRAD_COMPARE_WITH_ID void | checkParameters (const std::vector< Sensor > &sensors, const std::vector< ConstructionInstance > &conInstances) |
| Checks for valid and required parameters (value ranges). More... | |
Public Attributes | |
| unsigned int | m_id = NANDRAD::INVALID_ID |
| Unique ID-number for this shading controller model. More... | |
| std::string | m_displayName |
| Some display/comment name for this model (optional). More... | |
| unsigned int | m_sensorId = NANDRAD::INVALID_ID |
| Sensor ID of global radiation sensor, or window/construction surface. More... | |
| IBK::Parameter | m_para [NUM_P] |
| Model parameters. More... | |
| const NANDRAD::Sensor * | m_sensor = nullptr |
| Quick-access pointer to the requested sensor. More... | |
| const NANDRAD::ConstructionInstance * | m_constructionInstance = nullptr |
| Quick-access pointer to the referenced construction. More... | |
| const NANDRAD::EmbeddedObject * | m_embeddedObject = nullptr |
| Quick-access pointer to the referenced embedded object. More... | |
Member Enumeration Documentation
◆ para_t
Model parameters.
Definition at line 41 of file NANDRAD_ShadingControlModel.h.
Member Function Documentation
◆ checkParameters()
| NANDRAD_READWRITE_IFNOT_INVALID_ID NANDRAD_COMPARE_WITH_ID void NANDRAD::ShadingControlModel::checkParameters | ( | const std::vector< Sensor > & | sensors, |
| const std::vector< ConstructionInstance > & | conInstances | ||
| ) |
Checks for valid and required parameters (value ranges).
Also check if referenced sensors/constructions/embedded objects exists.
Member Data Documentation
◆ m_id
| unsigned int NANDRAD::ShadingControlModel::m_id = NANDRAD::INVALID_ID |
Unique ID-number for this shading controller model.
Definition at line 57 of file NANDRAD_ShadingControlModel.h.
◆ m_displayName
| std::string NANDRAD::ShadingControlModel::m_displayName |
Some display/comment name for this model (optional).
Definition at line 59 of file NANDRAD_ShadingControlModel.h.
◆ m_sensorId
| unsigned int NANDRAD::ShadingControlModel::m_sensorId = NANDRAD::INVALID_ID |
Sensor ID of global radiation sensor, or window/construction surface.
This sensor corresponds to any surface in the model (sensor, embedded object, construction).
Definition at line 64 of file NANDRAD_ShadingControlModel.h.
◆ m_para
| IBK::Parameter NANDRAD::ShadingControlModel::m_para[NUM_P] |
Model parameters.
Definition at line 67 of file NANDRAD_ShadingControlModel.h.
◆ m_sensor
| const NANDRAD::Sensor* NANDRAD::ShadingControlModel::m_sensor = nullptr |
Quick-access pointer to the requested sensor.
Definition at line 70 of file NANDRAD_ShadingControlModel.h.
◆ m_constructionInstance
| const NANDRAD::ConstructionInstance* NANDRAD::ShadingControlModel::m_constructionInstance = nullptr |
Quick-access pointer to the referenced construction.
Definition at line 72 of file NANDRAD_ShadingControlModel.h.
◆ m_embeddedObject
| const NANDRAD::EmbeddedObject* NANDRAD::ShadingControlModel::m_embeddedObject = nullptr |
Quick-access pointer to the referenced embedded object.
Definition at line 74 of file NANDRAD_ShadingControlModel.h.
The documentation for this class was generated from the following file:
