openstudio::model::CoilHeatingDXSingleSpeed Class Reference

#include <CoilHeatingDXSingleSpeed.hpp>

Inheritance diagram for openstudio::model::CoilHeatingDXSingleSpeed:

Public Member Functions
boost::optional < AirflowNetworkEquivalentDuct >	airflowNetworkEquivalentDuct () const
	Returns the attached equivalent duct object, if any. More...
AirflowNetworkEquivalentDuct	getAirflowNetworkEquivalentDuct (double length, double diameter)
	Creates a new equivalent duct object if an object is not already attached. More...
Constructors and Destructors
	CoilHeatingDXSingleSpeed (const Model &model, Schedule &availabilitySchedule, Curve &totalHeatingCapacityFunctionofTemperatureCurve, Curve &totalHeatingCapacityFunctionofFlowFractionCurve, Curve &energyInputRatioFunctionofTemperatureCurve, Curve &energyInputRatioFunctionofFlowFractionCurve, Curve &partLoadFractionCorrelationCurve)
	CoilHeatingDXSingleSpeed (const Model &model)
virtual	~CoilHeatingDXSingleSpeed ()
Getters
Schedule	availabilitySchedule () const
boost::optional< double >	ratedTotalHeatingCapacity () const
bool	isRatedTotalHeatingCapacityAutosized () const
double	ratedCOP () const
boost::optional< double >	ratedAirFlowRate () const
bool	isRatedAirFlowRateAutosized () const
double	ratedSupplyFanPowerPerVolumeFlowRate () const
double	minimumOutdoorDryBulbTemperatureforCompressorOperation () const
bool	isMinimumOutdoorDryBulbTemperatureforCompressorOperationDefaulted () const
double	maximumOutdoorDryBulbTemperatureforDefrostOperation () const
bool	isMaximumOutdoorDryBulbTemperatureforDefrostOperationDefaulted () const
double	crankcaseHeaterCapacity () const
bool	isCrankcaseHeaterCapacityDefaulted () const
double	maximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation () const
bool	isMaximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperationDefaulted () const
std::string	defrostStrategy () const
bool	isDefrostStrategyDefaulted () const
std::string	defrostControl () const
bool	isDefrostControlDefaulted () const
double	defrostTimePeriodFraction () const
bool	isDefrostTimePeriodFractionDefaulted () const
boost::optional< double >	resistiveDefrostHeaterCapacity () const
bool	isResistiveDefrostHeaterCapacityDefaulted () const
bool	isResistiveDefrostHeaterCapacityAutosized () const
bool	setRatedTotalHeatingCapacity (double ratedTotalHeatingCapacity)
void	autosizeRatedTotalHeatingCapacity ()
Setters
bool	setAvailabilitySchedule (Schedule &schedule)
bool	setRatedCOP (double ratedCOP)
bool	setRatedAirFlowRate (double ratedAirFlowRate)
void	autosizeRatedAirFlowRate ()
bool	setRatedSupplyFanPowerPerVolumeFlowRate (double ratedSupplyFanPowerPerVolumeFlowRate)
bool	setMinimumOutdoorDryBulbTemperatureforCompressorOperation (double minimumOutdoorDryBulbTemperatureforCompressorOperation)
void	resetMinimumOutdoorDryBulbTemperatureforCompressorOperation ()
bool	setMaximumOutdoorDryBulbTemperatureforDefrostOperation (double maximumOutdoorDryBulbTemperatureforDefrostOperation)
void	resetMaximumOutdoorDryBulbTemperatureforDefrostOperation ()
bool	setCrankcaseHeaterCapacity (double crankcaseHeaterCapacity)
void	resetCrankcaseHeaterCapacity ()
bool	setMaximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation (double maximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation)
void	resetMaximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation ()
bool	setDefrostStrategy (std::string defrostStrategy)
void	resetDefrostStrategy ()
bool	setDefrostControl (std::string defrostControl)
void	resetDefrostControl ()
bool	setDefrostTimePeriodFraction (double defrostTimePeriodFraction)
void	resetDefrostTimePeriodFraction ()
bool	setResistiveDefrostHeaterCapacity (double resistiveDefrostHeaterCapacity)
void	resetResistiveDefrostHeaterCapacity ()
void	autosizeResistiveDefrostHeaterCapacity ()
Curves
Curve	totalHeatingCapacityFunctionofTemperatureCurve () const
bool	setTotalHeatingCapacityFunctionofTemperatureCurve (const Curve &curve)
Curve	totalHeatingCapacityFunctionofFlowFractionCurve () const
bool	setTotalHeatingCapacityFunctionofFlowFractionCurve (const Curve &curve)
Curve	energyInputRatioFunctionofTemperatureCurve () const
bool	setEnergyInputRatioFunctionofTemperatureCurve (const Curve &curve)
Curve	energyInputRatioFunctionofFlowFractionCurve () const
bool	setEnergyInputRatioFunctionofFlowFractionCurve (const Curve &curve)
Curve	partLoadFractionCorrelationCurve () const
bool	setPartLoadFractionCorrelationCurve (const Curve &curve)
boost::optional< Curve >	defrostEnergyInputRatioFunctionofTemperatureCurve () const
bool	setDefrostEnergyInputRatioFunctionofTemperatureCurve (const Curve &curve)
void	resetDefrostEnergyInputRatioFunctionofTemperatureCurve ()
boost::optional< double >	autosizedRatedTotalHeatingCapacity () const
boost::optional< double >	autosizedRatedAirFlowRate () const
boost::optional< double >	autosizedResistiveDefrostHeaterCapacity () const
Public Member Functions inherited from openstudio::model::StraightComponent
bool	addToNode (Node &node)
boost::optional< AirLoopHVAC >	airLoopHVAC () const
	Returns the optional AirLoopHVAC object that this AirToAirComponent is attached to. More...
ModelObject	clone (Model model) const
void	disconnect ()
boost::optional< ModelObject >	inletModelObject () const
	Returns the optional ModelObject connected to the inlet port. More...
unsigned	inletPort () const
	Returns the inlet port. More...
boost::optional< ModelObject >	outletModelObject () const
	Returns the optional ModelObject connected to the outlet port. More...
unsigned	outletPort () const
	Returns the outlet port. More...
std::vector < openstudio::IdfObject >	remove ()
bool	removeFromLoop ()
	StraightComponent (IddObjectType type, const Model &model)
virtual	~StraightComponent ()
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...
void	applySizingValues ()
void	autosize ()
	Returns the optional ModelObject connected to this object's port. More...
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...
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< Loop >	loop () const
	Returns the optional Loop object that the HVAC component is attached to. More...
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 ()
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...
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< 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...
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 (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< ModelObject >	connectedObject (unsigned port) const
boost::optional< unsigned >	connectedObjectPort (unsigned port) const

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

Related Functions
(Note that these are not member functions.)
typedef std::vector < CoilHeatingDXSingleSpeed >	CoilHeatingDXSingleSpeedVector
typedef boost::optional < CoilHeatingDXSingleSpeed >	OptionalCoilHeatingDXSingleSpeed
Related Functions inherited from openstudio::model::ParentObject
std::vector< ModelObject >	getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false)
	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...

Additional Inherited Members
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 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)

Detailed Description

CoilHeatingDXSingleSpeed is a StraightComponent that wraps the OpenStudio IDD object 'OS:Coil:Heating:DX:SingleSpeed'.

Constructor & Destructor Documentation

openstudio::model::CoilHeatingDXSingleSpeed::CoilHeatingDXSingleSpeed ( const Model &  model, Schedule &  availabilitySchedule, Curve &  totalHeatingCapacityFunctionofTemperatureCurve, Curve &  totalHeatingCapacityFunctionofFlowFractionCurve, Curve &  energyInputRatioFunctionofTemperatureCurve, Curve &  energyInputRatioFunctionofFlowFractionCurve, Curve &  partLoadFractionCorrelationCurve  )

explicit

openstudio::model::CoilHeatingDXSingleSpeed::CoilHeatingDXSingleSpeed ( const Model &  model )

explicit

virtual openstudio::model::CoilHeatingDXSingleSpeed::~CoilHeatingDXSingleSpeed ( )

inlinevirtual

Member Function Documentation

boost::optional<AirflowNetworkEquivalentDuct> openstudio::model::CoilHeatingDXSingleSpeed::airflowNetworkEquivalentDuct

(

)

const

Returns the attached equivalent duct object, if any.

boost::optional<double> openstudio::model::CoilHeatingDXSingleSpeed::autosizedRatedAirFlowRate

(

)

const

boost::optional<double> openstudio::model::CoilHeatingDXSingleSpeed::autosizedRatedTotalHeatingCapacity

(

)

const

boost::optional<double> openstudio::model::CoilHeatingDXSingleSpeed::autosizedResistiveDefrostHeaterCapacity

(

)

const

void openstudio::model::CoilHeatingDXSingleSpeed::autosizeRatedAirFlowRate

(

)

void openstudio::model::CoilHeatingDXSingleSpeed::autosizeRatedTotalHeatingCapacity

(

)

void openstudio::model::CoilHeatingDXSingleSpeed::autosizeResistiveDefrostHeaterCapacity

(

)

Schedule openstudio::model::CoilHeatingDXSingleSpeed::availabilitySchedule

(

)

const

double openstudio::model::CoilHeatingDXSingleSpeed::crankcaseHeaterCapacity

(

)

const

std::string openstudio::model::CoilHeatingDXSingleSpeed::defrostControl

(

)

const

boost::optional<Curve> openstudio::model::CoilHeatingDXSingleSpeed::defrostEnergyInputRatioFunctionofTemperatureCurve

(

)

const

std::string openstudio::model::CoilHeatingDXSingleSpeed::defrostStrategy

(

)

const

double openstudio::model::CoilHeatingDXSingleSpeed::defrostTimePeriodFraction

(

)

const

Curve openstudio::model::CoilHeatingDXSingleSpeed::energyInputRatioFunctionofFlowFractionCurve

(

)

const

Curve openstudio::model::CoilHeatingDXSingleSpeed::energyInputRatioFunctionofTemperatureCurve

(

)

const

AirflowNetworkEquivalentDuct openstudio::model::CoilHeatingDXSingleSpeed::getAirflowNetworkEquivalentDuct	(	double	length,
		double	diameter
	)

Creates a new equivalent duct object if an object is not already attached.

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

static

bool openstudio::model::CoilHeatingDXSingleSpeed::isCrankcaseHeaterCapacityDefaulted

(

)

const

bool openstudio::model::CoilHeatingDXSingleSpeed::isDefrostControlDefaulted

(

)

const

bool openstudio::model::CoilHeatingDXSingleSpeed::isDefrostStrategyDefaulted

(

)

const

bool openstudio::model::CoilHeatingDXSingleSpeed::isDefrostTimePeriodFractionDefaulted

(

)

const

bool openstudio::model::CoilHeatingDXSingleSpeed::isMaximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperationDefaulted

(

)

const

bool openstudio::model::CoilHeatingDXSingleSpeed::isMaximumOutdoorDryBulbTemperatureforDefrostOperationDefaulted

(

)

const

bool openstudio::model::CoilHeatingDXSingleSpeed::isMinimumOutdoorDryBulbTemperatureforCompressorOperationDefaulted

(

)

const

bool openstudio::model::CoilHeatingDXSingleSpeed::isRatedAirFlowRateAutosized

(

)

const

bool openstudio::model::CoilHeatingDXSingleSpeed::isRatedTotalHeatingCapacityAutosized

(

)

const

bool openstudio::model::CoilHeatingDXSingleSpeed::isResistiveDefrostHeaterCapacityAutosized

(

)

const

bool openstudio::model::CoilHeatingDXSingleSpeed::isResistiveDefrostHeaterCapacityDefaulted

(

)

const

double openstudio::model::CoilHeatingDXSingleSpeed::maximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation

(

)

const

double openstudio::model::CoilHeatingDXSingleSpeed::maximumOutdoorDryBulbTemperatureforDefrostOperation

(

)

const

double openstudio::model::CoilHeatingDXSingleSpeed::minimumOutdoorDryBulbTemperatureforCompressorOperation

(

)

const

Curve openstudio::model::CoilHeatingDXSingleSpeed::partLoadFractionCorrelationCurve

(

)

const

boost::optional<double> openstudio::model::CoilHeatingDXSingleSpeed::ratedAirFlowRate

(

)

const

double openstudio::model::CoilHeatingDXSingleSpeed::ratedCOP

(

)

const

double openstudio::model::CoilHeatingDXSingleSpeed::ratedSupplyFanPowerPerVolumeFlowRate

(

)

const

boost::optional<double> openstudio::model::CoilHeatingDXSingleSpeed::ratedTotalHeatingCapacity

(

)

const

void openstudio::model::CoilHeatingDXSingleSpeed::resetCrankcaseHeaterCapacity

(

)

void openstudio::model::CoilHeatingDXSingleSpeed::resetDefrostControl

(

)

void openstudio::model::CoilHeatingDXSingleSpeed::resetDefrostEnergyInputRatioFunctionofTemperatureCurve

(

)

void openstudio::model::CoilHeatingDXSingleSpeed::resetDefrostStrategy

(

)

void openstudio::model::CoilHeatingDXSingleSpeed::resetDefrostTimePeriodFraction

(

)

void openstudio::model::CoilHeatingDXSingleSpeed::resetMaximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation

(

)

void openstudio::model::CoilHeatingDXSingleSpeed::resetMaximumOutdoorDryBulbTemperatureforDefrostOperation

(

)

void openstudio::model::CoilHeatingDXSingleSpeed::resetMinimumOutdoorDryBulbTemperatureforCompressorOperation

(

)

void openstudio::model::CoilHeatingDXSingleSpeed::resetResistiveDefrostHeaterCapacity

(

)

boost::optional<double> openstudio::model::CoilHeatingDXSingleSpeed::resistiveDefrostHeaterCapacity

(

)

const

bool openstudio::model::CoilHeatingDXSingleSpeed::setAvailabilitySchedule

(

Schedule &

schedule

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setCrankcaseHeaterCapacity

(

double

crankcaseHeaterCapacity

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setDefrostControl

(

std::string

defrostControl

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setDefrostEnergyInputRatioFunctionofTemperatureCurve

(

const Curve &

curve

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setDefrostStrategy

(

std::string

defrostStrategy

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setDefrostTimePeriodFraction

(

double

defrostTimePeriodFraction

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setEnergyInputRatioFunctionofFlowFractionCurve

(

const Curve &

curve

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setEnergyInputRatioFunctionofTemperatureCurve

(

const Curve &

curve

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setMaximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation

(

double

maximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setMaximumOutdoorDryBulbTemperatureforDefrostOperation

(

double

maximumOutdoorDryBulbTemperatureforDefrostOperation

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setMinimumOutdoorDryBulbTemperatureforCompressorOperation

(

double

minimumOutdoorDryBulbTemperatureforCompressorOperation

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setPartLoadFractionCorrelationCurve

(

const Curve &

curve

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setRatedAirFlowRate

(

double

ratedAirFlowRate

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setRatedCOP

(

double

ratedCOP

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setRatedSupplyFanPowerPerVolumeFlowRate

(

double

ratedSupplyFanPowerPerVolumeFlowRate

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setRatedTotalHeatingCapacity

(

double

ratedTotalHeatingCapacity

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setResistiveDefrostHeaterCapacity

(

double

resistiveDefrostHeaterCapacity

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setTotalHeatingCapacityFunctionofFlowFractionCurve

(

const Curve &

curve

)

bool openstudio::model::CoilHeatingDXSingleSpeed::setTotalHeatingCapacityFunctionofTemperatureCurve

(

const Curve &

curve

)

Curve openstudio::model::CoilHeatingDXSingleSpeed::totalHeatingCapacityFunctionofFlowFractionCurve

(

)

const

Curve openstudio::model::CoilHeatingDXSingleSpeed::totalHeatingCapacityFunctionofTemperatureCurve

(

)

const

static std::vector<std::string> openstudio::model::CoilHeatingDXSingleSpeed::validDefrostControlValues ( )

static

static std::vector<std::string> openstudio::model::CoilHeatingDXSingleSpeed::validDefrostStrategyValues ( )

static

Friends And Related Function Documentation

typedef std::vector<CoilHeatingDXSingleSpeed> CoilHeatingDXSingleSpeedVector

related

typedef boost::optional<CoilHeatingDXSingleSpeed> OptionalCoilHeatingDXSingleSpeed

related