OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Static Public Member Functions | Related Functions | List of all members
openstudio::model::FanOnOff Class Reference

#include <FanOnOff.hpp>

+ Inheritance diagram for openstudio::model::FanOnOff:

Public Member Functions

Constructors and Destructors
 FanOnOff (const Model &model, Schedule &availabilitySchedule, Curve &fanPowerRatioFunctionofSpeedRatioCurve, Curve &fanEfficiencyRatioFunctionofSpeedRatioCurve)
 
 FanOnOff (const Model &model, Schedule &availabilitySchedule)
 
 FanOnOff (const Model &model)
 
virtual ~FanOnOff ()=default
 
 FanOnOff (const FanOnOff &other)=default
 
 FanOnOff (FanOnOff &&other)=default
 
FanOnOffoperator= (const FanOnOff &)=default
 
FanOnOffoperator= (FanOnOff &&)=default
 
Getters
Schedule availabilitySchedule () const
 
double fanTotalEfficiency () const
 
bool isFanTotalEfficiencyDefaulted () const
 
double fanEfficiency () const
 Deprecrated in favor of fanTotalEfficiency. More...
 
bool isFanEfficiencyDefaulted () const
 
double pressureRise () const
 
boost::optional< double > maximumFlowRate () const
 
bool isMaximumFlowRateAutosized () const
 
double motorEfficiency () const
 
bool isMotorEfficiencyDefaulted () const
 
boost::optional< double > motorInAirstreamFraction () const
 
std::string endUseSubcategory () const
 
bool isEndUseSubcategoryDefaulted () const
 
Setters
bool setAvailabilitySchedule (Schedule &schedule)
 
bool setFanTotalEfficiency (double fanTotalEfficiency)
 
void resetFanTotalEfficiency ()
 
bool setFanEfficiency (double fanTotalEfficiency)
 
void resetFanEfficiency ()
 
bool setPressureRise (double pressureRise)
 
bool setMaximumFlowRate (double maximumFlowRate)
 
void resetMaximumFlowRate ()
 
void autosizeMaximumFlowRate ()
 
bool setMotorEfficiency (double motorEfficiency)
 
void resetMotorEfficiency ()
 
bool setMotorInAirstreamFraction (double motorInAirstreamFraction)
 
void resetMotorInAirstreamFraction ()
 
bool setEndUseSubcategory (const std::string &endUseSubcategory)
 
void resetEndUseSubcategory ()
 
Curves
Curve fanPowerRatioFunctionofSpeedRatioCurve () const
 
bool setFanPowerRatioFunctionofSpeedRatioCurve (const Curve &curve)
 
Curve fanEfficiencyRatioFunctionofSpeedRatioCurve () const
 
bool setFanEfficiencyRatioFunctionofSpeedRatioCurve (const Curve &curve)
 
AirflowNetworkFan getAirflowNetworkFan ()
 
boost::optional
< AirflowNetworkFan
airflowNetworkFan () const
 
boost::optional< double > autosizedMaximumFlowRate () const
 
- Public Member Functions inherited from openstudio::model::StraightComponent
bool addToNode (Node &node)
 
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that this AirToAirComponent is attached to. More...
 
ModelObject clone (Model model) const
 
void disconnect ()
 
boost::optional< ModelObjectinletModelObject () const
 Returns the optional ModelObject connected to the inlet port. More...
 
unsigned inletPort () const
 Returns the inlet port. More...
 
StraightComponentoperator= (const StraightComponent &)=default
 
StraightComponentoperator= (StraightComponent &&)=default
 
boost::optional< ModelObjectoutletModelObject () const
 Returns the optional ModelObject connected to the outlet port. More...
 
unsigned outletPort () const
 Returns the outlet port. More...
 
std::vector
< openstudio::IdfObject > 
remove ()
 
bool removeFromLoop ()
 
 StraightComponent (IddObjectType type, const Model &model)
 
 StraightComponent (const StraightComponent &other)=default
 
 StraightComponent (StraightComponent &&other)=default
 
virtual ~StraightComponent ()=default
 
- Public Member Functions inherited from openstudio::model::HVACComponent
bool addToNode (Node &node)
 Adds this object to a new system node and returns a boolean indicating if the addition was successful. More...
 
bool addToSplitter (Splitter &splitter)
 Adds this object to a splitter by creating a new branch. More...
 
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that the HVAC component is attached to. More...
 
boost::optional
< AirLoopHVACOutdoorAirSystem
airLoopHVACOutdoorAirSystem () const
 Returns the optional AirLoopHVACOutdoorAirSystem that the HVAC component is attached to. More...
 
std::vector< AppGFuelType > appGHeatingFuelTypes () const
 
void applySizingValues ()
 
void autosize ()
 Returns the optional ModelObject connected to this object's port. More...
 
ComponentType componentType () const
 
boost::optional< HVACComponentcontainingHVACComponent () const
 EnergyPlus unitary equipment and air terminals are typically composed of other HVAC components. More...
 
boost::optional
< StraightComponent
containingStraightComponent () const
 
boost::optional
< ZoneHVACComponent
containingZoneHVACComponent () const
 Returns any ZoneHVACComponent that contains this HVACComponent. More...
 
std::vector< FuelType > coolingFuelTypes () const
 
void disconnect ()
 Removes all connections to other HVACComponent objects. More...
 
std::vector< FuelType > heatingFuelTypes () const
 
 HVACComponent (const HVACComponent &other)=default
 
 HVACComponent (HVACComponent &&other)=default
 
bool isRemovable () const
 Indicates if the HVACComponent can be removed from the model. More...
 
boost::optional< Looploop () const
 Returns the optional Loop object that the HVAC component is attached to. More...
 
HVACComponentoperator= (const HVACComponent &)=default
 
HVACComponentoperator= (HVACComponent &&)=default
 
boost::optional< PlantLoopplantLoop () const
 Returns the optional PlantLoop object that the HVAC component is attached to. More...
 
std::vector< IdfObject > remove ()
 Removes the HVACComponent from the model only if isRemovable() return true. More...
 
virtual ~HVACComponent ()=default
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject ()=default
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (ModelObject &&)=default
 
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< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () 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< OutputVariableoutputVariables () 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< LifeCycleCostlifeCycleCosts () 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< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
 
boost::optional< double > getAutosizedValue (const std::string &valueName, const std::string &units) 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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 

Related Functions

(Note that these are not member functions.)

using FanOnOffVector = std::vector< FanOnOff >
 
using OptionalFanOnOff = boost::optional< FanOnOff >
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::HVACComponent
using ImplType = detail::HVACComponent_Impl
 
- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- Protected Member Functions inherited from openstudio::model::HVACComponent
virtual std::vector< ModelObjectchildren () const
 
 HVACComponent (IddObjectType type, const Model &model)
 
 HVACComponent (std::shared_ptr< ImplType > impl)
 
- Protected Member Functions inherited from openstudio::model::ParentObject
 ParentObject (IddObjectType type, const Model &model)
 Constructs a new ParentObject object in the model. More...
 
- 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)
 

Detailed Description

FanOnOff is a StraightComponent that wraps the OpenStudio IDD object 'OS:Fan:OnOff'.

Constructor & Destructor Documentation

openstudio::model::FanOnOff::FanOnOff ( const Model model,
Schedule availabilitySchedule,
Curve fanPowerRatioFunctionofSpeedRatioCurve,
Curve fanEfficiencyRatioFunctionofSpeedRatioCurve 
)
explicit
openstudio::model::FanOnOff::FanOnOff ( const Model model,
Schedule availabilitySchedule 
)
explicit
openstudio::model::FanOnOff::FanOnOff ( const Model model)
explicit
virtual openstudio::model::FanOnOff::~FanOnOff ( )
virtualdefault
openstudio::model::FanOnOff::FanOnOff ( const FanOnOff other)
default
openstudio::model::FanOnOff::FanOnOff ( FanOnOff &&  other)
default

Member Function Documentation

boost::optional<AirflowNetworkFan> openstudio::model::FanOnOff::airflowNetworkFan ( ) const
boost::optional<double> openstudio::model::FanOnOff::autosizedMaximumFlowRate ( ) const
void openstudio::model::FanOnOff::autosizeMaximumFlowRate ( )
Schedule openstudio::model::FanOnOff::availabilitySchedule ( ) const
std::string openstudio::model::FanOnOff::endUseSubcategory ( ) const
double openstudio::model::FanOnOff::fanEfficiency ( ) const

Deprecrated in favor of fanTotalEfficiency.

Curve openstudio::model::FanOnOff::fanEfficiencyRatioFunctionofSpeedRatioCurve ( ) const
Curve openstudio::model::FanOnOff::fanPowerRatioFunctionofSpeedRatioCurve ( ) const
double openstudio::model::FanOnOff::fanTotalEfficiency ( ) const
AirflowNetworkFan openstudio::model::FanOnOff::getAirflowNetworkFan ( )
static IddObjectType openstudio::model::FanOnOff::iddObjectType ( )
static
bool openstudio::model::FanOnOff::isEndUseSubcategoryDefaulted ( ) const
bool openstudio::model::FanOnOff::isFanEfficiencyDefaulted ( ) const
bool openstudio::model::FanOnOff::isFanTotalEfficiencyDefaulted ( ) const
bool openstudio::model::FanOnOff::isMaximumFlowRateAutosized ( ) const
bool openstudio::model::FanOnOff::isMotorEfficiencyDefaulted ( ) const
boost::optional<double> openstudio::model::FanOnOff::maximumFlowRate ( ) const
double openstudio::model::FanOnOff::motorEfficiency ( ) const
boost::optional<double> openstudio::model::FanOnOff::motorInAirstreamFraction ( ) const
FanOnOff& openstudio::model::FanOnOff::operator= ( const FanOnOff )
default
FanOnOff& openstudio::model::FanOnOff::operator= ( FanOnOff &&  )
default
double openstudio::model::FanOnOff::pressureRise ( ) const
void openstudio::model::FanOnOff::resetEndUseSubcategory ( )
void openstudio::model::FanOnOff::resetFanEfficiency ( )
void openstudio::model::FanOnOff::resetFanTotalEfficiency ( )
void openstudio::model::FanOnOff::resetMaximumFlowRate ( )
void openstudio::model::FanOnOff::resetMotorEfficiency ( )
void openstudio::model::FanOnOff::resetMotorInAirstreamFraction ( )
bool openstudio::model::FanOnOff::setAvailabilitySchedule ( Schedule schedule)
bool openstudio::model::FanOnOff::setEndUseSubcategory ( const std::string &  endUseSubcategory)
bool openstudio::model::FanOnOff::setFanEfficiency ( double  fanTotalEfficiency)
bool openstudio::model::FanOnOff::setFanEfficiencyRatioFunctionofSpeedRatioCurve ( const Curve curve)
bool openstudio::model::FanOnOff::setFanPowerRatioFunctionofSpeedRatioCurve ( const Curve curve)
bool openstudio::model::FanOnOff::setFanTotalEfficiency ( double  fanTotalEfficiency)
bool openstudio::model::FanOnOff::setMaximumFlowRate ( double  maximumFlowRate)
bool openstudio::model::FanOnOff::setMotorEfficiency ( double  motorEfficiency)
bool openstudio::model::FanOnOff::setMotorInAirstreamFraction ( double  motorInAirstreamFraction)
bool openstudio::model::FanOnOff::setPressureRise ( double  pressureRise)

Friends And Related Function Documentation

using FanOnOffVector = std::vector<FanOnOff>
related
using OptionalFanOnOff = boost::optional<FanOnOff>
related