 |
OpenStudio:model |
#include <AirflowNetworkSurface.hpp>
Inheritance diagram for openstudio::model::AirflowNetworkSurface:Public Member Functions | |
Constructors and Destructors | |
| virtual | ~AirflowNetworkSurface () |
| Construct a surface with a model surface to be linked to. More... | |
Getters | |
| PlanarSurface | surface () const |
| Returns the planar surface associated with this object. More... | |
| boost::optional < AirflowNetworkComponent > | leakageComponent () const |
| Returns the leakage component associated with the surface, if any. More... | |
| boost::optional < AirflowNetworkExternalNode > | externalNode () const |
| Returns the external node associated with this surface, if any. More... | |
| double | windowDoorOpeningFactorOrCrackFactor () const |
| Returns the window opening, door opening, or crack factor for this object. More... | |
| bool | isWindowDoorOpeningFactorOrCrackFactorDefaulted () const |
| Returns true if the window opening, door opening, or crack factor for this object is defaulted. More... | |
| std::string | ventilationControlMode () const |
| Returns the ventilation control mode for this object. More... | |
| bool | isVentilationControlModeDefaulted () const |
| Returns true if the ventilation control mode for this object is defaulted. More... | |
| boost::optional< Schedule > | ventilationControlZoneTemperatureSetpointSchedule () const |
| Returns the ventilation control schedule if this object has one. More... | |
| double | minimumVentingOpenFactor () const |
| Returns the minimum venting open factor for this object. More... | |
| bool | isMinimumVentingOpenFactorDefaulted () const |
| Returns true if the minimum venting open factor for this object is defaulted. More... | |
| double | indoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor () const |
| Returns the lower limit indoor/outdoor temperature difference. More... | |
| bool | isIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactorDefaulted () const |
| Returns true if the lower limit indoor/outdoor temperature difference is defaulted. More... | |
| double | indoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor () const |
| Returns the upper limit indoor/outdoor temperature difference. More... | |
| bool | isIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactorDefaulted () const |
| Returns true if the upper limit indoor/outdoor temperature difference is defaulted. More... | |
| double | indoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor () const |
| Returns the lower limit indoor/outdoor enthalpy difference. More... | |
| bool | isIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactorDefaulted () const |
| Returns true if the lower limit indoor/outdoor enthalpy difference is defaulted. More... | |
| double | indoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor () const |
| Returns the upper limit indoor/outdoor enthalpy difference. More... | |
| bool | isIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactorDefaulted () const |
| Returns true if the upper limit indoor/outdoor enthalpy difference is defaulted. More... | |
| boost::optional< Schedule > | ventingAvailabilitySchedule () const |
| Returns the venting availability for this surface, if any. More... | |
| boost::optional < AirflowNetworkOccupantVentilationControl > | occupantVentilationControl () const |
| Returns the ventilation control object associated with this surface, if any. More... | |
Setters | |
| bool | setLeakageComponent (const AirflowNetworkComponent &surfaceAirflowLeakage) |
| Set the component associated with this surface. More... | |
| bool | setExternalNode (const AirflowNetworkExternalNode &externalNode) |
| Set the external node associated with this surface. More... | |
| void | resetExternalNode () |
| Remove the external node currently associated with this surface. More... | |
| bool | setWindowDoorOpeningFactorOrCrackFactor (double windowDoorOpeningFactorOrCrackFactor) |
| Sets the opening factor/crack factor. More... | |
| void | resetWindowDoorOpeningFactorOrCrackFactor () |
| Resets the opening factor/crack factor. More... | |
| bool | setVentilationControlMode (const std::string &ventilationControlMode) |
| Sets the ventilation control mode. More... | |
| void | resetVentilationControlMode () |
| Resets the ventilation control mode. More... | |
| bool | setVentilationControlZoneTemperatureSetpointSchedule (Schedule &schedule) |
| Sets the control setpoint schedule. More... | |
| void | resetVentilationControlZoneTemperatureSetpointSchedule () |
| Resets the control setpoint schedule. More... | |
| bool | setMinimumVentingOpenFactor (double minimumVentingOpenFactor) |
| Sets the minimum venting open schedule. More... | |
| void | resetMinimumVentingOpenFactor () |
| Reets the minimum venting open schedule. More... | |
| bool | setIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor (double indoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor) |
| Sets the lower limit indoor/outdoor temperature difference. More... | |
| void | resetIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor () |
| Resets the lower limit indoor/outdoor temperature difference. More... | |
| bool | setIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor (double indoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor) |
| Sets the upper limit indoor/outdoor temperature difference. More... | |
| void | resetIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor () |
| Resets the upper limit indoor/outdoor temperature difference. More... | |
| bool | setIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor (double indoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor) |
| Sets the lower limit indoor/outdoor enthalpy difference. More... | |
| void | resetIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor () |
| Resets the upper limit indoor/outdoor temperature difference. More... | |
| bool | setIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor (double indoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor) |
| Sets the upper limit indoor/outdoor enthalpy difference. More... | |
| void | resetIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor () |
| Resets the upper limit indoor/outdoor enthalpy difference. More... | |
| bool | setVentingAvailabilitySchedule (Schedule &schedule) |
| Sets the venting availabilty schedule. More... | |
| void | resetVentingAvailabilitySchedule () |
| Resets the venting availabilty schedule. More... | |
| bool | setOccupantVentilationControl (const AirflowNetworkOccupantVentilationControl &airflowNetworkOccupantVentilationControl) |
| Set the occupant ventilation control object for this surface. More... | |
| void | resetOccupantVentilationControl () |
| Reset the occupant ventilation control object. More... | |
| Public Member Functions inherited from openstudio::model::AirflowNetworkLinkage | |
| AirflowNetworkLinkage (IddObjectType type, const Model &model) | |
| virtual | ~AirflowNetworkLinkage () |
| Public Member Functions inherited from openstudio::model::ModelObject | |
| 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... | |
| boost::optional< std::string > | cadObjectId () const |
| bool | setCADObjectId (const std::string &cadObjectId) |
| boost::optional< std::string > | gbXMLId () const |
| bool | setGBXMLId (const std::string &gbXMLId) |
| boost::optional< std::string > | displayName () const |
| bool | setDisplayName (const std::string &displayName) |
| 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 |
Static Public Member Functions | |
| static IddObjectType | iddObjectType () |
| static std::vector< std::string > | ventilationControlModeValues () |
Related Functions | |
(Note that these are not member functions.) | |
| typedef std::vector < AirflowNetworkSurface > | AirflowNetworkSurfaceVector |
| typedef boost::optional < AirflowNetworkSurface > | OptionalAirflowNetworkSurface |
| Related Functions inherited from openstudio::model::ModelObject | |
| std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
| Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
Additional Inherited Members | |
| Protected Types inherited from openstudio::model::ModelObject | |
| typedef detail::ModelObject_Impl | ImplType |
| Protected Member Functions inherited from openstudio::model::ModelObject | |
| ModelObject (IddObjectType type, const Model &model, bool fastName=false) | |
| ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl) | |
AirflowNetworkSurface is a AirflowNetworkLinkage that wraps the OpenStudio IDD object 'OS:AirflowNetwork:Surface'.
|
inlinevirtual |
Construct a surface with a model surface to be linked to.
AirflowNetworkSurface(const Model& model, const Surface &surface); Construct a surface with a model subsurface to be linked to. Construct a surface with a model surface to be linked to and a leakage component. Construct a surface with a model subsurface to be linked to and a leakage component.
| boost::optional<AirflowNetworkExternalNode> openstudio::model::AirflowNetworkSurface::externalNode | ( | ) | const |
Returns the external node associated with this surface, if any.
|
static |
| double openstudio::model::AirflowNetworkSurface::indoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor | ( | ) | const |
Returns the lower limit indoor/outdoor enthalpy difference.
| double openstudio::model::AirflowNetworkSurface::indoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor | ( | ) | const |
Returns the upper limit indoor/outdoor enthalpy difference.
| double openstudio::model::AirflowNetworkSurface::indoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor | ( | ) | const |
Returns the lower limit indoor/outdoor temperature difference.
| double openstudio::model::AirflowNetworkSurface::indoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor | ( | ) | const |
Returns the upper limit indoor/outdoor temperature difference.
| bool openstudio::model::AirflowNetworkSurface::isIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactorDefaulted | ( | ) | const |
Returns true if the lower limit indoor/outdoor enthalpy difference is defaulted.
| bool openstudio::model::AirflowNetworkSurface::isIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactorDefaulted | ( | ) | const |
Returns true if the upper limit indoor/outdoor enthalpy difference is defaulted.
| bool openstudio::model::AirflowNetworkSurface::isIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactorDefaulted | ( | ) | const |
Returns true if the lower limit indoor/outdoor temperature difference is defaulted.
| bool openstudio::model::AirflowNetworkSurface::isIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactorDefaulted | ( | ) | const |
Returns true if the upper limit indoor/outdoor temperature difference is defaulted.
| bool openstudio::model::AirflowNetworkSurface::isMinimumVentingOpenFactorDefaulted | ( | ) | const |
Returns true if the minimum venting open factor for this object is defaulted.
| bool openstudio::model::AirflowNetworkSurface::isVentilationControlModeDefaulted | ( | ) | const |
Returns true if the ventilation control mode for this object is defaulted.
| bool openstudio::model::AirflowNetworkSurface::isWindowDoorOpeningFactorOrCrackFactorDefaulted | ( | ) | const |
Returns true if the window opening, door opening, or crack factor for this object is defaulted.
| boost::optional<AirflowNetworkComponent> openstudio::model::AirflowNetworkSurface::leakageComponent | ( | ) | const |
Returns the leakage component associated with the surface, if any.
| double openstudio::model::AirflowNetworkSurface::minimumVentingOpenFactor | ( | ) | const |
Returns the minimum venting open factor for this object.
| boost::optional<AirflowNetworkOccupantVentilationControl> openstudio::model::AirflowNetworkSurface::occupantVentilationControl | ( | ) | const |
Returns the ventilation control object associated with this surface, if any.
| void openstudio::model::AirflowNetworkSurface::resetExternalNode | ( | ) |
Remove the external node currently associated with this surface.
| void openstudio::model::AirflowNetworkSurface::resetIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor | ( | ) |
Resets the upper limit indoor/outdoor temperature difference.
| void openstudio::model::AirflowNetworkSurface::resetIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor | ( | ) |
Resets the upper limit indoor/outdoor enthalpy difference.
| void openstudio::model::AirflowNetworkSurface::resetIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor | ( | ) |
Resets the lower limit indoor/outdoor temperature difference.
| void openstudio::model::AirflowNetworkSurface::resetIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor | ( | ) |
Resets the upper limit indoor/outdoor temperature difference.
| void openstudio::model::AirflowNetworkSurface::resetMinimumVentingOpenFactor | ( | ) |
Reets the minimum venting open schedule.
| void openstudio::model::AirflowNetworkSurface::resetOccupantVentilationControl | ( | ) |
Reset the occupant ventilation control object.
| void openstudio::model::AirflowNetworkSurface::resetVentilationControlMode | ( | ) |
Resets the ventilation control mode.
| void openstudio::model::AirflowNetworkSurface::resetVentilationControlZoneTemperatureSetpointSchedule | ( | ) |
Resets the control setpoint schedule.
| void openstudio::model::AirflowNetworkSurface::resetVentingAvailabilitySchedule | ( | ) |
Resets the venting availabilty schedule.
| void openstudio::model::AirflowNetworkSurface::resetWindowDoorOpeningFactorOrCrackFactor | ( | ) |
Resets the opening factor/crack factor.
| bool openstudio::model::AirflowNetworkSurface::setExternalNode | ( | const AirflowNetworkExternalNode & | externalNode | ) |
Set the external node associated with this surface.
| bool openstudio::model::AirflowNetworkSurface::setIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor | ( | double | indoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor | ) |
Sets the lower limit indoor/outdoor enthalpy difference.
| bool openstudio::model::AirflowNetworkSurface::setIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor | ( | double | indoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor | ) |
Sets the upper limit indoor/outdoor enthalpy difference.
| bool openstudio::model::AirflowNetworkSurface::setIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor | ( | double | indoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor | ) |
Sets the lower limit indoor/outdoor temperature difference.
| bool openstudio::model::AirflowNetworkSurface::setIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor | ( | double | indoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor | ) |
Sets the upper limit indoor/outdoor temperature difference.
| bool openstudio::model::AirflowNetworkSurface::setLeakageComponent | ( | const AirflowNetworkComponent & | surfaceAirflowLeakage | ) |
Set the component associated with this surface.
| bool openstudio::model::AirflowNetworkSurface::setMinimumVentingOpenFactor | ( | double | minimumVentingOpenFactor | ) |
Sets the minimum venting open schedule.
| bool openstudio::model::AirflowNetworkSurface::setOccupantVentilationControl | ( | const AirflowNetworkOccupantVentilationControl & | airflowNetworkOccupantVentilationControl | ) |
Set the occupant ventilation control object for this surface.
| bool openstudio::model::AirflowNetworkSurface::setVentilationControlMode | ( | const std::string & | ventilationControlMode | ) |
Sets the ventilation control mode.
| bool openstudio::model::AirflowNetworkSurface::setVentilationControlZoneTemperatureSetpointSchedule | ( | Schedule & | schedule | ) |
Sets the control setpoint schedule.
| bool openstudio::model::AirflowNetworkSurface::setVentingAvailabilitySchedule | ( | Schedule & | schedule | ) |
Sets the venting availabilty schedule.
| bool openstudio::model::AirflowNetworkSurface::setWindowDoorOpeningFactorOrCrackFactor | ( | double | windowDoorOpeningFactorOrCrackFactor | ) |
Sets the opening factor/crack factor.
| PlanarSurface openstudio::model::AirflowNetworkSurface::surface | ( | ) | const |
Returns the planar surface associated with this object.
| std::string openstudio::model::AirflowNetworkSurface::ventilationControlMode | ( | ) | const |
Returns the ventilation control mode for this object.
|
static |
| boost::optional<Schedule> openstudio::model::AirflowNetworkSurface::ventilationControlZoneTemperatureSetpointSchedule | ( | ) | const |
Returns the ventilation control schedule if this object has one.
| boost::optional<Schedule> openstudio::model::AirflowNetworkSurface::ventingAvailabilitySchedule | ( | ) | const |
Returns the venting availability for this surface, if any.
| double openstudio::model::AirflowNetworkSurface::windowDoorOpeningFactorOrCrackFactor | ( | ) | const |
Returns the window opening, door opening, or crack factor for this object.
|
related |
|
related |