#include <Loop.hpp>

Inheritance diagram for openstudio::model::Loop:

Public Member Functions
std::vector< AppGFuelType >	appGHeatingFuelTypes () const

void	applySizingValues ()

void	autosize ()

virtual std::vector< ModelObject >	children () const

virtual ModelObject	clone (Model model) const

virtual boost::optional < ModelObject >	component (openstudio::Handle handle) const
	Returns an optional ModelObject with the given handle. More...

virtual std::vector< ModelObject >	components (openstudio::IddObjectType type=openstudio::IddObjectType("Catchall")) const
	Returns all of the HVAC equipment within the air loop including both the supply and demand sides of the loop. More...

std::vector< ModelObject >	components (const HVACComponent &inletComp, const HVACComponent &outletComp, openstudio::IddObjectType type=openstudio::IddObjectType("Catchall"))
	Returns supplyComponents() or demandComponents(), depending on if the inlet and outlet component arugments are on the supply or demand side. More...

ComponentType	componentType () const

std::vector< FuelType >	coolingFuelTypes () const

virtual boost::optional < ModelObject >	demandComponent (openstudio::Handle handle) const
	Returns an optional ModelObject with the given handle. More...

virtual std::vector< ModelObject >	demandComponents (const HVACComponent &inletComp, const HVACComponent &outletComp, openstudio::IddObjectType type=openstudio::IddObjectType("Catchall")) const
	Returns all of the demand side hvac equipment between inletComps and outletComps. More...

virtual std::vector< ModelObject >	demandComponents (openstudio::IddObjectType type=openstudio::IddObjectType("Catchall")) const
	Returns all of the demand side HVAC equipment within the air loop. More...

virtual Node	demandInletNode () const

virtual std::vector< Node >	demandInletNodes () const

Mixer	demandMixer () const

virtual Node	demandOutletNode () const

Splitter	demandSplitter () const

std::vector< FuelType >	heatingFuelTypes () const

	Loop (const Loop &other)=default

	Loop (Loop &&other)=default

Loop &	operator= (const Loop &)=default

Loop &	operator= (Loop &&)=default

virtual std::vector < openstudio::IdfObject >	remove ()

virtual boost::optional < ModelObject >	supplyComponent (openstudio::Handle handle) const
	Returns an optional ModelObject with the given handle. More...

virtual std::vector< ModelObject >	supplyComponents (const HVACComponent &inletComp, const HVACComponent &outletComp, openstudio::IddObjectType type=openstudio::IddObjectType("Catchall")) const
	Returns all of the supply side hvac equipment between inletComps and outletComps. More...

virtual std::vector< ModelObject >	supplyComponents (openstudio::IddObjectType type=openstudio::IddObjectType("Catchall")) const
	Returns all of the supply side HVAC equipment within the air loop. More...

virtual Node	supplyInletNode () const

virtual Node	supplyOutletNode () const

virtual std::vector< Node >	supplyOutletNodes () const

virtual	~Loop () override=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 () override=default

Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject () override=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

Public Member Functions inherited from openstudio::WorkspaceObject
bool	canBeSource () const

bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const

std::vector< std::string >	canBeTarget () const

std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const

std::vector< WorkspaceObject >	getSources (IddObjectType type) const

boost::optional< WorkspaceObject >	getTarget (unsigned index) const

IdfObject	idfObject ()

IdfObject	idfObject () const

bool	initialized () const

bool	isSource () const

bool	isTarget () const

unsigned	numSources () const

bool	objectListFieldsEqual (const WorkspaceObject &other) const

bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const

bool	operator< (const WorkspaceObject &right) const

std::ostream &	operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)

WorkspaceObject &	operator= (WorkspaceObject &&)=default

WorkspaceObject &	operator= (const WorkspaceObject &)=default

std::vector < openstudio::IdfObject >	remove ()

bool	setPointer (unsigned index, const Handle &targetHandle)

std::vector< WorkspaceObject >	sources () const

std::vector< WorkspaceObject >	targets () const

Workspace	workspace () const

	WorkspaceObject (const WorkspaceObject &other)=default

	WorkspaceObject (WorkspaceObject &&other)=default

virtual	~WorkspaceObject () override=default

Public Member Functions inherited from openstudio::IdfObject
std::string	briefDescription () const

T	cast () const

std::vector< T >	castVector (const std::vector< U > &objects)

std::vector< std::vector < std::string > >	clearExtensibleGroups ()

IdfObject	clone (bool keepHandle=false) const

std::string	comment () const

boost::optional< std::string >	createName (bool overwrite=true)

std::vector< unsigned >	dataFields () const

bool	dataFieldsEqual (const IdfObject &other) const

std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)

std::vector< IdfExtensibleGroup >	extensibleGroups () const

boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const

boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const

IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const

boost::optional< std::string >	getField (unsigned index, bool returnDefault=false) const

std::vector< Handle >	getHandles (const std::vector< T > &objects)

boost::optional< int >	getInt (unsigned index, bool returnDefault=false) const

OSOptionalQuantity	getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const

boost::optional< std::string >	getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const

boost::optional< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const

Handle	handle () const

IddObject	iddObject () const

	IdfObject (IddObjectType type, bool fastName=false)

	IdfObject (const IdfObject &other)

	IdfObject (const IddObject &, bool fastName=false)

	IdfObject (IdfObject &&other) noexcept

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)

bool	isDataField (unsigned index) const

bool	isEmpty (unsigned index) const

bool	isObjectListField (unsigned index) const

bool	isValid (StrictnessLevel level, bool checkNames=false) const

boost::optional< unsigned >	maxExtensibleGroups () const

boost::optional< unsigned >	maxFields () const

unsigned	minExtensibleGroups () const

unsigned	minFields () const

boost::optional< std::string >	name (bool returnDefault=false) const

std::string	nameString (bool returnDefault=false) const

unsigned	numExtensibleGroups () const

unsigned	numFields () const

unsigned	numNonextensibleFields () const

std::vector< unsigned >	objectListFields () const

bool	objectListFieldsEqual (const IdfObject &other) const

bool	objectListFieldsNonConflicting (const IdfObject &other) const

bool	operator!= (const IdfObject &other) const

std::ostream &	operator<< (std::ostream &os, const IdfObject &IdfObject)

IdfObject &	operator= (IdfObject &&other) noexcept

IdfObject &	operator= (const IdfObject &other)

bool	operator== (const IdfObject &other) const

boost::optional< T >	optionalCast () const

std::vector< std::string >	popExtensibleGroup ()

std::ostream &	print (std::ostream &os) const

std::ostream &	printField (std::ostream &os, unsigned index, bool isLastField=false) const

std::ostream &	printName (std::ostream &os, bool hasFields=true) const

IdfExtensibleGroup	pushExtensibleGroup (const std::vector< std::string > &values)

IdfExtensibleGroup	pushExtensibleGroup ()

std::vector< unsigned >	requiredFields () const

void	setComment (const std::string &msg)

bool	setDouble (unsigned index, double value)

bool	setFieldComment (unsigned index, const std::string &cmnt)

bool	setInt (unsigned index, int value)

boost::optional< std::string >	setName (const std::string &newName)

bool	setQuantity (unsigned index, const Quantity &q)

bool	setString (unsigned index, const std::string &value)

bool	setUnsigned (unsigned index, unsigned value)

std::vector< T >	subsetCastVector (const std::vector< U > &original)

ValidityReport	validityReport (StrictnessLevel level, bool checkNames=false) const

virtual	~IdfObject ()=default

Additional Inherited Members
Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional < WorkspaceObject >	OptionalWorkspaceObject

typedef std::vector < WorkspaceObject >	WorkspaceObjectVector

Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject, IdfObject >	IdfObjectPair

typedef std::vector< IdfObject >	IdfObjectVector

typedef boost::optional < IdfObject >	OptionalIdfObject

Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObject >	load (const std::string &text)

static boost::optional< IdfObject >	load (const std::string &text, const IddObject &iddObject)

static int	printedFieldSpace ()

Protected Types inherited from openstudio::model::ModelObject
using	ImplType = detail::ModelObject_Impl

Protected Types inherited from openstudio::WorkspaceObject
typedef detail::WorkspaceObject_Impl	ImplType

Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl	ImplType

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)

Protected Member Functions inherited from openstudio::WorkspaceObject
	WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)

Protected Member Functions inherited from openstudio::IdfObject
	IdfObject (std::shared_ptr< detail::IdfObject_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

Loop is the base class for HVAC air and water loops.

This class provides basic functionality to traverse a loop and locate components. Currently there are two types of loops AirLoopHVAC and PlantLoop. This interface reflects the commonality between the two. Loops in combination with HVACComponents offer a very simple interface to create new systems in EnergyPlus.

The following is an example of building a new HVAC system composed of an AirLoopHVAC with this c++ interface.

Model model = Model();

AirLoopHVAC airLoop = AirLoopHVAC(model);

AirLoopHVACOutdoorAirSystem oaSystem = AirLoopHVACOutdoorAirSystem(model);

FanConstantVolume fan = FanConstantVolume(model);

CoilCoolingDXSingleSpeed  coolCoil = CoilCoolingDXSingleSpeed(model);

CoilHeatingGas heatingCoil = CoilHeatingGas(model);

oaSystem.addToNode( airLoop.supplyOutletNode() );

fan.addToNode( airLoop.supplyOutletNode() );

coolCoil.addToNode( airLoop.supplyOutletNode() );

heatingCoil.addToNode( airLoop.supplyOutletNode() );

airLoop.addBranchForZone("Zone1");

The interface also allows you to retrieve a ModelObject and clone it into a new model thereby making a new copy. The clone algorithm is intellegent enough to bring along all of the connected pieces as it is appropriate.

Model newModel();
AirLoopHVAC newAirLoop = model.getModelObject(airLoop.handle())->clone(newModel);

The HVACComponent::addToNode function is intellegent. The add routine is context sensitive so for example adding a WaterToAirComponent to an air node will connect the air side ports, adding it to a plant loop node will connect the water side ports.

Model model = Model();

AirLoopHVAC airLoop = AirLoopHVAC(model);

PlantLoop plantLoop = PlantLoop(model);

CoilCoolingWater waterCoolingCoil = CoilCoolingWater(model);

waterCoolingCoil.addToNode( airLoop.supplyOutletNode() );

waterCoolingCoil.addToSplitter( plantLoop.demandSplitter() );

Constructor & Destructor Documentation

virtual openstudio::model::Loop::~Loop ( )

overridevirtualdefault

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

default

openstudio::model::Loop::Loop ( Loop && other )

default

Member Function Documentation

std::vector<AppGFuelType> openstudio::model::Loop::appGHeatingFuelTypes ( ) const

void openstudio::model::Loop::applySizingValues ( )

void openstudio::model::Loop::autosize ( )

virtual std::vector<ModelObject> openstudio::model::Loop::children ( ) const

virtual

virtual ModelObject openstudio::model::Loop::clone ( Model model ) const

virtual

Reimplemented in openstudio::model::AirLoopHVAC, and openstudio::model::PlantLoop.

virtual boost::optional<ModelObject> openstudio::model::Loop::component ( openstudio::Handle handle ) const

virtual

Returns an optional ModelObject with the given handle.

If the handle is not within the Loop then the optional will be false

virtual std::vector<ModelObject> openstudio::model::Loop::components ( openstudio::IddObjectType type = openstudio::IddObjectType("Catchall") ) const

virtual

Returns all of the HVAC equipment within the air loop including both the supply and demand sides of the loop.

If type is given then the results will be limited to the given IddObjectType.

std::vector<ModelObject> openstudio::model::Loop::components	(	const HVACComponent &	inletComp,
		const HVACComponent &	outletComp,
		openstudio::IddObjectType	type = `openstudio::IddObjectType("Catchall")`
	)

Returns supplyComponents() or demandComponents(), depending on if the inlet and outlet component arugments are on the supply or demand side.

If they are from opposite sides of the loop then an empty vector will be returned.

ComponentType openstudio::model::Loop::componentType ( ) const

std::vector<FuelType> openstudio::model::Loop::coolingFuelTypes ( ) const

virtual boost::optional<ModelObject> openstudio::model::Loop::demandComponent ( openstudio::Handle handle ) const

virtual

Returns an optional ModelObject with the given handle.

If the handle is not within demand side of the Loop then the optional will be false

virtual std::vector<ModelObject> openstudio::model::Loop::demandComponents	(	const HVACComponent &	inletComp,
		const HVACComponent &	outletComp,
		openstudio::IddObjectType	type = `openstudio::IddObjectType("Catchall")`
	)		const

virtual

Returns all of the demand side hvac equipment between inletComps and outletComps.

If type is given then the results will be limited to the given IddObjectType. Multiple inlet and outlet nodes can be provided. Returns all of the demand side hvac equipment between inletComp and outletComp. If type is given then the results will be limited to the given IddObjectType. Only one inlet and outlet node can be given.

virtual std::vector<ModelObject> openstudio::model::Loop::demandComponents ( openstudio::IddObjectType type = openstudio::IddObjectType("Catchall") ) const

virtual

Returns all of the demand side HVAC equipment within the air loop.

If type is given then the results will be limited to the given IddObjectType.

virtual Node openstudio::model::Loop::demandInletNode ( ) const

virtual

Reimplemented in openstudio::model::PlantLoop, and openstudio::model::AirLoopHVAC.

virtual std::vector<Node> openstudio::model::Loop::demandInletNodes ( ) const

virtual

Reimplemented in openstudio::model::PlantLoop, and openstudio::model::AirLoopHVAC.

Mixer openstudio::model::Loop::demandMixer ( ) const

virtual Node openstudio::model::Loop::demandOutletNode ( ) const

virtual

Reimplemented in openstudio::model::PlantLoop, and openstudio::model::AirLoopHVAC.

Splitter openstudio::model::Loop::demandSplitter ( ) const

std::vector<FuelType> openstudio::model::Loop::heatingFuelTypes ( ) const

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

default

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

default

virtual std::vector<openstudio::IdfObject> openstudio::model::Loop::remove ( )

virtual

Reimplemented in openstudio::model::AirLoopHVAC, and openstudio::model::PlantLoop.

virtual boost::optional<ModelObject> openstudio::model::Loop::supplyComponent ( openstudio::Handle handle ) const

virtual

Returns an optional ModelObject with the given handle.

If the handle is not within supply side of the Loop then the optional will be false

virtual std::vector<ModelObject> openstudio::model::Loop::supplyComponents	(	const HVACComponent &	inletComp,
		const HVACComponent &	outletComp,
		openstudio::IddObjectType	type = `openstudio::IddObjectType("Catchall")`
	)		const

virtual

Returns all of the supply side hvac equipment between inletComps and outletComps.

If type is given then the results will be limited to the given IddObjectType. Multiple inlet and outlet nodes can be provided. Returns all of the supply side hvac equipment between inletComp and outletComp. If type is given then the results will be limited to the given IddObjectType. Only one inlet and outlet node can be given.

virtual std::vector<ModelObject> openstudio::model::Loop::supplyComponents ( openstudio::IddObjectType type = openstudio::IddObjectType("Catchall") ) const

virtual

Returns all of the supply side HVAC equipment within the air loop.

If type is given then the results will be limited to the given IddObjectType.

virtual Node openstudio::model::Loop::supplyInletNode ( ) const

virtual

Reimplemented in openstudio::model::PlantLoop, and openstudio::model::AirLoopHVAC.

virtual Node openstudio::model::Loop::supplyOutletNode ( ) const

virtual

Reimplemented in openstudio::model::PlantLoop, and openstudio::model::AirLoopHVAC.

virtual std::vector<Node> openstudio::model::Loop::supplyOutletNodes ( ) const

virtual

Reimplemented in openstudio::model::PlantLoop, and openstudio::model::AirLoopHVAC.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation