NANDRAD Data Model Library  Version 2.0
NANDRAD
NANDRAD::Thermostat Class Reference

Detailed Description

Contains data for a thermostat model, that compares the air/operative tempeature with a setpoint and generates either an analog or digital control signal.

The latter always uses hysteresis.

Definition at line 36 of file NANDRAD_Thermostat.h.

#include <NANDRAD_Thermostat.h>

Public Types

enum  modelType_t { MT_Constant, MT_Scheduled, NUM_MT }
 Different model variants regarding source of setpoint parametrization. More...
 
enum  para_t {
  P_HeatingSetpoint, P_CoolingSetpoint, P_TemperatureTolerance, P_TemperatureBand,
  NUM_P
}
 Model parameters. More...
 
enum  TemperatureType { TT_AirTemperature, TT_OperativeTemperature, NUM_TT }
 Control temperature to use. More...
 
enum  ControllerType { CT_Analog, CT_Digital, NUM_CT }
 

Public Member Functions

NANDRAD_READWRITE NANDRAD_COMPARE_WITH_ID void checkParameters () const
 Checks parameters for valid values. More...
 
bool equal (const Thermostat &other) const
 Comparies objects by physical parametrization (excluding ID and displayname and object list). More...
 

Public Attributes

unsigned int m_id = NANDRAD::INVALID_ID
 Unique ID-number for this ventilation rate model. More...
 
std::string m_displayName
 Some display/comment name for this model (optional). More...
 
modelType_t m_modelType = NUM_MT
 Model type. More...
 
std::string m_zoneObjectList
 Object list with zones that this model is to be apply to. More...
 
IBK::Parameter m_para [NUM_P]
 Model parameters. More...
 
unsigned int m_referenceZoneId = NANDRAD::INVALID_ID
 Optional ID of reference zone to use for sensor and setpoint input. More...
 
TemperatureType m_temperatureType = NUM_TT
 Temperature sensor type. More...
 
ControllerType m_controllerType = NUM_CT
 The controller to use for the thermostat. More...
 

Member Enumeration Documentation

◆ modelType_t

Different model variants regarding source of setpoint parametrization.

Enumerator
MT_Constant 

Setpoints are constant parameters.

MT_Scheduled 

Setpoints are provided as 'HeatingSetPointSchedule' and 'CoolingSetPointSchedule' schedule parameter.

Definition at line 39 of file NANDRAD_Thermostat.h.

◆ para_t

Model parameters.

Definition at line 48 of file NANDRAD_Thermostat.h.

◆ TemperatureType

Control temperature to use.

Definition at line 57 of file NANDRAD_Thermostat.h.

◆ ControllerType

Enumerator
CT_Analog 

Signal is the difference between setpoint temperature and sensor temperature, normalized by the given temperature tolerance.

A signal value of 1 means that the temperature tolerance has been reached, a value larger than 1 means the temperature difference is even larger (signal value is not clipped).

CT_Digital 

Signal is either 0 or 1, and corresponds with the digital hysteretic control logic.

1 is returned if heating/cooling is required.

Definition at line 63 of file NANDRAD_Thermostat.h.

Member Function Documentation

◆ checkParameters()

NANDRAD_READWRITE NANDRAD_COMPARE_WITH_ID void NANDRAD::Thermostat::checkParameters ( ) const

Checks parameters for valid values.

◆ equal()

bool NANDRAD::Thermostat::equal ( const Thermostat other) const

Comparies objects by physical parametrization (excluding ID and displayname and object list).

Member Data Documentation

◆ m_id

unsigned int NANDRAD::Thermostat::m_id = NANDRAD::INVALID_ID

Unique ID-number for this ventilation rate model.

Definition at line 86 of file NANDRAD_Thermostat.h.

◆ m_displayName

std::string NANDRAD::Thermostat::m_displayName

Some display/comment name for this model (optional).

Definition at line 88 of file NANDRAD_Thermostat.h.

◆ m_modelType

modelType_t NANDRAD::Thermostat::m_modelType = NUM_MT

Model type.

Definition at line 91 of file NANDRAD_Thermostat.h.

◆ m_zoneObjectList

std::string NANDRAD::Thermostat::m_zoneObjectList

Object list with zones that this model is to be apply to.

Definition at line 94 of file NANDRAD_Thermostat.h.

◆ m_para

IBK::Parameter NANDRAD::Thermostat::m_para[NUM_P]

Model parameters.

Definition at line 97 of file NANDRAD_Thermostat.h.

◆ m_referenceZoneId

unsigned int NANDRAD::Thermostat::m_referenceZoneId = NANDRAD::INVALID_ID

Optional ID of reference zone to use for sensor and setpoint input.

Definition at line 100 of file NANDRAD_Thermostat.h.

◆ m_temperatureType

TemperatureType NANDRAD::Thermostat::m_temperatureType = NUM_TT

Temperature sensor type.

Definition at line 103 of file NANDRAD_Thermostat.h.

◆ m_controllerType

ControllerType NANDRAD::Thermostat::m_controllerType = NUM_CT

The controller to use for the thermostat.

Definition at line 106 of file NANDRAD_Thermostat.h.


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