 |
OpenStudioCore:model |
|
OpenStudioCore:model |
#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< Schedule > | numberofPeopleSchedule () 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< Schedule > | activityLevelSchedule () const |
| Returns the activity schedule. More... | |
| bool | isActivityLevelScheduleDefaulted () const |
| Returns true if this object does not specify an activity directly. More... | |
| boost::optional< Schedule > | workEfficiencySchedule () const |
| Returns the work efficiency schedule. More... | |
| boost::optional< Schedule > | clothingInsulationSchedule () const |
| Returns the clothing insulation schedule. More... | |
| boost::optional< Schedule > | airVelocitySchedule () const |
| Returns the air velocity schedule. More... | |
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 () |
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< SpaceType > | spaceType () 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< Space > | space () 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... | |
| std::vector< std::string > | relationshipNames () const |
| Return all valid relationship names. More... | |
| std::vector< Relationship > | relationships () const |
| Return all relationships for this ModelObject. More... | |
| boost::optional< Relationship > | getRelationship (const std::string &name) const |
| Get the relationship named name, if it exists. More... | |
| bool | setRelationship (const std::string &name, boost::optional< ModelObject > relatedModelObject) |
| Set this ModelObject's relationship name to point to relatedModelObject (or clear the relationship if relatedModelObject == boost::none). More... | |
| bool | setRelationship (const std::string &name, const Component &component) |
| Inserts component into this model and sets this ModelObject's relationship name to point to component.primaryObject(). More... | |
| std::vector< std::string > | attributeNames () const |
| Return all valid attribute names. More... | |
| std::vector < openstudio::Attribute > | attributes () const |
| Return all Attributes for this ModelObject. More... | |
| boost::optional < openstudio::Attribute > | getAttribute (const std::string &name) const |
| Get the attribute named name, if it exists. More... | |
| bool | isSettableAttribute (const std::string &name) const |
| Is the named attribute settable. More... | |
| bool | isOptionalAttribute (const std::string &name) const |
| Is the named attribute optional. More... | |
| bool | setAttribute (const std::string &name, bool value) |
| Set the attribute named name, if it exists. More... | |
| bool | setAttribute (const std::string &name, int value) |
| bool | setAttribute (const std::string &name, unsigned value) |
| bool | setAttribute (const std::string &name, double value) |
| bool | setAttribute (const std::string &name, const Quantity &value) |
| bool | setAttribute (const std::string &name, const std::string &value) |
| bool | setAttribute (const std::string &name, const char *value) |
| bool | resetAttribute (const std::string &name) |
| Reset the attribute named name. More... | |
| Model | model () const |
| Returns the Model that contains this object. More... | |
| boost::optional< ParentObject > | parent () const |
| Return this object's parent in the hierarchy, if it has one. More... | |
| std::vector< ResourceObject > | resources () 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< OutputVariable > | outputVariables () 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< LifeCycleCost > | lifeCycleCosts () 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... | |
| 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< ScheduleTypeKey > | getScheduleTypeKeys (const Schedule &schedule) const |
| Return the ScheduleTypeKeys indicating how schedule is used in this object. More... | |
| boost::optional< ModelObject > | connectedObject (unsigned port) const |
| boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
| Public Member Functions inherited from openstudio::WorkspaceObject | |
| bool | canBeSource () const |
| bool | canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const |
| std::vector< std::string > | canBeTarget () const |
| std::vector< unsigned > | getSourceIndices (const Handle &targetHandle) const |
| std::vector< WorkspaceObject > | getSources (IddObjectType type) const |
| boost::optional< WorkspaceObject > | getTarget (unsigned index) const |
| IdfObject | idfObject () |
| IdfObject | idfObject () const |
| bool | initialized () const |
| bool | isSource () const |
| bool | isTarget () const |
| unsigned | numSources () const |
| bool | objectListFieldsEqual (const WorkspaceObject &other) const |
| bool | objectListFieldsNonConflicting (const WorkspaceObject &other) const |
| bool | operator< (const WorkspaceObject &right) const |
| std::ostream & | operator<< (std::ostream &os, const WorkspaceObject &workspaceObject) |
| std::vector < openstudio::IdfObject > | remove () |
| bool | setPointer (unsigned index, const Handle &targetHandle) |
| std::vector< WorkspaceObject > | sources () const |
| std::vector< WorkspaceObject > | targets () const |
| Workspace | workspace () const |
| virtual | ~WorkspaceObject () |
| Public Member Functions inherited from openstudio::IdfObject | |
| std::string | briefDescription () const |
| T | cast () const |
| std::vector< T > | castVector (const std::vector< U > &objects) |
| std::vector< std::vector < std::string > > | clearExtensibleGroups () |
| IdfObject | clone (bool keepHandle=false) const |
| std::string | comment () const |
| boost::optional< std::string > | createName (bool overwrite=true) |
| std::vector< unsigned > | dataFields () const |
| bool | dataFieldsEqual (const IdfObject &other) const |
| std::vector< std::string > | eraseExtensibleGroup (unsigned groupIndex) |
| std::vector< IdfExtensibleGroup > | extensibleGroups () const |
| boost::optional< std::string > | fieldComment (unsigned index, bool returnDefault=false) const |
| boost::optional< double > | getDouble (unsigned index, bool returnDefault=false) const |
| IdfExtensibleGroup | getExtensibleGroup (unsigned groupIndex) const |
| std::vector< Handle > | getHandles (const std::vector< T > &objects) |
| boost::optional< int > | getInt (unsigned index, bool returnDefault=false) const |
| OSOptionalQuantity | getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const |
| boost::optional< std::string > | getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const |
| boost::optional< unsigned > | getUnsigned (unsigned index, bool returnDefault=false) const |
| boost::optional< QUrl > | getURL (unsigned index, bool returnDefault=false) const |
| Handle | handle () const |
| IddObject | iddObject () const |
| IdfObject (IddObjectType type, bool fastName=false) | |
| IdfObject (const IddObject &, bool fastName=false) | |
| IdfObject (const IdfObject &other) | |
| IdfExtensibleGroup | insertExtensibleGroup (unsigned groupIndex) |
| IdfExtensibleGroup | insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values) |
| bool | isDataField (unsigned index) const |
| bool | isEmpty (unsigned index) const |
| bool | isObjectListField (unsigned index) const |
| bool | isValid (StrictnessLevel level) const |
| boost::optional< unsigned > | maxExtensibleGroups () const |
| boost::optional< unsigned > | maxFields () const |
| unsigned | minExtensibleGroups () const |
| unsigned | minFields () const |
| boost::optional< std::string > | name (bool returnDefault=false) const |
| std::string | nameString (bool returnDefault=false) const |
| unsigned | numExtensibleGroups () const |
| unsigned | numFields () const |
| unsigned | numNonextensibleFields () const |
| std::vector< unsigned > | objectListFields () const |
| bool | objectListFieldsEqual (const IdfObject &other) const |
| bool | objectListFieldsNonConflicting (const IdfObject &other) const |
| bool | operator!= (const IdfObject &other) const |
| std::ostream & | operator<< (std::ostream &os, const IdfObject &IdfObject) |
| bool | operator== (const IdfObject &other) const |
| boost::optional< T > | optionalCast () const |
| std::vector< std::string > | popExtensibleGroup () |
| std::ostream & | print (std::ostream &os) const |
| std::ostream & | printField (std::ostream &os, unsigned index, bool isLastField=false) const |
| std::ostream & | printName (std::ostream &os, bool hasFields=true) const |
| IdfExtensibleGroup | pushExtensibleGroup () |
| IdfExtensibleGroup | pushExtensibleGroup (const std::vector< std::string > &values) |
| std::vector< unsigned > | requiredFields () const |
| void | setComment (const std::string &msg) |
| bool | setDouble (unsigned index, double value) |
| bool | setFieldComment (unsigned index, const std::string &cmnt) |
| bool | setInt (unsigned index, int value) |
| boost::optional< std::string > | setName (const std::string &newName) |
| bool | setQuantity (unsigned index, const Quantity &q) |
| bool | setString (unsigned index, const std::string &value) |
| bool | setUnsigned (unsigned index, unsigned value) |
| std::vector< T > | subsetCastVector (const std::vector< U > &original) |
| ValidityReport | validityReport (StrictnessLevel level, bool checkNames=true) const |
| virtual | ~IdfObject () |
Static Public Member Functions | |
| static IddObjectType | iddObjectType () |
| Static Public Member Functions inherited from openstudio::IdfObject | |
| static boost::optional< IdfObject > | load (const std::string &text) |
| static boost::optional< IdfObject > | load (const std::string &text, const IddObject &iddObject) |
| static int | printedFieldSpace () |
Related Functions | |
(Note that these are not member functions.) | |
| typedef boost::optional< People > | OptionalPeople |
| typedef std::vector< People > | PeopleVector |
| Related Functions inherited from openstudio::model::SpaceLoadInstance | |
| typedef boost::optional < SpaceLoadInstance > | OptionalSpaceLoadInstance |
| typedef std::vector < SpaceLoadInstance > | SpaceLoadInstanceVector |
| Related Functions inherited from openstudio::model::SpaceLoad | |
| typedef boost::optional < SpaceLoad > | OptionalSpaceLoad |
| typedef std::vector< SpaceLoad > | SpaceLoadVector |
| Related Functions inherited from openstudio::model::SpaceItem | |
| typedef boost::optional < SpaceItem > | OptionalSpaceItem |
| typedef std::vector< SpaceItem > | SpaceItemVector |
| Related Functions inherited from openstudio::model::ModelObject | |
| std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
| Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
| typedef std::pair< std::string, std::string > | ScheduleTypeKey |
| Typedef for ScheduleTypeRegistry key. More... | |
Additional Inherited Members | |
| Public Types inherited from openstudio::WorkspaceObject | |
| typedef boost::optional < WorkspaceObject > | OptionalWorkspaceObject |
| typedef std::vector < WorkspaceObject > | WorkspaceObjectVector |
| Public Types inherited from openstudio::IdfObject | |
| typedef std::pair< IdfObject, IdfObject > | IdfObjectPair |
| typedef std::vector< IdfObject > | IdfObjectVector |
| typedef boost::optional < IdfObject > | OptionalIdfObject |
| Protected Types inherited from openstudio::model::ModelObject | |
| typedef detail::ModelObject_Impl | ImplType |
| Protected Types inherited from openstudio::WorkspaceObject | |
| typedef detail::WorkspaceObject_Impl | ImplType |
| Protected Types inherited from openstudio::IdfObject | |
| typedef detail::IdfObject_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) | |
| Protected Member Functions inherited from openstudio::WorkspaceObject | |
| WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl) | |
| Protected Member Functions inherited from openstudio::IdfObject | |
| IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl) | |
People is a SpaceLoadInstance that wraps the OpenStudio IDD object 'OS_People'.
Its fields are derived from the EnergyPlus IDD object 'People'.
|
explicit |
|
inlinevirtual |
| 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::clothingInsulationSchedule | ( | ) | const |
Returns the clothing insulation schedule.
| 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).
|
static |
| bool openstudio::model::People::isActivityLevelScheduleDefaulted | ( | ) | const |
Returns true if this object does not specify an activity directly.
| 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::resetClothingInsulationSchedule | ( | ) |
Resets the clothing insulation Schedule.
| 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::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::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.
|
related |
|
related |