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

#include <PeopleDefinition.hpp>

+ Inheritance diagram for openstudio::model::PeopleDefinition:

Public Member Functions

Constructors and Destructors
 PeopleDefinition (const Model &model)
 
virtual ~PeopleDefinition ()=default
 
 PeopleDefinition (const PeopleDefinition &other)=default
 
 PeopleDefinition (PeopleDefinition &&other)=default
 
PeopleDefinitionoperator= (const PeopleDefinition &)=default
 
PeopleDefinitionoperator= (PeopleDefinition &&)=default
 
Getters
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
 Return the thermal comfort model type in extensible group i. More...
 
int numThermalComfortModelTypes () const
 Returns the number of thermal comfort model types registered in this object. More...
 
Setters
bool setNumberofPeople (double numberofPeople)
 Also sets numberofPeopleCalculationMethod accordingly. More...
 
bool setPeopleperSpaceFloorArea (double peopleperSpaceFloorArea)
 Also sets numberofPeopleCalculationMethod accordingly. More...
 
bool setSpaceFloorAreaperPerson (double spaceFloorAreaperPerson)
 Also sets numberofPeopleCalculationMethod accordingly. More...
 
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)
 
Other
double getNumberOfPeople (double floorArea) const
 Returns the number of people represented by this definition, assuming floorArea (m^2). More...
 
double getPeoplePerFloorArea (double floorArea) const
 Returns the people/m^2 represented by this definition, assuming floorArea (m^2). More...
 
double getFloorAreaPerPerson (double floorArea) const
 Returns the m^2/person represented by this definition, assuming floorArea (m^2). More...
 
bool 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). More...
 
- Public Member Functions inherited from openstudio::model::SpaceLoadDefinition
double floorArea () const
 Returns the floor area associated with instances of this space load definition. More...
 
std::vector< SpaceLoadInstanceinstances () const
 Returns all instances of this definition. More...
 
SpaceLoadDefinitionoperator= (const SpaceLoadDefinition &)=default
 
SpaceLoadDefinitionoperator= (SpaceLoadDefinition &&)=default
 
int quantity () const
 Returns the number of instances of this space load. More...
 
 SpaceLoadDefinition (const SpaceLoadDefinition &other)=default
 
 SpaceLoadDefinition (SpaceLoadDefinition &&other)=default
 
virtual ~SpaceLoadDefinition ()=default
 
- Public Member Functions inherited from openstudio::model::ResourceObject
unsigned directUseCount (bool excludeChildren=false) const
 Returns the number of objects that use this resource directly. More...
 
unsigned nonResourceObjectUseCount (bool excludeChildren=false) const
 Returns the number of non-ResourceObjects that use this resource either directly or indirectly. More...
 
ResourceObjectoperator= (const ResourceObject &)=default
 
ResourceObjectoperator= (ResourceObject &&)=default
 
 ResourceObject (const ResourceObject &other)=default
 
 ResourceObject (ResourceObject &&other)=default
 
virtual ~ResourceObject ()=default
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject ()=default
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (ModelObject &&)=default
 
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 (const std::string &valueName, const std::string &units) 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 ()
 
static std::vector< std::string > meanRadiantTemperatureCalculationTypeValues ()
 
static std::vector< std::string > numberofPeopleCalculationMethodValues ()
 
static std::vector< std::string > thermalComfortModelTypeValues ()
 

Related Functions

(Note that these are not member functions.)

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

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- Protected Member Functions inherited from openstudio::model::SpaceLoadDefinition
 SpaceLoadDefinition (IddObjectType type, const Model &model)
 Constructs a new SpaceLoadDefinition object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::ResourceObject
 ResourceObject (IddObjectType type, const Model &model)
 Constructs a new PlanarSurface object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::ParentObject
 ParentObject (IddObjectType type, const Model &model)
 Constructs a new ParentObject 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

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