#include <AirflowNetworkOccupantVentilationControl.hpp>
Public Member Functions | |
Constructors and Destructors | |
AirflowNetworkOccupantVentilationControl (const Model &model, const Curve &curve) | |
Construct an occupant ventilation control object with a low temperature curve. More... | |
virtual | ~AirflowNetworkOccupantVentilationControl () |
Getters | |
double | minimumOpeningTime () const |
Returns the minimum opening time. More... | |
bool | isMinimumOpeningTimeDefaulted () const |
Returns true if the minimum opening time is defaulted. More... | |
double | minimumClosingTime () const |
Returns the minimum closing time. More... | |
bool | isMinimumClosingTimeDefaulted () const |
Returns true if the minimum closing time is defaulted. More... | |
Curve | thermalComfortLowTemperatureCurve () const |
Returns the low temperature thermal comfort curve. More... | |
double | thermalComfortTemperatureBoundaryPoint () const |
Returns the boundary temperature between the low and high temperature thermal comfort curves. More... | |
bool | isThermalComfortTemperatureBoundaryPointDefaulted () const |
Returns true if the boundary temperature is defaulted. More... | |
boost::optional< Curve > | thermalComfortHighTemperatureCurve () const |
Returns the high temperature thermal comfort curve. More... | |
double | maximumPredictedPercentageofDissatisfiedThreshold () const |
Returns the maximum PPD threshold. More... | |
bool | isMaximumPredictedPercentageofDissatisfiedThresholdDefaulted () const |
Returns true if the maximum PPD threshold is defaulted. More... | |
bool | occupancyCheck () const |
Returns true if an occupancy check is to be performed as part of the opening probability check. More... | |
bool | isOccupancyCheckDefaulted () const |
Returns true if the occupancy check is defaulted. More... | |
boost::optional< Schedule > | openingProbabilitySchedule () const |
Returns the opening probability schedule, if any. More... | |
boost::optional< Schedule > | closingProbabilitySchedule () const |
Returns the closing probability schedule, if any. More... | |
Setters | |
bool | setMinimumOpeningTime (double minimumOpeningTime) |
Sets the minimum opening time. More... | |
void | resetMinimumOpeningTime () |
Resets the minimum opening time. More... | |
bool | setMinimumClosingTime (double minimumClosingTime) |
Sets the minimum closing time. More... | |
void | resetMinimumClosingTime () |
Resets the minimum closing time. More... | |
bool | setThermalComfortLowTemperatureCurve (const Curve &curve) |
Sets the low temperature thermal comfort curve. More... | |
bool | setThermalComfortTemperatureBoundaryPoint (double thermalComfortTemperatureBoundaryPoint) |
Sets the temperature boundary point. More... | |
void | resetThermalComfortTemperatureBoundaryPoint () |
Resets the temperature boundary point. More... | |
bool | setThermalComfortHighTemperatureCurve (const Curve &curve) |
Sets the high temperature thermal comfort curve. More... | |
void | resetThermalComfortHighTemperatureCurve () |
Resets the high temperature thermal comfort curve. More... | |
bool | setMaximumPredictedPercentageofDissatisfiedThreshold (double maximumPredictedPercentageofDissatisfiedThreshold) |
Sets the maximum PPD threshold. More... | |
void | resetMaximumPredictedPercentageofDissatisfiedThreshold () |
Resets the maximum PPD threshold. More... | |
void | setOccupancyCheck (bool occupancyCheck) |
Sets the occupancy check. More... | |
void | resetOccupancyCheck () |
Resets the occupancy check. More... | |
bool | setOpeningProbabilitySchedule (Schedule &schedule) |
Sets the opening probability schedule. More... | |
void | resetOpeningProbabilitySchedule () |
Resets the opening probability schedule. More... | |
bool | setClosingProbabilitySchedule (Schedule &schedule) |
Sets the closing probability schedule. More... | |
void | resetClosingProbabilitySchedule () |
Resets the closing probability schedule. More... | |
![]() | |
virtual | ~ModelObject () |
ModelObject | clone () const |
Creates a deep copy of this object, placing it in this object's model(). More... | |
ModelObject | clone (Model model) const |
Creates a deep copy of this object, placing it in model. More... | |
Component | createComponent () const |
Method for creating sharable Model snippets. More... | |
Model | model () const |
Returns the Model that contains this object. More... | |
boost::optional< ParentObject > | parent () const |
Return this object's parent in the hierarchy, if it has one. More... | |
std::vector< ResourceObject > | resources () const |
Get the resources directly used by this ModelObject. More... | |
template<typename T > | |
std::vector< T > | getModelObjectSources () const |
Get all objects of type T that point to this object. More... | |
template<typename T > | |
std::vector< T > | getModelObjectSources (IddObjectType iddObjectType) const |
Get all objects of type T that point to this object. More... | |
template<typename T > | |
boost::optional< T > | getModelObjectTarget (unsigned index) const |
Get the object of type T pointed to by this object from field index. More... | |
template<typename T > | |
std::vector< T > | getModelObjectTargets () const |
Get all objects of type T to which this object points. More... | |
const std::vector< std::string > & | outputVariableNames () const |
Get all output variables names that could be associated with this object. More... | |
std::vector< OutputVariable > | outputVariables () const |
Get all output variables associated with this object, must run simulation to generate data. More... | |
boost::optional < openstudio::TimeSeries > | getData (const OutputVariable &variable, const std::string &envPeriod) const |
Get data associated with this output variable and this object. More... | |
std::vector< LifeCycleCost > | lifeCycleCosts () const |
Returns the list of all LifeCycleCosts that refer to this object. More... | |
std::vector< IdfObject > | removeLifeCycleCosts () |
Removes all LifeCycleCosts that refer to this object. More... | |
IddObjectType | iddObjectType () const |
This is a virtual function that will tell you the type of iddObject you are dealing with. More... | |
AdditionalProperties | additionalProperties () const |
Returns this object's additional properties, constructing a new object if necessary. More... | |
bool | hasAdditionalProperties () const |
Returns true if this object has additional properties. More... | |
std::vector< IdfObject > | removeAdditionalProperties () |
Removes all additional properties that refer to this object. More... | |
bool | setParent (ParentObject &newParent) |
set the parent, child may have to call non-const methods on the parent More... | |
bool | operator< (const ModelObject &right) const |
bool | operator== (const ModelObject &other) const |
equality test More... | |
bool | operator!= (const ModelObject &other) const |
inequality test More... | |
std::vector< ScheduleTypeKey > | getScheduleTypeKeys (const Schedule &schedule) const |
Return the ScheduleTypeKeys indicating how schedule is used in this object. More... | |
boost::optional< double > | getAutosizedValue (std::string valueName, std::string unitString) const |
Gets the autosized component value from the sql file. More... | |
virtual std::vector < EMSActuatorNames > | emsActuatorNames () const |
Return the names of the available ems actuators. More... | |
virtual std::vector< std::string > | emsInternalVariableNames () const |
Return the names of the available ems internal variables. More... | |
boost::optional< ModelObject > | connectedObject (unsigned port) const |
boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
![]() | |
bool | canBeSource () const |
bool | canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const |
std::vector< std::string > | canBeTarget () const |
std::vector< unsigned > | getSourceIndices (const Handle &targetHandle) const |
std::vector< WorkspaceObject > | getSources (IddObjectType type) const |
boost::optional< WorkspaceObject > | getTarget (unsigned index) const |
IdfObject | idfObject () |
IdfObject | idfObject () const |
bool | initialized () const |
bool | isSource () const |
bool | isTarget () const |
unsigned | numSources () const |
bool | objectListFieldsEqual (const WorkspaceObject &other) const |
bool | objectListFieldsNonConflicting (const WorkspaceObject &other) const |
bool | operator< (const WorkspaceObject &right) const |
std::ostream & | operator<< (std::ostream &os, const WorkspaceObject &workspaceObject) |
std::vector < openstudio::IdfObject > | remove () |
bool | setPointer (unsigned index, const Handle &targetHandle) |
std::vector< WorkspaceObject > | sources () const |
std::vector< WorkspaceObject > | targets () const |
Workspace | workspace () const |
virtual | ~WorkspaceObject () |
![]() | |
std::string | briefDescription () const |
T | cast () const |
std::vector< T > | castVector (const std::vector< U > &objects) |
std::vector< std::vector < std::string > > | clearExtensibleGroups () |
IdfObject | clone (bool keepHandle=false) const |
std::string | comment () const |
boost::optional< std::string > | createName (bool overwrite=true) |
std::vector< unsigned > | dataFields () const |
bool | dataFieldsEqual (const IdfObject &other) const |
std::vector< std::string > | eraseExtensibleGroup (unsigned groupIndex) |
std::vector< IdfExtensibleGroup > | extensibleGroups () const |
boost::optional< std::string > | fieldComment (unsigned index, bool returnDefault=false) const |
boost::optional< double > | getDouble (unsigned index, bool returnDefault=false) const |
IdfExtensibleGroup | getExtensibleGroup (unsigned groupIndex) const |
std::vector< Handle > | getHandles (const std::vector< T > &objects) |
boost::optional< int > | getInt (unsigned index, bool returnDefault=false) const |
OSOptionalQuantity | getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const |
boost::optional< std::string > | getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const |
boost::optional< unsigned > | getUnsigned (unsigned index, bool returnDefault=false) const |
boost::optional< QUrl > | getURL (unsigned index, bool returnDefault=false) const |
Handle | handle () const |
IddObject | iddObject () const |
IdfObject (IddObjectType type, bool fastName=false) | |
IdfObject (const IddObject &, bool fastName=false) | |
IdfObject (const IdfObject &other) | |
IdfExtensibleGroup | insertExtensibleGroup (unsigned groupIndex) |
IdfExtensibleGroup | insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values) |
bool | isDataField (unsigned index) const |
bool | isEmpty (unsigned index) const |
bool | isObjectListField (unsigned index) const |
bool | isValid (StrictnessLevel level, bool checkNames=false) const |
boost::optional< unsigned > | maxExtensibleGroups () const |
boost::optional< unsigned > | maxFields () const |
unsigned | minExtensibleGroups () const |
unsigned | minFields () const |
boost::optional< std::string > | name (bool returnDefault=false) const |
std::string | nameString (bool returnDefault=false) const |
unsigned | numExtensibleGroups () const |
unsigned | numFields () const |
unsigned | numNonextensibleFields () const |
std::vector< unsigned > | objectListFields () const |
bool | objectListFieldsEqual (const IdfObject &other) const |
bool | objectListFieldsNonConflicting (const IdfObject &other) const |
bool | operator!= (const IdfObject &other) const |
std::ostream & | operator<< (std::ostream &os, const IdfObject &IdfObject) |
bool | operator== (const IdfObject &other) const |
boost::optional< T > | optionalCast () const |
std::vector< std::string > | popExtensibleGroup () |
std::ostream & | print (std::ostream &os) const |
std::ostream & | printField (std::ostream &os, unsigned index, bool isLastField=false) const |
std::ostream & | printName (std::ostream &os, bool hasFields=true) const |
IdfExtensibleGroup | pushExtensibleGroup () |
IdfExtensibleGroup | pushExtensibleGroup (const std::vector< std::string > &values) |
std::vector< unsigned > | requiredFields () const |
void | setComment (const std::string &msg) |
bool | setDouble (unsigned index, double value) |
bool | setFieldComment (unsigned index, const std::string &cmnt) |
bool | setInt (unsigned index, int value) |
boost::optional< std::string > | setName (const std::string &newName) |
bool | setQuantity (unsigned index, const Quantity &q) |
bool | setString (unsigned index, const std::string &value) |
bool | setUnsigned (unsigned index, unsigned value) |
std::vector< T > | subsetCastVector (const std::vector< U > &original) |
ValidityReport | validityReport (StrictnessLevel level, bool checkNames=false) const |
virtual | ~IdfObject () |
Static Public Member Functions | |
static IddObjectType | iddObjectType () |
![]() | |
static boost::optional< IdfObject > | load (const std::string &text) |
static boost::optional< IdfObject > | load (const std::string &text, const IddObject &iddObject) |
static int | printedFieldSpace () |
Related Functions | |
(Note that these are not member functions.) | |
typedef std::vector < AirflowNetworkOccupantVentilationControl > | AirflowNetworkOccupantVentilationControlVector |
typedef boost::optional < AirflowNetworkOccupantVentilationControl > | OptionalAirflowNetworkOccupantVentilationControl |
![]() | |
std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
typedef std::pair< std::string, std::string > | ScheduleTypeKey |
Typedef for ScheduleTypeRegistry key. More... | |
Additional Inherited Members | |
![]() | |
typedef boost::optional < WorkspaceObject > | OptionalWorkspaceObject |
typedef std::vector < WorkspaceObject > | WorkspaceObjectVector |
![]() | |
typedef std::pair< IdfObject, IdfObject > | IdfObjectPair |
typedef std::vector< IdfObject > | IdfObjectVector |
typedef boost::optional < IdfObject > | OptionalIdfObject |
![]() | |
typedef detail::ModelObject_Impl | ImplType |
![]() | |
typedef detail::WorkspaceObject_Impl | ImplType |
![]() | |
typedef detail::IdfObject_Impl | ImplType |
![]() | |
ModelObject (IddObjectType type, const Model &model, bool fastName=false) | |
ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl) | |
![]() | |
WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl) | |
![]() | |
IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl) | |
AirflowNetworkOccupantVentilationControl is a ModelObject that wraps the OpenStudio IDD object 'OS:AirflowNetworkOccupantVentilationControl'.
openstudio::model::AirflowNetworkOccupantVentilationControl::AirflowNetworkOccupantVentilationControl | ( | const Model & | model, |
const Curve & | curve | ||
) |
Construct an occupant ventilation control object with a low temperature curve.
|
inlinevirtual |
boost::optional<Schedule> openstudio::model::AirflowNetworkOccupantVentilationControl::closingProbabilitySchedule | ( | ) | const |
Returns the closing probability schedule, if any.
|
static |
bool openstudio::model::AirflowNetworkOccupantVentilationControl::isMaximumPredictedPercentageofDissatisfiedThresholdDefaulted | ( | ) | const |
Returns true if the maximum PPD threshold is defaulted.
bool openstudio::model::AirflowNetworkOccupantVentilationControl::isMinimumClosingTimeDefaulted | ( | ) | const |
Returns true if the minimum closing time is defaulted.
bool openstudio::model::AirflowNetworkOccupantVentilationControl::isMinimumOpeningTimeDefaulted | ( | ) | const |
Returns true if the minimum opening time is defaulted.
bool openstudio::model::AirflowNetworkOccupantVentilationControl::isOccupancyCheckDefaulted | ( | ) | const |
Returns true if the occupancy check is defaulted.
bool openstudio::model::AirflowNetworkOccupantVentilationControl::isThermalComfortTemperatureBoundaryPointDefaulted | ( | ) | const |
Returns true if the boundary temperature is defaulted.
double openstudio::model::AirflowNetworkOccupantVentilationControl::maximumPredictedPercentageofDissatisfiedThreshold | ( | ) | const |
Returns the maximum PPD threshold.
double openstudio::model::AirflowNetworkOccupantVentilationControl::minimumClosingTime | ( | ) | const |
Returns the minimum closing time.
double openstudio::model::AirflowNetworkOccupantVentilationControl::minimumOpeningTime | ( | ) | const |
Returns the minimum opening time.
bool openstudio::model::AirflowNetworkOccupantVentilationControl::occupancyCheck | ( | ) | const |
Returns true if an occupancy check is to be performed as part of the opening probability check.
boost::optional<Schedule> openstudio::model::AirflowNetworkOccupantVentilationControl::openingProbabilitySchedule | ( | ) | const |
Returns the opening probability schedule, if any.
void openstudio::model::AirflowNetworkOccupantVentilationControl::resetClosingProbabilitySchedule | ( | ) |
Resets the closing probability schedule.
void openstudio::model::AirflowNetworkOccupantVentilationControl::resetMaximumPredictedPercentageofDissatisfiedThreshold | ( | ) |
Resets the maximum PPD threshold.
void openstudio::model::AirflowNetworkOccupantVentilationControl::resetMinimumClosingTime | ( | ) |
Resets the minimum closing time.
void openstudio::model::AirflowNetworkOccupantVentilationControl::resetMinimumOpeningTime | ( | ) |
Resets the minimum opening time.
void openstudio::model::AirflowNetworkOccupantVentilationControl::resetOccupancyCheck | ( | ) |
Resets the occupancy check.
void openstudio::model::AirflowNetworkOccupantVentilationControl::resetOpeningProbabilitySchedule | ( | ) |
Resets the opening probability schedule.
void openstudio::model::AirflowNetworkOccupantVentilationControl::resetThermalComfortHighTemperatureCurve | ( | ) |
Resets the high temperature thermal comfort curve.
void openstudio::model::AirflowNetworkOccupantVentilationControl::resetThermalComfortTemperatureBoundaryPoint | ( | ) |
Resets the temperature boundary point.
bool openstudio::model::AirflowNetworkOccupantVentilationControl::setClosingProbabilitySchedule | ( | Schedule & | schedule | ) |
Sets the closing probability schedule.
bool openstudio::model::AirflowNetworkOccupantVentilationControl::setMaximumPredictedPercentageofDissatisfiedThreshold | ( | double | maximumPredictedPercentageofDissatisfiedThreshold | ) |
Sets the maximum PPD threshold.
bool openstudio::model::AirflowNetworkOccupantVentilationControl::setMinimumClosingTime | ( | double | minimumClosingTime | ) |
Sets the minimum closing time.
bool openstudio::model::AirflowNetworkOccupantVentilationControl::setMinimumOpeningTime | ( | double | minimumOpeningTime | ) |
Sets the minimum opening time.
void openstudio::model::AirflowNetworkOccupantVentilationControl::setOccupancyCheck | ( | bool | occupancyCheck | ) |
Sets the occupancy check.
bool openstudio::model::AirflowNetworkOccupantVentilationControl::setOpeningProbabilitySchedule | ( | Schedule & | schedule | ) |
Sets the opening probability schedule.
bool openstudio::model::AirflowNetworkOccupantVentilationControl::setThermalComfortHighTemperatureCurve | ( | const Curve & | curve | ) |
Sets the high temperature thermal comfort curve.
bool openstudio::model::AirflowNetworkOccupantVentilationControl::setThermalComfortLowTemperatureCurve | ( | const Curve & | curve | ) |
Sets the low temperature thermal comfort curve.
bool openstudio::model::AirflowNetworkOccupantVentilationControl::setThermalComfortTemperatureBoundaryPoint | ( | double | thermalComfortTemperatureBoundaryPoint | ) |
Sets the temperature boundary point.
boost::optional<Curve> openstudio::model::AirflowNetworkOccupantVentilationControl::thermalComfortHighTemperatureCurve | ( | ) | const |
Returns the high temperature thermal comfort curve.
Curve openstudio::model::AirflowNetworkOccupantVentilationControl::thermalComfortLowTemperatureCurve | ( | ) | const |
Returns the low temperature thermal comfort curve.
double openstudio::model::AirflowNetworkOccupantVentilationControl::thermalComfortTemperatureBoundaryPoint | ( | ) | const |
Returns the boundary temperature between the low and high temperature thermal comfort curves.
|
related |
|
related |