openstudio::model::ControllerWaterCoil Class Reference

#include <ControllerWaterCoil.hpp>

Inheritance diagram for openstudio::model::ControllerWaterCoil:

Public Member Functions
Constructors and Destructors
	ControllerWaterCoil (const Model &model)
virtual	~ControllerWaterCoil ()
Getters
boost::optional< std::string >	controlVariable () const
boost::optional< std::string >	action () const
boost::optional< std::string >	actuatorVariable () const
boost::optional< Node >	sensorNode () const
boost::optional< Node >	actuatorNode () const
boost::optional< double >	controllerConvergenceTolerance () const
bool	isControllerConvergenceToleranceDefaulted () const
bool	isControllerConvergenceToleranceAutosized () const
boost::optional< double >	maximumActuatedFlow () const
bool	isMaximumActuatedFlowAutosized () const
double	minimumActuatedFlow () const
bool	isMinimumActuatedFlowDefaulted () const
Setters
bool	setControlVariable (std::string controlVariable)
void	resetControlVariable ()
bool	setAction (std::string action)
void	resetAction ()
bool	setActuatorVariable (std::string actuatorVariable)
void	resetActuatorVariable ()
bool	setSensorNode (Node &node)
bool	setActuatorNode (Node &node)
bool	setControllerConvergenceTolerance (double controllerConvergenceTolerance)
void	resetControllerConvergenceTolerance ()
void	autosizeControllerConvergenceTolerance ()
bool	setMaximumActuatedFlow (double maximumActuatedFlow)
void	resetMaximumActuatedFlow ()
void	autosizeMaximumActuatedFlow ()
bool	setMinimumActuatedFlow (double minimumActuatedFlow)
void	resetMinimumActuatedFlow ()
boost::optional< double >	autosizedControllerConvergenceTolerance () const
boost::optional< double >	autosizedMaximumActuatedFlow () const
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...
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 Methods
static IddObjectType	iddObjectType ()
static std::vector< std::string >	validControlVariableValues ()
static std::vector< std::string >	validActionValues ()
static std::vector< std::string >	validActuatorVariableValues ()

Related Functions
(Note that these are not member functions.)
typedef std::vector < ControllerWaterCoil >	ControllerWaterCoilVector
typedef boost::optional < ControllerWaterCoil >	OptionalControllerWaterCoil
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::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::HVACComponent
virtual std::vector< ModelObject >	children () 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

ControllerWaterCoil is a HVACComponent that wraps the OpenStudio IDD object 'OS:Controller:WaterCoil'.

Constructor & Destructor Documentation

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

explicit

virtual openstudio::model::ControllerWaterCoil::~ControllerWaterCoil ( )

inlinevirtual

Member Function Documentation

boost::optional<std::string> openstudio::model::ControllerWaterCoil::action

(

)

const

boost::optional<Node> openstudio::model::ControllerWaterCoil::actuatorNode

(

)

const

boost::optional<std::string> openstudio::model::ControllerWaterCoil::actuatorVariable

(

)

const

void openstudio::model::ControllerWaterCoil::autosizeControllerConvergenceTolerance

(

)

boost::optional<double> openstudio::model::ControllerWaterCoil::autosizedControllerConvergenceTolerance

(

)

const

boost::optional<double> openstudio::model::ControllerWaterCoil::autosizedMaximumActuatedFlow

(

)

const

void openstudio::model::ControllerWaterCoil::autosizeMaximumActuatedFlow

(

)

boost::optional<double> openstudio::model::ControllerWaterCoil::controllerConvergenceTolerance

(

)

const

boost::optional<std::string> openstudio::model::ControllerWaterCoil::controlVariable

(

)

const

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

static

bool openstudio::model::ControllerWaterCoil::isControllerConvergenceToleranceAutosized

(

)

const

bool openstudio::model::ControllerWaterCoil::isControllerConvergenceToleranceDefaulted

(

)

const

bool openstudio::model::ControllerWaterCoil::isMaximumActuatedFlowAutosized

(

)

const

bool openstudio::model::ControllerWaterCoil::isMinimumActuatedFlowDefaulted

(

)

const

boost::optional<double> openstudio::model::ControllerWaterCoil::maximumActuatedFlow

(

)

const

double openstudio::model::ControllerWaterCoil::minimumActuatedFlow

(

)

const

void openstudio::model::ControllerWaterCoil::resetAction

(

)

void openstudio::model::ControllerWaterCoil::resetActuatorVariable

(

)

void openstudio::model::ControllerWaterCoil::resetControllerConvergenceTolerance

(

)

void openstudio::model::ControllerWaterCoil::resetControlVariable

(

)

void openstudio::model::ControllerWaterCoil::resetMaximumActuatedFlow

(

)

void openstudio::model::ControllerWaterCoil::resetMinimumActuatedFlow

(

)

boost::optional<Node> openstudio::model::ControllerWaterCoil::sensorNode

(

)

const

bool openstudio::model::ControllerWaterCoil::setAction

(

std::string

action

)

bool openstudio::model::ControllerWaterCoil::setActuatorNode

(

Node &

node

)

bool openstudio::model::ControllerWaterCoil::setActuatorVariable

(

std::string

actuatorVariable

)

bool openstudio::model::ControllerWaterCoil::setControllerConvergenceTolerance

(

double

controllerConvergenceTolerance

)

bool openstudio::model::ControllerWaterCoil::setControlVariable

(

std::string

controlVariable

)

bool openstudio::model::ControllerWaterCoil::setMaximumActuatedFlow

(

double

maximumActuatedFlow

)

bool openstudio::model::ControllerWaterCoil::setMinimumActuatedFlow

(

double

minimumActuatedFlow

)

bool openstudio::model::ControllerWaterCoil::setSensorNode

(

Node &

node

)

static std::vector<std::string> openstudio::model::ControllerWaterCoil::validActionValues ( )

static

static std::vector<std::string> openstudio::model::ControllerWaterCoil::validActuatorVariableValues ( )

static

static std::vector<std::string> openstudio::model::ControllerWaterCoil::validControlVariableValues ( )

static

Friends And Related Function Documentation

typedef std::vector<ControllerWaterCoil> ControllerWaterCoilVector

related

typedef boost::optional<ControllerWaterCoil> OptionalControllerWaterCoil

related