#include <SetpointManagerScheduled.hpp>

Inheritance diagram for openstudio::model::SetpointManagerScheduled:

Public Member Functions
Constructors and Destructors
	SetpointManagerScheduled (const Model &model, Schedule &setpointSchedule)
	Constructs a new SetpointManagerScheduled object and places it inside model. More...

	SetpointManagerScheduled (const Model &model, const std::string &controlVariable, Schedule &setpointSchedule)
	Constructs a new SetpointManagerScheduled object and places it inside model. More...

virtual	~SetpointManagerScheduled ()=default

	SetpointManagerScheduled (const SetpointManagerScheduled &other)=default

	SetpointManagerScheduled (SetpointManagerScheduled &&other)=default

SetpointManagerScheduled &	operator= (const SetpointManagerScheduled &)=default

SetpointManagerScheduled &	operator= (SetpointManagerScheduled &&)=default

Getters
boost::optional< Node >	setpointNode () const
	Returns the Node referred to by the SetpointNodeName field. More...

std::string	controlVariable () const
	Returns the Control Variable. More...

Schedule	schedule () const
	Returns the Schedule. More...

bool	hasSchedule () const
	Returns true if this object has a schedule, it is an error if this object does not have a schedule. More...

Setters
bool	setControlVariable (const std::string &controlVariable)
	Sets the Control Variable. More...

bool	setSchedule (Schedule &schedule)
	Sets the Schedule. More...

Other
bool	setControlVariableAndSchedule (const std::string &controlVariable, Schedule &schedule)
	Sets control variable and schedule simultaneously. More...

Public Member Functions inherited from openstudio::model::SetpointManager
virtual	~SetpointManager ()=default

	SetpointManager (const SetpointManager &other)=default

	SetpointManager (SetpointManager &&other)=default

SetpointManager &	operator= (const SetpointManager &)=default

SetpointManager &	operator= (SetpointManager &&)=default

boost::optional< Node >	setpointNode () const
	Returns the Node referred to by the SetpointNodeName field. More...

std::string	controlVariable () const
	Returns the Control Variable. More...

bool	isAllowedOnPlantLoop () const
	Returns whether this SPM is allowed to be placed on a PlantLoop (all SPMs are allowed on an AirLoopHVAC, some are allowed on a PlantLoop) More...

bool	setControlVariable (const std::string &controlVariable)
	Sets the Control Variable. More...

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...

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< 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...

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< Loop >	loop () const
	Returns the optional Loop object that the HVAC component is attached to. More...

HVACComponent &	operator= (const HVACComponent &)=default

HVACComponent &	operator= (HVACComponent &&)=default

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 ()=default

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...

ParentObject &	operator= (const ParentObject &)=default

ParentObject &	operator= (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

ModelObject &	operator= (const ModelObject &)=default

ModelObject &	operator= (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< 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 (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< ModelObject >	connectedObject (unsigned port) const

boost::optional< unsigned >	connectedObjectPort (unsigned port) const

Static Public Member Functions
static std::vector< std::string >	controlVariableValues ()

static IddObjectType	iddObjectType ()

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::SetpointManager
	SetpointManager (IddObjectType type, const Model &model)
	Constructs a new SetpointManager object and places it inside model. More...

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)

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...

Detailed Description

SetpointManagerScheduled is an interface to theIDD object named "OS:SetpointManager:Scheduled".

The purpose of this class is to simplify the construction and manipulation of the EnergyPlus SetpointManager:Scheduled object.

Constructor & Destructor Documentation

openstudio::model::SetpointManagerScheduled::SetpointManagerScheduled	(	const Model &	model,
		Schedule &	setpointSchedule
	)

Constructs a new SetpointManagerScheduled object and places it inside model.

Sets controlVariable to 'Temperature'. Sets setpointSchedule's ScheduleTypeLimits if necessary and possible.

openstudio::model::SetpointManagerScheduled::SetpointManagerScheduled	(	const Model &	model,
		const std::string &	controlVariable,
		Schedule &	setpointSchedule
	)

Constructs a new SetpointManagerScheduled object and places it inside model.

virtual openstudio::model::SetpointManagerScheduled::~SetpointManagerScheduled ( )

virtualdefault

openstudio::model::SetpointManagerScheduled::SetpointManagerScheduled ( const SetpointManagerScheduled & other )

default

openstudio::model::SetpointManagerScheduled::SetpointManagerScheduled ( SetpointManagerScheduled && other )

default

Member Function Documentation

std::string openstudio::model::SetpointManagerScheduled::controlVariable ( ) const

Returns the Control Variable.

static std::vector<std::string> openstudio::model::SetpointManagerScheduled::controlVariableValues ( )

static

bool openstudio::model::SetpointManagerScheduled::hasSchedule ( ) const

Returns true if this object has a schedule, it is an error if this object does not have a schedule.

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

static

SetpointManagerScheduled& openstudio::model::SetpointManagerScheduled::operator= ( const SetpointManagerScheduled & )

default

SetpointManagerScheduled& openstudio::model::SetpointManagerScheduled::operator= ( SetpointManagerScheduled && )

default

Schedule openstudio::model::SetpointManagerScheduled::schedule ( ) const

Returns the Schedule.

bool openstudio::model::SetpointManagerScheduled::setControlVariable ( const std::string & controlVariable )

Sets the Control Variable.

bool openstudio::model::SetpointManagerScheduled::setControlVariableAndSchedule	(	const std::string &	controlVariable,
		Schedule &	schedule
	)

Sets control variable and schedule simultaneously.

Use in the case that the control variable change implies a change in schedule units.

boost::optional<Node> openstudio::model::SetpointManagerScheduled::setpointNode ( ) const

Returns the Node referred to by the SetpointNodeName field.

bool openstudio::model::SetpointManagerScheduled::setSchedule ( Schedule & schedule )

Sets the Schedule.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation