SurfacePropertyConvectionCoefficients Class Reference

#include "SurfacePropertyConvectionCoefficients.hpp"

Inheritance diagram for openstudio::model::SurfacePropertyConvectionCoefficients:

Public Member Functions
	SurfacePropertyConvectionCoefficients (const Surface &surface)
	SurfacePropertyConvectionCoefficients (const SubSurface &surface)
	SurfacePropertyConvectionCoefficients (const InternalMass &surface)
virtual	~SurfacePropertyConvectionCoefficients ()=default
	SurfacePropertyConvectionCoefficients (const SurfacePropertyConvectionCoefficients &other)=default
	SurfacePropertyConvectionCoefficients (SurfacePropertyConvectionCoefficients &&other)=default
SurfacePropertyConvectionCoefficients &	operator= (const SurfacePropertyConvectionCoefficients &)=default
SurfacePropertyConvectionCoefficients &	operator= (SurfacePropertyConvectionCoefficients &&)=default
ModelObject	surfaceAsModelObject () const
boost::optional< Surface >	surfaceAsSurface () const
boost::optional< SubSurface >	surfaceAsSubSurface () const
boost::optional< InternalMass >	surfaceAsInternalMass () const
boost::optional< std::string >	convectionCoefficient1Location () const
boost::optional< std::string >	convectionCoefficient1Type () const
boost::optional< double >	convectionCoefficient1 () const
boost::optional< Schedule >	convectionCoefficient1Schedule () const
boost::optional< std::string >	convectionCoefficient2Location () const
boost::optional< std::string >	convectionCoefficient2Type () const
boost::optional< double >	convectionCoefficient2 () const
boost::optional< Schedule >	convectionCoefficient2Schedule () const
bool	setSurface (const ModelObject &surface)
bool	setConvectionCoefficient1Location (const std::string &convectionCoefficient1Location)
void	resetConvectionCoefficient1Location ()
bool	setConvectionCoefficient1Type (const std::string &convectionCoefficient1Type)
void	resetConvectionCoefficient1Type ()
bool	setConvectionCoefficient1 (double convectionCoefficient1)
void	resetConvectionCoefficient1 ()
bool	setConvectionCoefficient1Schedule (Schedule &schedule)
void	resetConvectionCoefficient1Schedule ()
bool	setConvectionCoefficient2Location (const std::string &convectionCoefficient2Location)
void	resetConvectionCoefficient2Location ()
bool	setConvectionCoefficient2Type (const std::string &convectionCoefficient2Type)
void	resetConvectionCoefficient2Type ()
bool	setConvectionCoefficient2 (double convectionCoefficient2)
void	resetConvectionCoefficient2 ()
bool	setConvectionCoefficient2Schedule (Schedule &schedule)
void	resetConvectionCoefficient2Schedule ()

Static Public Member Functions
static std::vector< std::string >	convectionCoefficient1LocationValues ()
static std::vector< std::string >	convectionCoefficient1TypeValues ()
static std::vector< std::string >	convectionCoefficient2LocationValues ()
static std::vector< std::string >	convectionCoefficient2TypeValues ()
static IddObjectType	iddObjectType ()

Related Functions
using	OptionalSurfacePropertyConvectionCoefficients = boost::optional< SurfacePropertyConvectionCoefficients >
using	SurfacePropertyConvectionCoefficientsVector = std::vector< SurfacePropertyConvectionCoefficients >

Detailed Description

SurfacePropertyConvectionCoefficients is a ModelObject that wraps the OpenStudio IDD object 'OS:SurfaceProperty:ConvectionCoefficients'.

Constructor & Destructor Documentation

openstudio::model::SurfacePropertyConvectionCoefficients::SurfacePropertyConvectionCoefficients ( const Surface &  surface )

explicit

openstudio::model::SurfacePropertyConvectionCoefficients::SurfacePropertyConvectionCoefficients ( const SubSurface &  surface )

explicit

openstudio::model::SurfacePropertyConvectionCoefficients::SurfacePropertyConvectionCoefficients ( const InternalMass &  surface )

explicit

virtual openstudio::model::SurfacePropertyConvectionCoefficients::~SurfacePropertyConvectionCoefficients ( )

virtualdefault

openstudio::model::SurfacePropertyConvectionCoefficients::SurfacePropertyConvectionCoefficients ( const SurfacePropertyConvectionCoefficients &  other )

default

openstudio::model::SurfacePropertyConvectionCoefficients::SurfacePropertyConvectionCoefficients ( SurfacePropertyConvectionCoefficients &&  other )

default

Member Function Documentation

boost::optional<double> openstudio::model::SurfacePropertyConvectionCoefficients::convectionCoefficient1

(

)

const

boost::optional<std::string> openstudio::model::SurfacePropertyConvectionCoefficients::convectionCoefficient1Location

(

)

const

static std::vector<std::string> openstudio::model::SurfacePropertyConvectionCoefficients::convectionCoefficient1LocationValues ( )

static

boost::optional<Schedule> openstudio::model::SurfacePropertyConvectionCoefficients::convectionCoefficient1Schedule

(

)

const

boost::optional<std::string> openstudio::model::SurfacePropertyConvectionCoefficients::convectionCoefficient1Type

(

)

const

static std::vector<std::string> openstudio::model::SurfacePropertyConvectionCoefficients::convectionCoefficient1TypeValues ( )

static

boost::optional<double> openstudio::model::SurfacePropertyConvectionCoefficients::convectionCoefficient2

(

)

const

boost::optional<std::string> openstudio::model::SurfacePropertyConvectionCoefficients::convectionCoefficient2Location

(

)

const

static std::vector<std::string> openstudio::model::SurfacePropertyConvectionCoefficients::convectionCoefficient2LocationValues ( )

static

boost::optional<Schedule> openstudio::model::SurfacePropertyConvectionCoefficients::convectionCoefficient2Schedule

(

)

const

boost::optional<std::string> openstudio::model::SurfacePropertyConvectionCoefficients::convectionCoefficient2Type

(

)

const

static std::vector<std::string> openstudio::model::SurfacePropertyConvectionCoefficients::convectionCoefficient2TypeValues ( )

static

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

static

SurfacePropertyConvectionCoefficients& openstudio::model::SurfacePropertyConvectionCoefficients::operator= ( const SurfacePropertyConvectionCoefficients &  )

default

SurfacePropertyConvectionCoefficients& openstudio::model::SurfacePropertyConvectionCoefficients::operator= ( SurfacePropertyConvectionCoefficients &&  )

default

void openstudio::model::SurfacePropertyConvectionCoefficients::resetConvectionCoefficient1

(

)

void openstudio::model::SurfacePropertyConvectionCoefficients::resetConvectionCoefficient1Location

(

)

void openstudio::model::SurfacePropertyConvectionCoefficients::resetConvectionCoefficient1Schedule

(

)

void openstudio::model::SurfacePropertyConvectionCoefficients::resetConvectionCoefficient1Type

(

)

void openstudio::model::SurfacePropertyConvectionCoefficients::resetConvectionCoefficient2

(

)

void openstudio::model::SurfacePropertyConvectionCoefficients::resetConvectionCoefficient2Location

(

)

void openstudio::model::SurfacePropertyConvectionCoefficients::resetConvectionCoefficient2Schedule

(

)

void openstudio::model::SurfacePropertyConvectionCoefficients::resetConvectionCoefficient2Type

(

)

bool openstudio::model::SurfacePropertyConvectionCoefficients::setConvectionCoefficient1

(

double

convectionCoefficient1

)

bool openstudio::model::SurfacePropertyConvectionCoefficients::setConvectionCoefficient1Location

(

const std::string &

convectionCoefficient1Location

)

bool openstudio::model::SurfacePropertyConvectionCoefficients::setConvectionCoefficient1Schedule

(

Schedule &

schedule

)

bool openstudio::model::SurfacePropertyConvectionCoefficients::setConvectionCoefficient1Type

(

const std::string &

convectionCoefficient1Type

)

bool openstudio::model::SurfacePropertyConvectionCoefficients::setConvectionCoefficient2

(

double

convectionCoefficient2

)

bool openstudio::model::SurfacePropertyConvectionCoefficients::setConvectionCoefficient2Location

(

const std::string &

convectionCoefficient2Location

)

bool openstudio::model::SurfacePropertyConvectionCoefficients::setConvectionCoefficient2Schedule

(

Schedule &

schedule

)

bool openstudio::model::SurfacePropertyConvectionCoefficients::setConvectionCoefficient2Type

(

const std::string &

convectionCoefficient2Type

)

bool openstudio::model::SurfacePropertyConvectionCoefficients::setSurface

(

const ModelObject &

surface

)

boost::optional<InternalMass> openstudio::model::SurfacePropertyConvectionCoefficients::surfaceAsInternalMass

(

)

const

ModelObject openstudio::model::SurfacePropertyConvectionCoefficients::surfaceAsModelObject

(

)

const

boost::optional<SubSurface> openstudio::model::SurfacePropertyConvectionCoefficients::surfaceAsSubSurface

(

)

const

boost::optional<Surface> openstudio::model::SurfacePropertyConvectionCoefficients::surfaceAsSurface

(

)

const

Friends And Related Function Documentation

using OptionalSurfacePropertyConvectionCoefficients = boost::optional<SurfacePropertyConvectionCoefficients>

related

using SurfacePropertyConvectionCoefficientsVector = std::vector<SurfacePropertyConvectionCoefficients>

related