CentralHeatPumpSystem Class Reference

#include "CentralHeatPumpSystem.hpp"

Inheritance diagram for openstudio::model::CentralHeatPumpSystem:

Public Member Functions
	CentralHeatPumpSystem (const Model &model)
virtual	~CentralHeatPumpSystem ()
std::string	controlMethod () const
double	ancillaryPower () const
boost::optional< Schedule >	ancillaryOperationSchedule () const
bool	setControlMethod (std::string controlMethod)
bool	setAncillaryPower (double ancillaryPower)
bool	setAncillaryOperationSchedule (Schedule &schedule)
void	resetAncillaryOperationSchedule ()
bool	addModule (const CentralHeatPumpSystemModule &centralHeatPumpSystemModule)
void	removeModule (const CentralHeatPumpSystemModule &centralHeatPumpSystemModule)
void	removeAllModules ()
std::vector < CentralHeatPumpSystemModule >	modules () const
boost::optional< PlantLoop >	coolingPlantLoop () const
boost::optional< PlantLoop >	sourcePlantLoop () const
boost::optional< PlantLoop >	heatingPlantLoop () const

Static Public Member Functions
static std::vector< std::string >	controlMethodValues ()
static IddObjectType	iddObjectType ()

Related Functions
typedef std::vector < CentralHeatPumpSystem >	CentralHeatPumpSystemVector
typedef boost::optional < CentralHeatPumpSystem >	OptionalCentralHeatPumpSystem

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