OpenStudio:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Pages

#include "People.hpp"

Inheritance diagram for openstudio::model::People:

Public Member Functions

 People (const PeopleDefinition &peopleDefinition)
virtual ~People ()=default
 People (const People &other)=default
 People (People &&other)=default
Peopleoperator= (const People &)=default
Peopleoperator= (People &&)=default
PeopleDefinition peopleDefinition () const
boost::optional< SchedulenumberofPeopleSchedule () const
bool isNumberofPeopleScheduleDefaulted () const
boost::optional< ScheduleactivityLevelSchedule () const
bool isActivityLevelScheduleDefaulted () const
boost::optional< ScheduleworkEfficiencySchedule () const
boost::optional< ScheduleclothingInsulationSchedule () const
boost::optional< ScheduleairVelocitySchedule () const
boost::optional< ScheduleankleLevelAirVelocitySchedule () const
double coldStressTemperatureThreshold () const
bool isColdStressTemperatureThresholdDefaulted () const
double heatStressTemperatureThreshold () const
bool isHeatStressTemperatureThresholdDefaulted () const
bool setPeopleDefinition (const PeopleDefinition &definition)
bool setNumberofPeopleSchedule (Schedule &schedule)
void resetNumberofPeopleSchedule ()
bool setActivityLevelSchedule (Schedule &schedule)
void resetActivityLevelSchedule ()
bool setWorkEfficiencySchedule (Schedule &schedule)
void resetWorkEfficiencySchedule ()
bool setClothingInsulationSchedule (Schedule &schedule)
void resetClothingInsulationSchedule ()
bool setAirVelocitySchedule (Schedule &schedule)
void resetAirVelocitySchedule ()
bool setMultiplier (double multiplier)
void resetMultiplier ()
bool setAnkleLevelAirVelocitySchedule (Schedule &schedule)
void resetAnkleLevelAirVelocitySchedule ()
bool setColdStressTemperatureThreshold (double coldStressTemperatureThreshold)
void resetColdStressTemperatureThreshold ()
bool setHeatStressTemperatureThreshold (double heatStressTemperatureThreshold)
void resetHeatStressTemperatureThreshold ()
boost::optional< double > numberOfPeople () const
boost::optional< double > peoplePerFloorArea () const
boost::optional< double > spaceFloorAreaPerPerson () const
double getNumberOfPeople (double floorArea) const
double getPeoplePerFloorArea (double floorArea) const
double getFloorAreaPerPerson (double floorArea) const

Static Public Member Functions

static IddObjectType iddObjectType ()

Related Functions

using OptionalPeople = boost::optional< People >
using PeopleVector = std::vector< People >

Detailed Description

People is a SpaceLoadInstance that wraps the OpenStudio IDD object 'OS_People'.

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

See also
PeopleDefinition

Constructor & Destructor Documentation

openstudio::model::People::People ( const PeopleDefinition peopleDefinition)
explicit
virtual openstudio::model::People::~People ( )
virtualdefault
openstudio::model::People::People ( const People other)
default
openstudio::model::People::People ( People &&  other)
default

Member Function Documentation

boost::optional<Schedule> openstudio::model::People::activityLevelSchedule ( ) const

Returns the activity schedule.

If this object does not specify a schedule this function will search the hierarchy.

boost::optional<Schedule> openstudio::model::People::airVelocitySchedule ( ) const

Returns the air velocity schedule.

boost::optional<Schedule> openstudio::model::People::ankleLevelAirVelocitySchedule ( ) const

Returns the ankle-level air velocity schedule.

boost::optional<Schedule> openstudio::model::People::clothingInsulationSchedule ( ) const

Returns the clothing insulation schedule.

double openstudio::model::People::coldStressTemperatureThreshold ( ) const
double openstudio::model::People::getFloorAreaPerPerson ( double  floorArea) const

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

double openstudio::model::People::getNumberOfPeople ( double  floorArea) const

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

double openstudio::model::People::getPeoplePerFloorArea ( double  floorArea) const

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

double openstudio::model::People::heatStressTemperatureThreshold ( ) const
static IddObjectType openstudio::model::People::iddObjectType ( )
static
bool openstudio::model::People::isActivityLevelScheduleDefaulted ( ) const

Returns true if this object does not specify an activity directly.

bool openstudio::model::People::isColdStressTemperatureThresholdDefaulted ( ) const
bool openstudio::model::People::isHeatStressTemperatureThresholdDefaulted ( ) const
bool openstudio::model::People::isNumberofPeopleScheduleDefaulted ( ) const

Returns true if this object does not specify a number of people schedule directly.

boost::optional<double> openstudio::model::People::numberOfPeople ( ) const

Returns the numberOfPeople if possible based on the underlying data of peopleDefinition().

boost::optional<Schedule> openstudio::model::People::numberofPeopleSchedule ( ) const

Returns the number of people schedule.

If this object does not specify a schedule this function will search the hierarchy.

People& openstudio::model::People::operator= ( const People )
default
People& openstudio::model::People::operator= ( People &&  )
default
PeopleDefinition openstudio::model::People::peopleDefinition ( ) const

Gets the PeopleDefinition object.

boost::optional<double> openstudio::model::People::peoplePerFloorArea ( ) const

Returns the peoplePerFloorArea if possible based on the underlying data of peopleDefinition().

void openstudio::model::People::resetActivityLevelSchedule ( )

Resets the activity Schedule.

void openstudio::model::People::resetAirVelocitySchedule ( )

Resets the air velocity Schedule.

void openstudio::model::People::resetAnkleLevelAirVelocitySchedule ( )
void openstudio::model::People::resetClothingInsulationSchedule ( )

Resets the clothing insulation Schedule.

void openstudio::model::People::resetColdStressTemperatureThreshold ( )
void openstudio::model::People::resetHeatStressTemperatureThreshold ( )
void openstudio::model::People::resetMultiplier ( )
void openstudio::model::People::resetNumberofPeopleSchedule ( )

Resets the number of people Schedule.

void openstudio::model::People::resetWorkEfficiencySchedule ( )

Resets the work efficiency Schedule.

bool openstudio::model::People::setActivityLevelSchedule ( Schedule schedule)

Sets the activity Schedule.

Returns false if schedule has a ScheduleTypeLimits that is incompatible with this use. Sets the ScheduleTypeLimits of schedule if there is none.

bool openstudio::model::People::setAirVelocitySchedule ( Schedule schedule)

Sets the air velocity Schedule.

Returns false if schedule has a ScheduleTypeLimits that is incompatible with this use. Sets the ScheduleTypeLimits of schedule if there is none.

bool openstudio::model::People::setAnkleLevelAirVelocitySchedule ( Schedule schedule)
bool openstudio::model::People::setClothingInsulationSchedule ( Schedule schedule)

Sets the clothing insulation Schedule.

Returns false if schedule has a ScheduleTypeLimits that is incompatible with this use. Sets the ScheduleTypeLimits of schedule if there is none.

bool openstudio::model::People::setColdStressTemperatureThreshold ( double  coldStressTemperatureThreshold)
bool openstudio::model::People::setHeatStressTemperatureThreshold ( double  heatStressTemperatureThreshold)
bool openstudio::model::People::setMultiplier ( double  multiplier)
bool openstudio::model::People::setNumberofPeopleSchedule ( Schedule schedule)

Sets the number of people Schedule.

Returns false if schedule has a ScheduleTypeLimits that is incompatible with this use. Sets the ScheduleTypeLimits of schedule if there is none.

bool openstudio::model::People::setPeopleDefinition ( const PeopleDefinition definition)

Sets the PeopleDefinition object.

bool openstudio::model::People::setWorkEfficiencySchedule ( Schedule schedule)

Sets the work efficiency Schedule.

Returns false if schedule has a ScheduleTypeLimits that is incompatible with this use. Sets the ScheduleTypeLimits of schedule if there is none.

boost::optional<double> openstudio::model::People::spaceFloorAreaPerPerson ( ) const

Returns the spaceFloorAreaPerPerson if possible based on the underlying data of peopleDefinition().

boost::optional<Schedule> openstudio::model::People::workEfficiencySchedule ( ) const

Returns the work efficiency schedule.

Friends And Related Function Documentation

using OptionalPeople = boost::optional<People>
related
using PeopleVector = std::vector<People>
related