openstudio::model::SurfacePropertyOtherSideCoefficients Class Reference

#include <SurfacePropertyOtherSideCoefficients.hpp>

Inheritance diagram for openstudio::model::SurfacePropertyOtherSideCoefficients:

Public Member Functions
Constructors and Destructors
	SurfacePropertyOtherSideCoefficients (const Model &model)
virtual	~SurfacePropertyOtherSideCoefficients ()
Getters
boost::optional< double >	combinedConvectiveRadiativeFilmCoefficient () const
	If set, this field becomes the exterior convective/radiative film coefficient and the other fields are used to calculate the outdoor air temperature then exterior surface temperature based on outdoor air and specified coefficient. More...
double	constantTemperature () const
bool	isConstantTemperatureDefaulted () const
double	constantTemperatureCoefficient () const
bool	isConstantTemperatureCoefficientDefaulted () const
double	externalDryBulbTemperatureCoefficient () const
bool	isExternalDryBulbTemperatureCoefficientDefaulted () const
double	groundTemperatureCoefficient () const
bool	isGroundTemperatureCoefficientDefaulted () const
double	windSpeedCoefficient () const
bool	isWindSpeedCoefficientDefaulted () const
double	zoneAirTemperatureCoefficient () const
bool	isZoneAirTemperatureCoefficientDefaulted () const
boost::optional< Schedule >	constantTemperatureSchedule () const
bool	sinusoidalVariationofConstantTemperatureCoefficient () const
bool	isSinusoidalVariationofConstantTemperatureCoefficientDefaulted () const
double	periodofSinusoidalVariation () const
bool	isPeriodofSinusoidalVariationDefaulted () const
double	previousOtherSideTemperatureCoefficient () const
bool	isPreviousOtherSideTemperatureCoefficientDefaulted () const
boost::optional< double >	minimumOtherSideTemperatureLimit () const
boost::optional< double >	maximumOtherSideTemperatureLimit () const
Setters
bool	setCombinedConvectiveRadiativeFilmCoefficient (double combinedConvectiveRadiativeFilmCoefficient)
void	resetCombinedConvectiveRadiativeFilmCoefficient ()
bool	setConstantTemperature (double constantTemperature)
void	resetConstantTemperature ()
bool	setConstantTemperatureCoefficient (double constantTemperatureCoefficient)
void	resetConstantTemperatureCoefficient ()
bool	setExternalDryBulbTemperatureCoefficient (double externalDryBulbTemperatureCoefficient)
void	resetExternalDryBulbTemperatureCoefficient ()
bool	setGroundTemperatureCoefficient (double groundTemperatureCoefficient)
void	resetGroundTemperatureCoefficient ()
bool	setWindSpeedCoefficient (double windSpeedCoefficient)
void	resetWindSpeedCoefficient ()
bool	setZoneAirTemperatureCoefficient (double zoneAirTemperatureCoefficient)
void	resetZoneAirTemperatureCoefficient ()
bool	setConstantTemperatureSchedule (Schedule &schedule)
void	resetConstantTemperatureSchedule ()
bool	setSinusoidalVariationofConstantTemperatureCoefficient (bool sinusoidalVariationofConstantTemperatureCoefficient)
void	resetSinusoidalVariationofConstantTemperatureCoefficient ()
bool	setPeriodofSinusoidalVariation (double periodofSinusoidalVariation)
void	resetPeriodofSinusoidalVariation ()
bool	setPreviousOtherSideTemperatureCoefficient (double previousOtherSideTemperatureCoefficient)
void	resetPreviousOtherSideTemperatureCoefficient ()
bool	setMinimumOtherSideTemperatureLimit (double minimumOtherSideTemperatureLimit)
void	resetMinimumOtherSideTemperatureLimit ()
bool	setMaximumOtherSideTemperatureLimit (double maximumOtherSideTemperatureLimit)
void	resetMaximumOtherSideTemperatureLimit ()
Public Member Functions inherited from openstudio::model::ResourceObject
unsigned	directUseCount (bool excludeChildren=false) const
	Returns the number of objects that use this resource directly. More...
unsigned	nonResourceObjectUseCount (bool excludeChildren=false) const
	Returns the number of non-ResourceObjects that use this resource either directly or indirectly. More...
virtual	~ResourceObject ()
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 ()

Related Functions
(Note that these are not member functions.)
typedef boost::optional < SurfacePropertyOtherSideCoefficients >	OptionalSurfacePropertyOtherSideCoefficients
typedef std::vector < SurfacePropertyOtherSideCoefficients >	SurfacePropertyOtherSideCoefficientsVector
Related Functions inherited from openstudio::model::ResourceObject
typedef boost::optional < ResourceObject >	OptionalResourceObject
typedef std::vector < ResourceObject >	ResourceObjectVector
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...
typedef std::pair< std::string, std::string >	ScheduleTypeKey
	Typedef for ScheduleTypeRegistry key. More...
typedef std::pair< std::string, std::string >	ScheduleTypeKey
	Typedef for ScheduleTypeRegistry key. More...

Additional Inherited Members
Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl	ImplType
Protected Member Functions inherited from openstudio::model::ResourceObject
	ResourceObject (IddObjectType type, const Model &model)
	Constructs a new PlanarSurface object in the model. More...
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

SurfacePropertyOtherSideCoefficients is a ResourceObject that wraps the OpenStudio IDD object 'OS:SurfaceProperty:OtherSideCoefficients'.

Constructor & Destructor Documentation

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

explicit

virtual openstudio::model::SurfacePropertyOtherSideCoefficients::~SurfacePropertyOtherSideCoefficients ( )

inlinevirtual

Member Function Documentation

boost::optional<double> openstudio::model::SurfacePropertyOtherSideCoefficients::combinedConvectiveRadiativeFilmCoefficient

(

)

const

If set, this field becomes the exterior convective/radiative film coefficient and the other fields are used to calculate the outdoor air temperature then exterior surface temperature based on outdoor air and specified coefficient.

If not set, then remaining fields calculate the outside surface temperature.

double openstudio::model::SurfacePropertyOtherSideCoefficients::constantTemperature

(

)

const

double openstudio::model::SurfacePropertyOtherSideCoefficients::constantTemperatureCoefficient

(

)

const

boost::optional<Schedule> openstudio::model::SurfacePropertyOtherSideCoefficients::constantTemperatureSchedule

(

)

const

double openstudio::model::SurfacePropertyOtherSideCoefficients::externalDryBulbTemperatureCoefficient

(

)

const

double openstudio::model::SurfacePropertyOtherSideCoefficients::groundTemperatureCoefficient

(

)

const

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

static

bool openstudio::model::SurfacePropertyOtherSideCoefficients::isConstantTemperatureCoefficientDefaulted

(

)

const

bool openstudio::model::SurfacePropertyOtherSideCoefficients::isConstantTemperatureDefaulted

(

)

const

bool openstudio::model::SurfacePropertyOtherSideCoefficients::isExternalDryBulbTemperatureCoefficientDefaulted

(

)

const

bool openstudio::model::SurfacePropertyOtherSideCoefficients::isGroundTemperatureCoefficientDefaulted

(

)

const

bool openstudio::model::SurfacePropertyOtherSideCoefficients::isPeriodofSinusoidalVariationDefaulted

(

)

const

bool openstudio::model::SurfacePropertyOtherSideCoefficients::isPreviousOtherSideTemperatureCoefficientDefaulted

(

)

const

bool openstudio::model::SurfacePropertyOtherSideCoefficients::isSinusoidalVariationofConstantTemperatureCoefficientDefaulted

(

)

const

bool openstudio::model::SurfacePropertyOtherSideCoefficients::isWindSpeedCoefficientDefaulted

(

)

const

bool openstudio::model::SurfacePropertyOtherSideCoefficients::isZoneAirTemperatureCoefficientDefaulted

(

)

const

boost::optional<double> openstudio::model::SurfacePropertyOtherSideCoefficients::maximumOtherSideTemperatureLimit

(

)

const

boost::optional<double> openstudio::model::SurfacePropertyOtherSideCoefficients::minimumOtherSideTemperatureLimit

(

)

const

double openstudio::model::SurfacePropertyOtherSideCoefficients::periodofSinusoidalVariation

(

)

const

double openstudio::model::SurfacePropertyOtherSideCoefficients::previousOtherSideTemperatureCoefficient

(

)

const

void openstudio::model::SurfacePropertyOtherSideCoefficients::resetCombinedConvectiveRadiativeFilmCoefficient

(

)

void openstudio::model::SurfacePropertyOtherSideCoefficients::resetConstantTemperature

(

)

void openstudio::model::SurfacePropertyOtherSideCoefficients::resetConstantTemperatureCoefficient

(

)

void openstudio::model::SurfacePropertyOtherSideCoefficients::resetConstantTemperatureSchedule

(

)

void openstudio::model::SurfacePropertyOtherSideCoefficients::resetExternalDryBulbTemperatureCoefficient

(

)

void openstudio::model::SurfacePropertyOtherSideCoefficients::resetGroundTemperatureCoefficient

(

)

void openstudio::model::SurfacePropertyOtherSideCoefficients::resetMaximumOtherSideTemperatureLimit

(

)

void openstudio::model::SurfacePropertyOtherSideCoefficients::resetMinimumOtherSideTemperatureLimit

(

)

void openstudio::model::SurfacePropertyOtherSideCoefficients::resetPeriodofSinusoidalVariation

(

)

void openstudio::model::SurfacePropertyOtherSideCoefficients::resetPreviousOtherSideTemperatureCoefficient

(

)

void openstudio::model::SurfacePropertyOtherSideCoefficients::resetSinusoidalVariationofConstantTemperatureCoefficient

(

)

void openstudio::model::SurfacePropertyOtherSideCoefficients::resetWindSpeedCoefficient

(

)

void openstudio::model::SurfacePropertyOtherSideCoefficients::resetZoneAirTemperatureCoefficient

(

)

bool openstudio::model::SurfacePropertyOtherSideCoefficients::setCombinedConvectiveRadiativeFilmCoefficient

(

double

combinedConvectiveRadiativeFilmCoefficient

)

bool openstudio::model::SurfacePropertyOtherSideCoefficients::setConstantTemperature

(

double

constantTemperature

)

bool openstudio::model::SurfacePropertyOtherSideCoefficients::setConstantTemperatureCoefficient

(

double

constantTemperatureCoefficient

)

bool openstudio::model::SurfacePropertyOtherSideCoefficients::setConstantTemperatureSchedule

(

Schedule &

schedule

)

bool openstudio::model::SurfacePropertyOtherSideCoefficients::setExternalDryBulbTemperatureCoefficient

(

double

externalDryBulbTemperatureCoefficient

)

bool openstudio::model::SurfacePropertyOtherSideCoefficients::setGroundTemperatureCoefficient

(

double

groundTemperatureCoefficient

)

bool openstudio::model::SurfacePropertyOtherSideCoefficients::setMaximumOtherSideTemperatureLimit

(

double

maximumOtherSideTemperatureLimit

)

bool openstudio::model::SurfacePropertyOtherSideCoefficients::setMinimumOtherSideTemperatureLimit

(

double

minimumOtherSideTemperatureLimit

)

bool openstudio::model::SurfacePropertyOtherSideCoefficients::setPeriodofSinusoidalVariation

(

double

periodofSinusoidalVariation

)

bool openstudio::model::SurfacePropertyOtherSideCoefficients::setPreviousOtherSideTemperatureCoefficient

(

double

previousOtherSideTemperatureCoefficient

)

bool openstudio::model::SurfacePropertyOtherSideCoefficients::setSinusoidalVariationofConstantTemperatureCoefficient

(

bool

sinusoidalVariationofConstantTemperatureCoefficient

)

bool openstudio::model::SurfacePropertyOtherSideCoefficients::setWindSpeedCoefficient

(

double

windSpeedCoefficient

)

bool openstudio::model::SurfacePropertyOtherSideCoefficients::setZoneAirTemperatureCoefficient

(

double

zoneAirTemperatureCoefficient

)

bool openstudio::model::SurfacePropertyOtherSideCoefficients::sinusoidalVariationofConstantTemperatureCoefficient

(

)

const

double openstudio::model::SurfacePropertyOtherSideCoefficients::windSpeedCoefficient

(

)

const

double openstudio::model::SurfacePropertyOtherSideCoefficients::zoneAirTemperatureCoefficient

(

)

const

Friends And Related Function Documentation

typedef boost::optional<SurfacePropertyOtherSideCoefficients> OptionalSurfacePropertyOtherSideCoefficients

related

typedef std::vector<SurfacePropertyOtherSideCoefficients> SurfacePropertyOtherSideCoefficientsVector

related