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

#include <CentralHeatPumpSystem.hpp>

+ Inheritance diagram for openstudio::model::CentralHeatPumpSystem:

Public Member Functions

Constructors and Destructors
 CentralHeatPumpSystem (const Model &model)
 
virtual ~CentralHeatPumpSystem ()
 
Getters
std::string controlMethod () const
 
double ancillaryPower () const
 
boost::optional< ScheduleancillaryOperationSchedule () const
 
Setters
bool setControlMethod (std::string controlMethod)
 
bool setAncillaryPower (double ancillaryPower)
 
bool setAncillaryOperationSchedule (Schedule &schedule)
 
void resetAncillaryOperationSchedule ()
 
Other
bool addModule (const CentralHeatPumpSystemModule &centralHeatPumpSystemModule)
 
void removeModule (const CentralHeatPumpSystemModule &centralHeatPumpSystemModule)
 
void removeAllModules ()
 
std::vector
< CentralHeatPumpSystemModule
modules () const
 
boost::optional< PlantLoopcoolingPlantLoop () const
 Convenience Function to return the Cooling Loop. More...
 
boost::optional< PlantLoopsourcePlantLoop () const
 Convenience Function to return the Source Loop. More...
 
boost::optional< PlantLoopheatingPlantLoop () const
 Convenience Function to return the Heating Loop. More...
 
- Public Member Functions inherited from openstudio::model::WaterToWaterComponent
virtual bool addToNode (Node &node)
 
virtual bool addToTertiaryNode (Node &node)
 Add this WaterToWaterComponent to a tertiaryPlantLoop by making connections to the tertiary inlet and outlet. More...
 
virtual ModelObject clone (Model model) const
 
virtual boost::optional
< ModelObject
demandInletModelObject ()
 Returns the optional ModelObject connected to the demand inlet port. More...
 
virtual unsigned demandInletPort ()
 Returns the demand inlet port. More...
 
virtual boost::optional
< ModelObject
demandOutletModelObject ()
 Returns the optional ModelObject connected to the demand outlet port. More...
 
virtual unsigned demandOutletPort ()
 Returns the demand outlet port. More...
 
void disconnect ()
 
boost::optional< PlantLoopplantLoop () const
 Returns the optional PlantLoop object that the HVAC component is a supply component on. More...
 
virtual std::vector
< openstudio::IdfObject
remove ()
 
bool removeFromPlantLoop ()
 Removes the component from the plantLoop if one is attached. More...
 
bool removeFromSecondaryPlantLoop ()
 Removes the component from the secondaryPlantLoop if one is attached. More...
 
bool removeFromTertiaryPlantLoop ()
 Removes the component from the tertiaryPlantLoop if one is attached. More...
 
boost::optional< PlantLoopsecondaryPlantLoop () const
 Returns the optional PlantLoop object that the HVAC component is a demand component on. More...
 
virtual boost::optional
< ModelObject
supplyInletModelObject ()
 Returns the optional ModelObject connected to the supply inlet port. More...
 
virtual unsigned supplyInletPort ()
 Returns the supply inlet port. More...
 
virtual boost::optional
< ModelObject
supplyOutletModelObject ()
 Returns the optional ModelObject connected to the supply outlet port. More...
 
virtual unsigned supplyOutletPort ()
 Returns the supply outlet port. More...
 
boost::optional< ModelObjecttertiaryInletModelObject () const
 Returns the optional ModelObject connected to the tertiary inlet. More...
 
boost::optional< ModelObjecttertiaryOutletModelObject () const
 Returns the optional ModelObject connected to the tertiary outlet. More...
 
boost::optional< PlantLooptertiaryPlantLoop () const
 Tertiary plant loop applies to a limited number of WaterToWaterComponent types that interact with three plant systems. More...
 
 WaterToWaterComponent (IddObjectType type, const Model &model)
 
virtual ~WaterToWaterComponent ()
 
- 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< AirLoopHVACairLoopHVAC () 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...
 
boost::optional< HVACComponentcontainingHVACComponent () 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< Looploop () const
 Returns the optional Loop object that the HVAC component is attached to. More...
 
boost::optional< PlantLoopplantLoop () const
 Returns the optional PlantLoop object that the HVAC component is attached to. More...
 
std::vector< IdfObjectremove ()
 Removes the HVACComponent from the model only if isRemovable() return true. More...
 
virtual ~HVACComponent ()
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectTypeallowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () 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< 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...
 
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< 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 std::vector< std::string > controlMethodValues ()
 
static IddObjectType iddObjectType ()
 
- 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 std::vector
< CentralHeatPumpSystem
CentralHeatPumpSystemVector
 
typedef boost::optional
< CentralHeatPumpSystem
OptionalCentralHeatPumpSystem
 

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::HVACComponent
typedef detail::HVACComponent_Impl ImplType
 
- 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::HVACComponent
virtual std::vector< ModelObjectchildren () const
 
 HVACComponent (IddObjectType type, const Model &model)
 Returns the optional ModelObject connected to this object's port. More...
 
 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)
 
- 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

CentralHeatPumpSystem is a WaterToWaterComponent that wraps the OpenStudio IDD object 'OS:CentralHeatPumpSystem'.

Constructor & Destructor Documentation

openstudio::model::CentralHeatPumpSystem::CentralHeatPumpSystem ( const Model model)
explicit
virtual openstudio::model::CentralHeatPumpSystem::~CentralHeatPumpSystem ( )
inlinevirtual

Member Function Documentation

bool openstudio::model::CentralHeatPumpSystem::addModule ( const CentralHeatPumpSystemModule centralHeatPumpSystemModule)
boost::optional<Schedule> openstudio::model::CentralHeatPumpSystem::ancillaryOperationSchedule ( ) const
double openstudio::model::CentralHeatPumpSystem::ancillaryPower ( ) const
std::string openstudio::model::CentralHeatPumpSystem::controlMethod ( ) const
static std::vector<std::string> openstudio::model::CentralHeatPumpSystem::controlMethodValues ( )
static
boost::optional<PlantLoop> openstudio::model::CentralHeatPumpSystem::coolingPlantLoop ( ) const

Convenience Function to return the Cooling Loop.

boost::optional<PlantLoop> openstudio::model::CentralHeatPumpSystem::heatingPlantLoop ( ) const

Convenience Function to return the Heating Loop.

static IddObjectType openstudio::model::CentralHeatPumpSystem::iddObjectType ( )
static
std::vector<CentralHeatPumpSystemModule> openstudio::model::CentralHeatPumpSystem::modules ( ) const
void openstudio::model::CentralHeatPumpSystem::removeAllModules ( )
void openstudio::model::CentralHeatPumpSystem::removeModule ( const CentralHeatPumpSystemModule centralHeatPumpSystemModule)
void openstudio::model::CentralHeatPumpSystem::resetAncillaryOperationSchedule ( )
bool openstudio::model::CentralHeatPumpSystem::setAncillaryOperationSchedule ( Schedule schedule)
bool openstudio::model::CentralHeatPumpSystem::setAncillaryPower ( double  ancillaryPower)
bool openstudio::model::CentralHeatPumpSystem::setControlMethod ( std::string  controlMethod)
boost::optional<PlantLoop> openstudio::model::CentralHeatPumpSystem::sourcePlantLoop ( ) const

Convenience Function to return the Source Loop.

Friends And Related Function Documentation

typedef std::vector<CentralHeatPumpSystem> CentralHeatPumpSystemVector
related
typedef boost::optional<CentralHeatPumpSystem> OptionalCentralHeatPumpSystem
related