OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Static Public Member Functions | Related Functions | List of all members
openstudio::model::People Class Reference

#include <People.hpp>

+ Inheritance diagram for openstudio::model::People:

Public Member Functions

Constructors and Destructors
 People (const PeopleDefinition &peopleDefinition)
 
virtual ~People ()
 
Getters
PeopleDefinition peopleDefinition () const
 Gets the PeopleDefinition object. More...
 
boost::optional< SchedulenumberofPeopleSchedule () const
 Returns the number of people schedule. More...
 
bool isNumberofPeopleScheduleDefaulted () const
 Returns true if this object does not specify a number of people schedule directly. More...
 
boost::optional< ScheduleactivityLevelSchedule () const
 Returns the activity schedule. More...
 
bool isActivityLevelScheduleDefaulted () const
 Returns true if this object does not specify an activity directly. More...
 
boost::optional< ScheduleworkEfficiencySchedule () const
 Returns the work efficiency schedule. More...
 
boost::optional< ScheduleclothingInsulationSchedule () const
 Returns the clothing insulation schedule. More...
 
boost::optional< ScheduleairVelocitySchedule () const
 Returns the air velocity schedule. More...
 
boost::optional< ScheduleankleLevelAirVelocitySchedule () const
 Returns the ankle-level air velocity schedule. More...
 
double coldStressTemperatureThreshold () const
 
bool isColdStressTemperatureThresholdDefaulted () const
 
double heatStressTemperatureThreshold () const
 
bool isHeatStressTemperatureThresholdDefaulted () const
 
Setters
bool setPeopleDefinition (const PeopleDefinition &definition)
 Sets the PeopleDefinition object. More...
 
bool setNumberofPeopleSchedule (Schedule &schedule)
 Sets the number of people Schedule. More...
 
void resetNumberofPeopleSchedule ()
 Resets the number of people Schedule. More...
 
bool setActivityLevelSchedule (Schedule &schedule)
 Sets the activity Schedule. More...
 
void resetActivityLevelSchedule ()
 Resets the activity Schedule. More...
 
bool setWorkEfficiencySchedule (Schedule &schedule)
 Sets the work efficiency Schedule. More...
 
void resetWorkEfficiencySchedule ()
 Resets the work efficiency Schedule. More...
 
bool setClothingInsulationSchedule (Schedule &schedule)
 Sets the clothing insulation Schedule. More...
 
void resetClothingInsulationSchedule ()
 Resets the clothing insulation Schedule. More...
 
bool setAirVelocitySchedule (Schedule &schedule)
 Sets the air velocity Schedule. More...
 
void resetAirVelocitySchedule ()
 Resets the air velocity Schedule. More...
 
bool setMultiplier (double multiplier)
 
void resetMultiplier ()
 
bool setAnkleLevelAirVelocitySchedule (Schedule &schedule)
 
void resetAnkleLevelAirVelocitySchedule ()
 
bool setColdStressTemperatureThreshold (double coldStressTemperatureThreshold)
 
void resetColdStressTemperatureThreshold ()
 
bool setHeatStressTemperatureThreshold (double heatStressTemperatureThreshold)
 
void resetHeatStressTemperatureThreshold ()
 
Other
boost::optional< double > numberOfPeople () const
 Returns the numberOfPeople if possible based on the underlying data of peopleDefinition(). More...
 
boost::optional< double > peoplePerFloorArea () const
 Returns the peoplePerFloorArea if possible based on the underlying data of peopleDefinition(). More...
 
boost::optional< double > spaceFloorAreaPerPerson () const
 Returns the spaceFloorAreaPerPerson if possible based on the underlying data of peopleDefinition(). More...
 
double getNumberOfPeople (double floorArea) const
 Returns the number of people represented by this instance, assuming floorArea (m^2). More...
 
double getPeoplePerFloorArea (double floorArea) const
 Returns the people/m^2 represented by this instance, assuming floorArea (m^2). More...
 
double getFloorAreaPerPerson (double floorArea) const
 Returns the m^2/person represented by this instance, assuming floorArea (m^2). More...
 
- Public Member Functions inherited from openstudio::model::SpaceLoadInstance
SpaceLoadDefinition definition () const
 Returns the definition of this instance. More...
 
double floorArea () const
 Returns the floor area associated with this space load instance. More...
 
bool isMultiplierDefaulted () const
 Returns true if the multiplier is defaulted. More...
 
void makeUnique ()
 Ensures that no other instances share this instances definition. More...
 
double multiplier () const
 Gets the multiplier for this space instance, defaults to 1. More...
 
int quantity () const
 Returns the number of instances this space load instance represents. More...
 
bool setDefinition (const SpaceLoadDefinition &definition)
 Sets the definition of this instance. More...
 
virtual ~SpaceLoadInstance ()
 
- Public Member Functions inherited from openstudio::model::SpaceLoad
bool hardApplySchedules ()
 Directly applies default schedules to this space load if found. More...
 
bool hardSize ()
 Converts space load levels to absolute values rather than by per area, etc. More...
 
bool isAbsolute () const
 Returns true if the load represents an absolute quantity that must be added when combining space types. More...
 
void resetSpaceType ()
 
bool setSpaceType (const SpaceType &spaceType)
 Sets the parent SpaceType. More...
 
boost::optional< SpaceTypespaceType () const
 Returns the parent SpaceType. More...
 
virtual ~SpaceLoad ()
 
- Public Member Functions inherited from openstudio::model::SpaceItem
void resetSpace ()
 
bool setSpace (const Space &space)
 Sets the parent Space. More...
 
boost::optional< Spacespace () const
 Returns the parent Space. More...
 
virtual ~SpaceItem ()
 
- 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< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () 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< OutputVariableoutputVariables () 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< LifeCycleCostlifeCycleCosts () 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...
 
boost::optional< std::string > cadObjectId () const
 
bool setCADObjectId (const std::string &cadObjectId)
 
boost::optional< std::string > gbXMLId () const
 
bool setGBXMLId (const std::string &gbXMLId)
 
boost::optional< std::string > displayName () const
 
bool setDisplayName (const std::string &displayName)
 
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< ScheduleTypeKeygetScheduleTypeKeys (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< ModelObjectconnectedObject (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.)

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

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- Protected Member Functions inherited from openstudio::model::SpaceLoadInstance
 SpaceLoadInstance (IddObjectType type, const SpaceLoadDefinition &definition)
 Constructs a new SpaceLoadInstance object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::SpaceLoad
 SpaceLoad (IddObjectType type, const Model &model)
 Constructs a new SpaceLoad object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::SpaceItem
 SpaceItem (IddObjectType type, const Model &model)
 Constructs a new SpaceItem 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

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 ( )
inlinevirtual

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.

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