InternalMassDefinition Class Reference

#include "InternalMassDefinition.hpp"

Inheritance diagram for openstudio::model::InternalMassDefinition:

Public Member Functions
	InternalMassDefinition (const Model &model)
virtual	~InternalMassDefinition ()
boost::optional< ConstructionBase >	construction () const
bool	isConstructionDefaulted () const
std::string	designLevelCalculationMethod () const
boost::optional< double >	surfaceArea () const
boost::optional< double >	surfaceAreaperSpaceFloorArea () const
boost::optional< double >	surfaceAreaperPerson () const
bool	setConstruction (const ConstructionBase &construction)
void	resetConstruction ()
bool	setSurfaceArea (double surfaceArea)
bool	setSurfaceAreaperSpaceFloorArea (double surfaceAreaperSpaceFloorArea)
bool	setSurfaceAreaperPerson (double surfaceAreaperPerson)
double	getSurfaceArea (double floorArea, double numPeople) const
double	getSurfaceAreaPerFloorArea (double floorArea, double numPeople) const
double	getSurfaceAreaPerPerson (double floorArea, double numPeople) const
bool	setDesignLevelCalculationMethod (const std::string &method, double floorArea, double numPeople)

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

Related Functions
typedef std::vector < InternalMassDefinition >	InternalMassDefinitionVector
typedef boost::optional < InternalMassDefinition >	OptionalInternalMassDefinition

Detailed Description

InternalMassDefinition is a SpaceLoadDefinition that wraps the OpenStudio IDD object 'OS_InternalMass_Definition'.

Its fields are derived from the EnergyPlus IDD object 'InternalMass'.

See also

InternalMass

Constructor & Destructor Documentation

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

explicit

virtual openstudio::model::InternalMassDefinition::~InternalMassDefinition ( )

inlinevirtual

Member Function Documentation

boost::optional<ConstructionBase> openstudio::model::InternalMassDefinition::construction

(

)

const

Returns the construction object, if this object does not directly specify construction the hierarchy is searched.

std::string openstudio::model::InternalMassDefinition::designLevelCalculationMethod

(

)

const

double openstudio::model::InternalMassDefinition::getSurfaceArea	(	double	floorArea,
		double	numPeople
	)		const

Returns the construction surface area represented by this definition, assuming floorArea (m^2) and numPeople.

double openstudio::model::InternalMassDefinition::getSurfaceAreaPerFloorArea	(	double	floorArea,
		double	numPeople
	)		const

Returns the m^2/m^2 of construction surface area per floor area represented by this definition, assuming floorArea (m^2) and numPeople.

double openstudio::model::InternalMassDefinition::getSurfaceAreaPerPerson	(	double	floorArea,
		double	numPeople
	)		const

Returns the m^2/person of construction surface area represented by this definition, assuming floorArea (m^2) and numPeople.

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

static

bool openstudio::model::InternalMassDefinition::isConstructionDefaulted

(

)

const

Returns true if the construction is not directly referenced by this surface .

void openstudio::model::InternalMassDefinition::resetConstruction

(

)

Resets the construction object.

bool openstudio::model::InternalMassDefinition::setConstruction

(

const ConstructionBase &

construction

)

Sets the construction object.

bool openstudio::model::InternalMassDefinition::setDesignLevelCalculationMethod	(	const std::string &	method,
		double	floorArea,
		double	numPeople
	)

If method is a valid design level calculation method , changes this definition to an equivalent construction surface area, under the assumptions of floorArea (m^2) and numPeople.

bool openstudio::model::InternalMassDefinition::setSurfaceArea

(

double

surfaceArea

)

Sets designLevelCalculationMethod to 'SurfaceArea', clears surfaceAreaperSpaceFloorArea and surfaceAreaperPerson, and sets surfaceArea.

bool openstudio::model::InternalMassDefinition::setSurfaceAreaperPerson

(

double

surfaceAreaperPerson

)

Sets designLevelCalculationMethod to 'SurfaceArea/Person', clears surfaceArea and surfaceAreaperSpaceFloorArea, and sets surfaceAreaperPerson.

bool openstudio::model::InternalMassDefinition::setSurfaceAreaperSpaceFloorArea

(

double

surfaceAreaperSpaceFloorArea

)

Sets designLevelCalculationMethod to 'SurfaceArea/Area', clears surfaceArea and surfaceAreaperPerson, and sets surfaceAreaperSpaceFloorArea.

boost::optional<double> openstudio::model::InternalMassDefinition::surfaceArea

(

)

const

boost::optional<double> openstudio::model::InternalMassDefinition::surfaceAreaperPerson

(

)

const

boost::optional<double> openstudio::model::InternalMassDefinition::surfaceAreaperSpaceFloorArea

(

)

const

static std::vector<std::string> openstudio::model::InternalMassDefinition::validDesignLevelCalculationMethodValues ( )

static

Friends And Related Function Documentation

typedef std::vector<InternalMassDefinition> InternalMassDefinitionVector

related

typedef boost::optional<InternalMassDefinition> OptionalInternalMassDefinition

related