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

#include <ZoneHVACEquipmentList.hpp>

+ Inheritance diagram for openstudio::model::ZoneHVACEquipmentList:

Public Member Functions

bool addEquipment (const ModelObject &equipment)
 Add new equipment setting the heating and cooling priorities to the next available priority level. More...
 
unsigned coolingPriority (const ModelObject &equipment) const
 Return the cooling priority for equipment. More...
 
std::vector< ModelObjectequipment () const
 Return all equipment. More...
 
std::vector< ModelObjectequipmentInCoolingOrder () const
 Return all equipment. More...
 
std::vector< ModelObjectequipmentInHeatingOrder () const
 Return all equipment. More...
 
unsigned heatingPriority (const ModelObject &equipment) const
 Return the heating or no-load priority for equipment. More...
 
std::string loadDistributionScheme () const
 
bool removeEquipment (const ModelObject &equipment)
 Remove equipment from the EquipmentList. More...
 
OS_DEPRECATED boost::optional
< double > 
sequentialCoolingFraction (const ModelObject &equipment) const
 Return the Sequential Cooling Fraction of equipment. More...
 
boost::optional< SchedulesequentialCoolingFractionSchedule (const ModelObject &equipment) const
 Return the Sequential Cooling Fraction Schedule of equipment. More...
 
OS_DEPRECATED boost::optional
< double > 
sequentialHeatingFraction (const ModelObject &equipment) const
 Return the Sequential Heating Fraction of equipment. More...
 
boost::optional< SchedulesequentialHeatingFractionSchedule (const ModelObject &equipment) const
 Return the Sequential Heating Fraction Schedule of equipment. More...
 
bool setCoolingPriority (const ModelObject &equipment, unsigned priority)
 Set cooling priority of equipment. More...
 
bool setHeatingPriority (const ModelObject &equipment, unsigned priority)
 Set heating or no-load priority of equipment. More...
 
bool setLoadDistributionScheme (std::string scheme)
 
OS_DEPRECATED bool setSequentialCoolingFraction (const ModelObject &equipment, double fraction)
 Set the Sequential Cooling Fraction Schedule Constant of equipment. More...
 
bool setSequentialCoolingFractionSchedule (const ModelObject &equipment, const Schedule &schedule)
 Set the Sequential Cooling Fraction Schedule of equipment. More...
 
OS_DEPRECATED bool setSequentialHeatingFraction (const ModelObject &equipment, double fraction)
 Set the Sequential Heating Fraction Schedule Constant of equipment. More...
 
bool setSequentialHeatingFractionSchedule (const ModelObject &equipment, const Schedule &schedule)
 Set the Sequential Heating Fraction Schedule of equipment. More...
 
ThermalZone thermalZone () const
 
 ZoneHVACEquipmentList (const ThermalZone &thermalZone)
 
virtual ~ZoneHVACEquipmentList ()
 
- 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< 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< IdfObjectremoveLifeCycleCosts ()
 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< IdfObjectremoveAdditionalProperties ()
 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< ScheduleTypeKeygetScheduleTypeKeys (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< ModelObjectconnectedObject (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< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (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)
 
std::vector
< openstudio::IdfObject
remove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
virtual ~WorkspaceObject ()
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
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< IdfExtensibleGroupextensibleGroups () 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
 
std::vector< Handle > getHandles (const std::vector< T > &objects)
 
boost::optional< intgetInt (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
 
boost::optional< QUrl > getURL (unsigned index, bool returnDefault=false) const
 
Handle handle () const
 
IddObject iddObject () const
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
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)
 
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 ()
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
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 ()
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 
static std::vector< std::string > loadDistributionSchemeValues ()
 
static std::vector< std::string > validLoadDistributionSchemeValues ()
 
- Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObjectload (const std::string &text)
 
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
 
static int printedFieldSpace ()
 

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< ZoneHVACEquipmentList
OptionalZoneHVACEquipmentList
 
typedef std::vector
< ZoneHVACEquipmentList
ZoneHVACEquipmentListVector
 

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< IdfObjectIdfObjectVector
 
typedef boost::optional
< IdfObject
OptionalIdfObject
 
- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- 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::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)
 

Detailed Description

ZoneHVACEquipmentList is a ModelObject that wraps the OpenStudio IDD object 'OS:ZoneHVAC:EquipmentList'.

Constructor & Destructor Documentation

openstudio::model::ZoneHVACEquipmentList::ZoneHVACEquipmentList ( const ThermalZone thermalZone)
explicit
virtual openstudio::model::ZoneHVACEquipmentList::~ZoneHVACEquipmentList ( )
inlinevirtual

Member Function Documentation

bool openstudio::model::ZoneHVACEquipmentList::addEquipment ( const ModelObject equipment)

Add new equipment setting the heating and cooling priorities to the next available priority level.

Air terminals associated with AirLoopHVAC will be moved to first priority. This method is relatively dumb. It will add any model object to the list even if it is not hvac equipment. That might change in the future.

unsigned openstudio::model::ZoneHVACEquipmentList::coolingPriority ( const ModelObject equipment) const

Return the cooling priority for equipment.

std::vector<ModelObject> openstudio::model::ZoneHVACEquipmentList::equipment ( ) const

Return all equipment.

Order is undetermined.

std::vector<ModelObject> openstudio::model::ZoneHVACEquipmentList::equipmentInCoolingOrder ( ) const

Return all equipment.

Order is determined by cooling priority Equipment having a Cooling Priority of 0 is filtered out (unavailable)

std::vector<ModelObject> openstudio::model::ZoneHVACEquipmentList::equipmentInHeatingOrder ( ) const

Return all equipment.

Order is determined by heating priority. Equipment having a Heating Priority of 0 is filtered out (unavailable)

unsigned openstudio::model::ZoneHVACEquipmentList::heatingPriority ( const ModelObject equipment) const

Return the heating or no-load priority for equipment.

static IddObjectType openstudio::model::ZoneHVACEquipmentList::iddObjectType ( )
static
std::string openstudio::model::ZoneHVACEquipmentList::loadDistributionScheme ( ) const
static std::vector<std::string> openstudio::model::ZoneHVACEquipmentList::loadDistributionSchemeValues ( )
static
bool openstudio::model::ZoneHVACEquipmentList::removeEquipment ( const ModelObject equipment)

Remove equipment from the EquipmentList.

This will not remove the equipment from the model or disconnect any node connections. Use only if you know what you are doing.

OS_DEPRECATED boost::optional<double> openstudio::model::ZoneHVACEquipmentList::sequentialCoolingFraction ( const ModelObject equipment) const

Return the Sequential Cooling Fraction of equipment.

Returns nothing if when equipment is not in the ZoneHVACEquipmentList, its heating priority is zero, or the loadDistributionScheme isn't 'Sequential'

boost::optional<Schedule> openstudio::model::ZoneHVACEquipmentList::sequentialCoolingFractionSchedule ( const ModelObject equipment) const

Return the Sequential Cooling Fraction Schedule of equipment.

Returns nothing if when equipment is not in the ZoneHVACEquipmentList, its heating priority is zero, or the loadDistributionScheme isn't 'Sequential'

OS_DEPRECATED boost::optional<double> openstudio::model::ZoneHVACEquipmentList::sequentialHeatingFraction ( const ModelObject equipment) const

Return the Sequential Heating Fraction of equipment.

Returns nothing if when equipment is not in the ZoneHVACEquipmentList, its cooling priority is zero, or the loadDistributionScheme isn't 'Sequential'

boost::optional<Schedule> openstudio::model::ZoneHVACEquipmentList::sequentialHeatingFractionSchedule ( const ModelObject equipment) const

Return the Sequential Heating Fraction Schedule of equipment.

Returns nothing if when equipment is not in the ZoneHVACEquipmentList, its cooling priority is zero, or the loadDistributionScheme isn't 'Sequential'

bool openstudio::model::ZoneHVACEquipmentList::setCoolingPriority ( const ModelObject equipment,
unsigned  priority 
)

Set cooling priority of equipment.

Returns false when equipment is not in the ZoneHVACEquipmentList

bool openstudio::model::ZoneHVACEquipmentList::setHeatingPriority ( const ModelObject equipment,
unsigned  priority 
)

Set heating or no-load priority of equipment.

Returns false when equipment is not in the ZoneHVACEquipmentList

bool openstudio::model::ZoneHVACEquipmentList::setLoadDistributionScheme ( std::string  scheme)
OS_DEPRECATED bool openstudio::model::ZoneHVACEquipmentList::setSequentialCoolingFraction ( const ModelObject equipment,
double  fraction 
)

Set the Sequential Cooling Fraction Schedule Constant of equipment.

Returns false when equipment is not in the ZoneHVACEquipmentList, its cooling priority is zero, or the loadDistributionScheme isn't 'Sequential'

bool openstudio::model::ZoneHVACEquipmentList::setSequentialCoolingFractionSchedule ( const ModelObject equipment,
const Schedule schedule 
)

Set the Sequential Cooling Fraction Schedule of equipment.

Returns false when equipement is not in the ZoneHVACEquipmentList, its cooling priority is zero, or the loadDistributionScheme isn't 'Sequential'

OS_DEPRECATED bool openstudio::model::ZoneHVACEquipmentList::setSequentialHeatingFraction ( const ModelObject equipment,
double  fraction 
)

Set the Sequential Heating Fraction Schedule Constant of equipment.

Returns false when equipment is not in the ZoneHVACEquipmentList, its heating priority is zero, or the loadDistributionScheme isn't 'Sequential'

bool openstudio::model::ZoneHVACEquipmentList::setSequentialHeatingFractionSchedule ( const ModelObject equipment,
const Schedule schedule 
)

Set the Sequential Heating Fraction Schedule of equipment.

Returns false when equipment is not in the ZoneHVACEquipmentList, its heating priority is zero, or the loadDistributionScheme isn't 'Sequential'

ThermalZone openstudio::model::ZoneHVACEquipmentList::thermalZone ( ) const
static std::vector<std::string> openstudio::model::ZoneHVACEquipmentList::validLoadDistributionSchemeValues ( )
static

Friends And Related Function Documentation

typedef boost::optional<ZoneHVACEquipmentList> OptionalZoneHVACEquipmentList
related
typedef std::vector<ZoneHVACEquipmentList> ZoneHVACEquipmentListVector
related