openstudio::model::FanZoneExhaust Class Reference

#include <FanZoneExhaust.hpp>

Inheritance diagram for openstudio::model::FanZoneExhaust:

Public Member Functions
Constructors and Destructors
	FanZoneExhaust (const Model &model)
virtual	~FanZoneExhaust ()
Getters
boost::optional< Schedule >	availabilitySchedule () const
double	fanTotalEfficiency () const
double	fanEfficiency () const
	Deprecated, forwards to fanTotalEfficiency. More...
double	pressureRise () const
boost::optional< double >	maximumFlowRate () const
std::string	endUseSubcategory () const
boost::optional< Schedule >	flowFractionSchedule () const
std::string	systemAvailabilityManagerCouplingMode () const
boost::optional< Schedule >	minimumZoneTemperatureLimitSchedule () const
boost::optional< Schedule >	balancedExhaustFractionSchedule () const
Setters
bool	setAvailabilitySchedule (Schedule &schedule)
void	resetAvailabilitySchedule ()
bool	setFanTotalEfficiency (double fanTotalEfficiency)
bool	setFanEfficiency (double fanTotalEfficiency)
	Deprecated, forwards to setFanTotalEfficiency. More...
bool	setPressureRise (double pressureRise)
bool	setMaximumFlowRate (double maximumFlowRate)
void	resetMaximumFlowRate ()
bool	setEndUseSubcategory (std::string endUseSubcategory)
bool	setFlowFractionSchedule (Schedule &schedule)
void	resetFlowFractionSchedule ()
bool	setSystemAvailabilityManagerCouplingMode (std::string systemAvailabilityManagerCouplingMode)
bool	setMinimumZoneTemperatureLimitSchedule (Schedule &schedule)
void	resetMinimumZoneTemperatureLimitSchedule ()
bool	setBalancedExhaustFractionSchedule (Schedule &schedule)
void	resetBalancedExhaustFractionSchedule ()
Other
AirflowNetworkZoneExhaustFan	getAirflowNetworkZoneExhaustFan (const AirflowNetworkCrack &crack)
boost::optional < AirflowNetworkZoneExhaustFan >	airflowNetworkZoneExhaustFan () const
Public Member Functions inherited from openstudio::model::ZoneHVACComponent
bool	addToNode (Node &node)
	Adds this ZoneHVACComponent to a node on an AirLoopHVAC object. More...
bool	addToThermalZone (ThermalZone &thermalZone)
	Adds this ZoneHVACComponent to the thermal zone while managing all node connections automatically. More...
boost::optional< ModelObject >	airInletModelObject () const
	Provided for backwards compatibility, use inletNode instead. More...
boost::optional< AirLoopHVAC >	airLoopHVAC () const
	Returns the AirLoopHVAC attached to this ZoneHVACComponent. More...
boost::optional< ModelObject >	airOutletModelObject () const
	Provided for backwards compatibility, use outletNode instead. More...
boost::optional< Node >	inletNode () const
	Returns the optional node connected to the inletPort(). More...
unsigned	inletPort () const
	Returns the inlet port. More...
boost::optional< Node >	outletNode () const
	Returns the optional node connected to the outletPort(). More...
unsigned	outletPort () const
	Returns the outlet port. More...
bool	removeFromAirLoopHVAC ()
	If this ZoneHVACComponent is used as a supply component on an AirLoopHVAC system, then this method will detach this ZoneHVACComponent from the AirLoopHVAC system, otherwise this method does nothing. More...
void	removeFromThermalZone ()
	Detaches this ZoneHVACComponent from the associated ThermalZone. More...
void	removeReturnPlenum ()
	Remove any return plenum attached to this ZoneHVACComponent. More...
boost::optional < AirLoopHVACReturnPlenum >	returnPlenum () const
bool	setReturnPlenum (const ThermalZone &plenumZone)
	Establish plenumZone as the return plenum for this ZoneHVACComponent. More...
virtual boost::optional < ThermalZone >	thermalZone () const
	Returns the optional ThermalZone that this ZoneHVACComponent is attached to. More...
virtual	~ZoneHVACComponent ()
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< AirLoopHVAC >	airLoopHVAC () 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...
void	applySizingValues ()
void	autosize ()
	Returns the optional ModelObject connected to this object's port. More...
boost::optional< HVACComponent >	containingHVACComponent () 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...
void	disconnect ()
	Removes all connections to other HVACComponent objects. More...
bool	isRemovable () const
	Indicates if the HVACComponent can be removed from the model. More...
boost::optional< Loop >	loop () const
	Returns the optional Loop object that the HVAC component is attached to. More...
boost::optional< PlantLoop >	plantLoop () 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 ()
Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType >	allowableChildTypes () const
	Returns a vector of allowable children types. More...
std::vector< ModelObject >	children () const
	Return direct child objects in the Model. More...
virtual	~ParentObject ()
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 >	systemAvailabilityManagerCouplingModeValues ()

Related Functions
(Note that these are not member functions.)
typedef std::vector < FanZoneExhaust >	FanZoneExhaustVector
typedef boost::optional < FanZoneExhaust >	OptionalFanZoneExhaust
Related Functions inherited from openstudio::model::ParentObject
std::vector< ModelObject >	getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true)
	Returns object and all other objects accessible by calling children() on encountered ParentObjects . More...
std::vector< ModelObject >	getRecursiveChildrenAndResources (const ModelObject &object)
	Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More...
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::ZoneHVACComponent
typedef detail::ZoneHVACComponent_Impl	ImplType
Protected Types inherited from openstudio::model::HVACComponent
typedef detail::HVACComponent_Impl	ImplType
Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl	ImplType
Protected Member Functions inherited from openstudio::model::ZoneHVACComponent
virtual std::vector< ModelObject >	children () const override
	ZoneHVACComponent (IddObjectType type, const Model &model)
	ZoneHVACComponent (std::shared_ptr< ImplType > impl)
Protected Member Functions inherited from openstudio::model::HVACComponent
	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

FanZoneExhaust is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:Fan:ZoneExhaust'.

Constructor & Destructor Documentation

openstudio::model::FanZoneExhaust::FanZoneExhaust ( const Model &  model )

explicit

virtual openstudio::model::FanZoneExhaust::~FanZoneExhaust ( )

inlinevirtual

Member Function Documentation

boost::optional<AirflowNetworkZoneExhaustFan> openstudio::model::FanZoneExhaust::airflowNetworkZoneExhaustFan

(

)

const

boost::optional<Schedule> openstudio::model::FanZoneExhaust::availabilitySchedule

(

)

const

boost::optional<Schedule> openstudio::model::FanZoneExhaust::balancedExhaustFractionSchedule

(

)

const

std::string openstudio::model::FanZoneExhaust::endUseSubcategory

(

)

const

double openstudio::model::FanZoneExhaust::fanEfficiency

(

)

const

Deprecated, forwards to fanTotalEfficiency.

double openstudio::model::FanZoneExhaust::fanTotalEfficiency

(

)

const

boost::optional<Schedule> openstudio::model::FanZoneExhaust::flowFractionSchedule

(

)

const

AirflowNetworkZoneExhaustFan openstudio::model::FanZoneExhaust::getAirflowNetworkZoneExhaustFan

(

const AirflowNetworkCrack &

crack

)

static IddObjectType openstudio::model::FanZoneExhaust::iddObjectType ( )

static

boost::optional<double> openstudio::model::FanZoneExhaust::maximumFlowRate

(

)

const

boost::optional<Schedule> openstudio::model::FanZoneExhaust::minimumZoneTemperatureLimitSchedule

(

)

const

double openstudio::model::FanZoneExhaust::pressureRise

(

)

const

void openstudio::model::FanZoneExhaust::resetAvailabilitySchedule

(

)

void openstudio::model::FanZoneExhaust::resetBalancedExhaustFractionSchedule

(

)

void openstudio::model::FanZoneExhaust::resetFlowFractionSchedule

(

)

void openstudio::model::FanZoneExhaust::resetMaximumFlowRate

(

)

void openstudio::model::FanZoneExhaust::resetMinimumZoneTemperatureLimitSchedule

(

)

bool openstudio::model::FanZoneExhaust::setAvailabilitySchedule

(

Schedule &

schedule

)

bool openstudio::model::FanZoneExhaust::setBalancedExhaustFractionSchedule

(

Schedule &

schedule

)

bool openstudio::model::FanZoneExhaust::setEndUseSubcategory

(

std::string

endUseSubcategory

)

bool openstudio::model::FanZoneExhaust::setFanEfficiency

(

double

fanTotalEfficiency

)

Deprecated, forwards to setFanTotalEfficiency.

bool openstudio::model::FanZoneExhaust::setFanTotalEfficiency

(

double

fanTotalEfficiency

)

bool openstudio::model::FanZoneExhaust::setFlowFractionSchedule

(

Schedule &

schedule

)

bool openstudio::model::FanZoneExhaust::setMaximumFlowRate

(

double

maximumFlowRate

)

bool openstudio::model::FanZoneExhaust::setMinimumZoneTemperatureLimitSchedule

(

Schedule &

schedule

)

bool openstudio::model::FanZoneExhaust::setPressureRise

(

double

pressureRise

)

bool openstudio::model::FanZoneExhaust::setSystemAvailabilityManagerCouplingMode

(

std::string

systemAvailabilityManagerCouplingMode

)

std::string openstudio::model::FanZoneExhaust::systemAvailabilityManagerCouplingMode

(

)

const

static std::vector<std::string> openstudio::model::FanZoneExhaust::systemAvailabilityManagerCouplingModeValues ( )

static

Friends And Related Function Documentation

typedef std::vector<FanZoneExhaust> FanZoneExhaustVector

related

typedef boost::optional<FanZoneExhaust> OptionalFanZoneExhaust

related