PeopleDefinition Class Reference

#include "PeopleDefinition.hpp"

Inheritance diagram for openstudio::model::PeopleDefinition:

Public Member Functions
	PeopleDefinition (const Model &model)
virtual	~PeopleDefinition ()=default
	PeopleDefinition (const PeopleDefinition &other)=default
	PeopleDefinition (PeopleDefinition &&other)=default
PeopleDefinition &	operator= (const PeopleDefinition &)=default
PeopleDefinition &	operator= (PeopleDefinition &&)=default
std::string	numberofPeopleCalculationMethod () const
boost::optional< double >	numberofPeople () const
boost::optional< double >	peopleperSpaceFloorArea () const
boost::optional< double >	spaceFloorAreaperPerson () const
double	fractionRadiant () const
boost::optional< double >	sensibleHeatFraction () const
bool	isSensibleHeatFractionDefaulted () const
bool	isSensibleHeatFractionAutocalculated () const
double	carbonDioxideGenerationRate () const
bool	isCarbonDioxideGenerationRateDefaulted () const
bool	enableASHRAE55ComfortWarnings () const
bool	isEnableASHRAE55ComfortWarningsDefaulted () const
std::string	meanRadiantTemperatureCalculationType () const
bool	isMeanRadiantTemperatureCalculationTypeDefaulted () const
boost::optional< std::string >	getThermalComfortModelType (int i) const
int	numThermalComfortModelTypes () const
bool	setNumberofPeople (double numberofPeople)
bool	setPeopleperSpaceFloorArea (double peopleperSpaceFloorArea)
bool	setSpaceFloorAreaperPerson (double spaceFloorAreaperPerson)
bool	setFractionRadiant (double fractionRadiant)
bool	setSensibleHeatFraction (double sensibleHeatFraction)
void	resetSensibleHeatFraction ()
void	autocalculateSensibleHeatFraction ()
bool	setCarbonDioxideGenerationRate (double carbonDioxideGenerationRate)
void	resetCarbonDioxideGenerationRate ()
bool	setEnableASHRAE55ComfortWarnings (bool enableASHRAE55ComfortWarnings)
void	resetEnableASHRAE55ComfortWarnings ()
bool	setMeanRadiantTemperatureCalculationType (const std::string &meanRadiantTemperatureCalculationType)
void	resetMeanRadiantTemperatureCalculationType ()
bool	pushThermalComfortModelType (const std::string &thermalComfortModelType)
bool	setThermalComfortModelType (int i, const std::string &thermalComfortModelType)
bool	eraseThermalComfortModelType (int i)
double	getNumberOfPeople (double floorArea) const
double	getPeoplePerFloorArea (double floorArea) const
double	getFloorAreaPerPerson (double floorArea) const
bool	setNumberOfPeopleCalculationMethod (const std::string &method, double floorArea)

Static Public Member Functions
static IddObjectType	iddObjectType ()
static std::vector< std::string >	meanRadiantTemperatureCalculationTypeValues ()
static std::vector< std::string >	numberofPeopleCalculationMethodValues ()
static std::vector< std::string >	thermalComfortModelTypeValues ()

Related Functions
using	OptionalPeopleDefinition = boost::optional< PeopleDefinition >
using	PeopleDefinitionVector = std::vector< PeopleDefinition >

Detailed Description

PeopleDefinition is a SpaceLoadDefinition that wraps the OpenStudio IDD object 'OS_People_Definition'.

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

See Also

People

Constructor & Destructor Documentation

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

explicit

virtual openstudio::model::PeopleDefinition::~PeopleDefinition ( )

virtualdefault

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

default

openstudio::model::PeopleDefinition::PeopleDefinition ( PeopleDefinition &&  other )

default

Member Function Documentation

void openstudio::model::PeopleDefinition::autocalculateSensibleHeatFraction

(

)

double openstudio::model::PeopleDefinition::carbonDioxideGenerationRate

(

)

const

bool openstudio::model::PeopleDefinition::enableASHRAE55ComfortWarnings

(

)

const

bool openstudio::model::PeopleDefinition::eraseThermalComfortModelType

(

int

i

)

double openstudio::model::PeopleDefinition::fractionRadiant

(

)

const

double openstudio::model::PeopleDefinition::getFloorAreaPerPerson

(

double

floorArea

)

const

Returns the m^2/person represented by this definition, assuming floorArea (m^2).

double openstudio::model::PeopleDefinition::getNumberOfPeople

(

double

floorArea

)

const

Returns the number of people represented by this definition, assuming floorArea (m^2).

double openstudio::model::PeopleDefinition::getPeoplePerFloorArea

(

double

floorArea

)

const

Returns the people/m^2 represented by this definition, assuming floorArea (m^2).

boost::optional<std::string> openstudio::model::PeopleDefinition::getThermalComfortModelType

(

int

i

)

const

Return the thermal comfort model type in extensible group i.

Indexing starts at 0, and i should be less than numThermalComfortModelTypes.

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

static

bool openstudio::model::PeopleDefinition::isCarbonDioxideGenerationRateDefaulted

(

)

const

bool openstudio::model::PeopleDefinition::isEnableASHRAE55ComfortWarningsDefaulted

(

)

const

bool openstudio::model::PeopleDefinition::isMeanRadiantTemperatureCalculationTypeDefaulted

(

)

const

bool openstudio::model::PeopleDefinition::isSensibleHeatFractionAutocalculated

(

)

const

bool openstudio::model::PeopleDefinition::isSensibleHeatFractionDefaulted

(

)

const

std::string openstudio::model::PeopleDefinition::meanRadiantTemperatureCalculationType

(

)

const

static std::vector<std::string> openstudio::model::PeopleDefinition::meanRadiantTemperatureCalculationTypeValues ( )

static

boost::optional<double> openstudio::model::PeopleDefinition::numberofPeople

(

)

const

std::string openstudio::model::PeopleDefinition::numberofPeopleCalculationMethod

(

)

const

static std::vector<std::string> openstudio::model::PeopleDefinition::numberofPeopleCalculationMethodValues ( )

static

int openstudio::model::PeopleDefinition::numThermalComfortModelTypes

(

)

const

Returns the number of thermal comfort model types registered in this object.

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

default

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

default

boost::optional<double> openstudio::model::PeopleDefinition::peopleperSpaceFloorArea

(

)

const

bool openstudio::model::PeopleDefinition::pushThermalComfortModelType

(

const std::string &

thermalComfortModelType

)

void openstudio::model::PeopleDefinition::resetCarbonDioxideGenerationRate

(

)

void openstudio::model::PeopleDefinition::resetEnableASHRAE55ComfortWarnings

(

)

void openstudio::model::PeopleDefinition::resetMeanRadiantTemperatureCalculationType

(

)

void openstudio::model::PeopleDefinition::resetSensibleHeatFraction

(

)

boost::optional<double> openstudio::model::PeopleDefinition::sensibleHeatFraction

(

)

const

bool openstudio::model::PeopleDefinition::setCarbonDioxideGenerationRate

(

double

carbonDioxideGenerationRate

)

bool openstudio::model::PeopleDefinition::setEnableASHRAE55ComfortWarnings

(

bool

enableASHRAE55ComfortWarnings

)

bool openstudio::model::PeopleDefinition::setFractionRadiant

(

double

fractionRadiant

)

bool openstudio::model::PeopleDefinition::setMeanRadiantTemperatureCalculationType

(

const std::string &

meanRadiantTemperatureCalculationType

)

bool openstudio::model::PeopleDefinition::setNumberofPeople

(

double

numberofPeople

)

Also sets numberofPeopleCalculationMethod accordingly.

bool openstudio::model::PeopleDefinition::setNumberOfPeopleCalculationMethod	(	const std::string &	method,
		double	floorArea
	)

If method is a valid number of people calculation method , changes this definition to an equivalent number of people, under the assumption of floorArea (m^2).

bool openstudio::model::PeopleDefinition::setPeopleperSpaceFloorArea

(

double

peopleperSpaceFloorArea

)

Also sets numberofPeopleCalculationMethod accordingly.

bool openstudio::model::PeopleDefinition::setSensibleHeatFraction

(

double

sensibleHeatFraction

)

bool openstudio::model::PeopleDefinition::setSpaceFloorAreaperPerson

(

double

spaceFloorAreaperPerson

)

Also sets numberofPeopleCalculationMethod accordingly.

bool openstudio::model::PeopleDefinition::setThermalComfortModelType	(	int	i,
		const std::string &	thermalComfortModelType
	)

boost::optional<double> openstudio::model::PeopleDefinition::spaceFloorAreaperPerson

(

)

const

static std::vector<std::string> openstudio::model::PeopleDefinition::thermalComfortModelTypeValues ( )

static

Friends And Related Function Documentation

using OptionalPeopleDefinition = boost::optional<PeopleDefinition>

related

using PeopleDefinitionVector = std::vector<PeopleDefinition>

related