 |
OpenStudioCore:model |
|
OpenStudioCore:model |
#include <SpaceType.hpp>
Inheritance diagram for openstudio::model::SpaceType:Public Member Functions | |
Constructors and Destructors | |
| SpaceType (const Model &model) | |
| virtual | ~SpaceType () |
Getters | |
| boost::optional < DefaultConstructionSet > | defaultConstructionSet () const |
| Returns the default construction set. More... | |
| boost::optional < DefaultScheduleSet > | defaultScheduleSet () const |
| Returns the default schedule set. More... | |
| boost::optional< RenderingColor > | renderingColor () const |
| Returns the rendering color. More... | |
| boost::optional< std::string > | standardsBuildingType () const |
| Returns the standards building type. More... | |
| std::vector< std::string > | suggestedStandardsBuildingTypes () const |
| If standardsBuildingType is empty, returns a list of suggestions. More... | |
| boost::optional< std::string > | standardsSpaceType () const |
| Returns the standards space type. More... | |
| std::vector< std::string > | suggestedStandardsSpaceTypes () const |
| If standardsSpaceType is empty, returns a list of suggestions based on standardsBuildingType. More... | |
Setters | |
| bool | setDefaultConstructionSet (const DefaultConstructionSet &defaultConstructionSet) |
| Sets the default construction set. More... | |
| void | resetDefaultConstructionSet () |
| Resets the default construction set. More... | |
| bool | setDefaultScheduleSet (const DefaultScheduleSet &defaultScheduleSet) |
| Sets the default schedule set. More... | |
| void | resetDefaultScheduleSet () |
| Resets the default schedule set. More... | |
| bool | setRenderingColor (const RenderingColor &renderingColor) |
| Sets the rendering color. More... | |
| void | resetRenderingColor () |
| Resets the rendering color. More... | |
| bool | setStandardsBuildingType (const std::string &standardsBuildingType) |
| Sets the standards building type. More... | |
| void | resetStandardsBuildingType () |
| bool | setStandardsSpaceType (const std::string &standardsSpaceType) |
| Sets the standards space type. More... | |
| void | resetStandardsSpaceType () |
Other | |
| std::vector< Space > | spaces () const |
| Get all spaces of this space type, includes spaces that inherit this space type. More... | |
| boost::optional< Schedule > | getDefaultSchedule (const DefaultScheduleType &defaultScheduleType) const |
| Returns the default schedule set for the specified type if available by searching (in order): This space types's default schedule set The building's default schedule set The building's space type's default schedule set. More... | |
| std::vector< InternalMass > | internalMass () const |
| Returns all InternalMass in this space type. More... | |
| std::vector< People > | people () const |
| Returns all People in this space type. More... | |
| std::vector< Lights > | lights () const |
| Returns all Lights in this space type. More... | |
| std::vector< Luminaire > | luminaires () const |
| Returns all Luminaires in this space type. More... | |
| std::vector< ElectricEquipment > | electricEquipment () const |
| Returns all ElectricEquipment in this space type. More... | |
| std::vector< GasEquipment > | gasEquipment () const |
| Returns all GasEquipment in this space type. More... | |
| std::vector< HotWaterEquipment > | hotWaterEquipment () const |
| Returns all HotWaterEquipment in this space type. More... | |
| std::vector< SteamEquipment > | steamEquipment () const |
| Returns all SteamEquipment in this space type. More... | |
| std::vector< OtherEquipment > | otherEquipment () const |
| Returns all OtherEquipment in this space type. More... | |
| std::vector < SpaceInfiltrationDesignFlowRate > | spaceInfiltrationDesignFlowRates () const |
| Returns all SpaceInfiltrationDesignFlowRate objects in this space type. More... | |
| std::vector < SpaceInfiltrationEffectiveLeakageArea > | spaceInfiltrationEffectiveLeakageAreas () const |
| Returns all SpaceInfiltrationEffectiveLeakageArea objects in this space type. More... | |
| boost::optional < DesignSpecificationOutdoorAir > | designSpecificationOutdoorAir () const |
| Returns DesignSpecificationOutdoorAir for this space type. More... | |
| bool | isDesignSpecificationOutdoorAirDefaulted () const |
| Returns true if DesignSpecificationOutdoorAir is not directly specified for this space type. More... | |
| bool | setDesignSpecificationOutdoorAir (const DesignSpecificationOutdoorAir &designSpecificationOutdoorAir) |
| Sets DesignSpecificationOutdoorAir for this space type. More... | |
| void | resetDesignSpecificationOutdoorAir () |
| Resets DesignSpecificationOutdoorAir for this space type. More... | |
| void | hardApplySpaceLoadSchedules () |
| Set all schedules for child space loads to their default value if there is one. More... | |
| boost::optional< double > | peoplePerFloorArea () const |
| Returns the total people per space floor area in this space type, if it can be calculated directly from the underlying people() data (without knowing floorArea). More... | |
| bool | setPeoplePerFloorArea (double peoplePerFloorArea) |
| Sets the peoplePerFloorArea, using people()[0], if it exists, as a template for the remaining People and PeopleDefinition parameters. More... | |
| bool | setPeoplePerFloorArea (double peoplePerFloorArea, const People &templatePeople) |
| Sets the peoplePerFloorArea, using templatePeople as a template for the remaining People and PeopleDefinition parameters. More... | |
| boost::optional< double > | spaceFloorAreaPerPerson () const |
| Returns the floor area per person for this space type, if it can be calculated directly from the underlying people() data (without knowing floorArea). More... | |
| bool | setSpaceFloorAreaPerPerson (double spaceFloorAreaPerPerson) |
| Sets the spaceFloorAreaPerPerson, using people()[0], if it exists, as a template for the remaining People and PeopleDefinition parameters. More... | |
| bool | setSpaceFloorAreaPerPerson (double spaceFloorAreaPerPerson, const People &templatePeople) |
| Sets the spaceFloorAreaPerPerson, using templatePeople as a template for the remaining People and PeopleDefinition parameters. More... | |
| double | getNumberOfPeople (double floorArea) const |
| double | getPeoplePerFloorArea (double floorArea) const |
| double | getFloorAreaPerPerson (double floorArea) const |
| boost::optional< double > | lightingPowerPerFloorArea () const |
| Returns the total lighting power per space floor area, if possible. More... | |
| bool | setLightingPowerPerFloorArea (double lightingPowerPerFloorArea) |
| Sets the lightingPowerPerFloorArea, using lights()[0], if it exists, as a template for the remaining Lights and LightsDefinition parameters. More... | |
| bool | setLightingPowerPerFloorArea (double lightingPowerPerFloorArea, const Lights &templateLights) |
| Sets the lightingPowerPerFloorArea, using templateLights as a template for the remaining Lights and LightsDefinition parameters. More... | |
| boost::optional< double > | lightingPowerPerPerson () const |
| Returns the total lighting power per person, if possible. More... | |
| bool | setLightingPowerPerPerson (double lightingPowerPerPerson) |
| Sets the lightingPowerPerPerson, using lights()[0], if it exists, as a template for the remaining Lights and LightsDefinition parameters. More... | |
| bool | setLightingPowerPerPerson (double lightingPowerPerPerson, const Lights &templateLights) |
| Sets the lightingPowerPerPerson, using templateLights as a template for the remaining Lights and LightsDefinition parameters. More... | |
| double | getLightingPower (double floorArea, double numPeople) const |
| Returns total lighting power for this space type, including lights and luminaires, assuming floorArea (m^2) and numPeople. More... | |
| double | getLightingPowerPerFloorArea (double floorArea, double numPeople) const |
| Returns the total lighting watts per space floor area for this space type, including lights and luminaires, assuming floorArea (m^2) and numPeople. More... | |
| double | getLightingPowerPerPerson (double floorArea, double numPeople) const |
| Returns the total lighting watts per person for this space type, including lights and luminaires, assuming floorArea (m^2) and numPeople. More... | |
| boost::optional< double > | electricEquipmentPowerPerFloorArea () const |
| Returns the total electric equipment power per space floor area, if it can be calculated directly from the underlying electricEquipment() data (without knowing floorArea and numPeople). More... | |
| bool | setElectricEquipmentPowerPerFloorArea (double electricEquipmentPowerPerFloorArea) |
| Sets the electricEquipmentPowerPerFloorArea, using electricEquipment()[0], if it exists, as a template for the remaining ElectricEquipment and ElectricEquipmentDefinition parameters. More... | |
| bool | setElectricEquipmentPowerPerFloorArea (double electricEquipmentPowerPerFloorArea, const ElectricEquipment &templateElectricEquipment) |
| Sets the electricEquipmentPowerPerFloorArea, using templateElectricEquipment as a template for the remaining ElectricEquipment and ElectricEquipmentDefinition parameters. More... | |
| boost::optional< double > | electricEquipmentPowerPerPerson () const |
| Returns the total electric equipment power per person, if it can be calculated directly from the underlying electricEquipment() data (without knowing floorArea and numPeople). More... | |
| bool | setElectricEquipmentPowerPerPerson (double electricEquipmentPowerPerPerson) |
| Sets the electricEquipmentPowerPerPerson, using electricEquipment()[0], if it exists, as a template for the remaining ElectricEquipment and ElectricEquipmentDefinition parameters. More... | |
| bool | setElectricEquipmentPowerPerPerson (double electricEquipmentPowerPerPerson, const ElectricEquipment &templateElectricEquipment) |
| Sets the electricEquipmentPowerPerPerson, using templateElectricEquipment as a template for the remaining ElectricEquipment and ElectricEquipmentDefinition parameters. More... | |
| double | getElectricEquipmentDesignLevel (double floorArea, double numPeople) const |
| double | getElectricEquipmentPowerPerFloorArea (double floorArea, double numPeople) const |
| double | getElectricEquipmentPowerPerPerson (double floorArea, double numPeople) const |
| boost::optional< double > | gasEquipmentPowerPerFloorArea () const |
| Returns the total gas equipment power per space floor area, if it can be calculated directly from the underlying gasEquipment() data (without knowing floorArea and numPeople). More... | |
| bool | setGasEquipmentPowerPerFloorArea (double gasEquipmentPowerPerFloorArea) |
| Sets the gasEquipmentPowerPerFloorArea, using gasEquipment()[0], if it exists, as a template for the remaining GasEquipment and GasEquipmentDefinition parameters. More... | |
| bool | setGasEquipmentPowerPerFloorArea (double gasEquipmentPowerPerFloorArea, const GasEquipment &templateGasEquipment) |
| Sets the gasEquipmentPowerPerFloorArea, using templateGasEquipment as a template for the remaining GasEquipment and GasEquipmentDefinition parameters. More... | |
| boost::optional< double > | gasEquipmentPowerPerPerson () const |
| Returns the total gas equipment power per person, if it can be calculated directly from the underlying gasEquipment() data (without knowing floorArea and numPeople). More... | |
| bool | setGasEquipmentPowerPerPerson (double gasEquipmentPowerPerPerson) |
| Sets the gasEquipmentPowerPerPerson, using gasEquipment()[0], if it exists, as a template for the remaining GasEquipment and GasEquipmentDefinition parameters. More... | |
| bool | setGasEquipmentPowerPerPerson (double gasEquipmentPowerPerPerson, const GasEquipment &templateGasEquipment) |
| Sets the gasEquipmentPowerPerPerson, using templateGasEquipment as a template for the remaining GasEquipment and GasEquipmentDefinition parameters. More... | |
| double | getGasEquipmentDesignLevel (double floorArea, double numPeople) const |
| double | getGasEquipmentPowerPerFloorArea (double floorArea, double numPeople) const |
| double | getGasEquipmentPowerPerPerson (double floorArea, double numPeople) const |
| double | floorArea () const |
| 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... | |
| virtual | ~ResourceObject () |
| Public Member Functions inherited from openstudio::model::ParentObject | |
| std::vector< IddObjectType > | allowableChildTypes () const |
| Returns a vector of allowable children types. More... | |
| std::vector< ModelObject > | children () const |
| Return direct child objects in the Model. More... | |
| virtual | ~ParentObject () |
| 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 < SpaceType > | OptionalSpaceType |
| typedef std::vector< SpaceType > | SpaceTypeVector |
| Related Functions inherited from openstudio::model::ResourceObject | |
| typedef boost::optional < ResourceObject > | OptionalResourceObject |
| typedef std::vector < ResourceObject > | ResourceObjectVector |
| Related Functions inherited from openstudio::model::ParentObject | |
| std::vector< ModelObject > | getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCosts=false) |
| Returns object and all other objects accessible by calling children() on encountered ParentObjects . More... | |
| std::vector< ModelObject > | getRecursiveChildrenAndResources (const ModelObject &object) |
| Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More... | |
| 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::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) | |
| 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) | |
SpaceType is a ResourceObject that wraps the OpenStudio IDD object 'OS_SpaceType'.
|
explicit |
|
inlinevirtual |
| boost::optional<DefaultConstructionSet> openstudio::model::SpaceType::defaultConstructionSet | ( | ) | const |
Returns the default construction set.
| boost::optional<DefaultScheduleSet> openstudio::model::SpaceType::defaultScheduleSet | ( | ) | const |
Returns the default schedule set.
| boost::optional<DesignSpecificationOutdoorAir> openstudio::model::SpaceType::designSpecificationOutdoorAir | ( | ) | const |
Returns DesignSpecificationOutdoorAir for this space type.
| std::vector<ElectricEquipment> openstudio::model::SpaceType::electricEquipment | ( | ) | const |
Returns all ElectricEquipment in this space type.
| boost::optional<double> openstudio::model::SpaceType::electricEquipmentPowerPerFloorArea | ( | ) | const |
Returns the total electric equipment power per space floor area, if it can be calculated directly from the underlying electricEquipment() data (without knowing floorArea and numPeople).
| boost::optional<double> openstudio::model::SpaceType::electricEquipmentPowerPerPerson | ( | ) | const |
Returns the total electric equipment power per person, if it can be calculated directly from the underlying electricEquipment() data (without knowing floorArea and numPeople).
| double openstudio::model::SpaceType::floorArea | ( | ) | const |
| std::vector<GasEquipment> openstudio::model::SpaceType::gasEquipment | ( | ) | const |
Returns all GasEquipment in this space type.
| boost::optional<double> openstudio::model::SpaceType::gasEquipmentPowerPerFloorArea | ( | ) | const |
Returns the total gas equipment power per space floor area, if it can be calculated directly from the underlying gasEquipment() data (without knowing floorArea and numPeople).
| boost::optional<double> openstudio::model::SpaceType::gasEquipmentPowerPerPerson | ( | ) | const |
Returns the total gas equipment power per person, if it can be calculated directly from the underlying gasEquipment() data (without knowing floorArea and numPeople).
| boost::optional<Schedule> openstudio::model::SpaceType::getDefaultSchedule | ( | const DefaultScheduleType & | defaultScheduleType | ) | const |
Returns the default schedule set for the specified type if available by searching (in order): This space types's default schedule set The building's default schedule set The building's space type's default schedule set.
| double openstudio::model::SpaceType::getElectricEquipmentDesignLevel | ( | double | floorArea, |
| double | numPeople | ||
| ) | const |
| double openstudio::model::SpaceType::getElectricEquipmentPowerPerFloorArea | ( | double | floorArea, |
| double | numPeople | ||
| ) | const |
| double openstudio::model::SpaceType::getElectricEquipmentPowerPerPerson | ( | double | floorArea, |
| double | numPeople | ||
| ) | const |
| double openstudio::model::SpaceType::getFloorAreaPerPerson | ( | double | floorArea | ) | const |
| double openstudio::model::SpaceType::getGasEquipmentDesignLevel | ( | double | floorArea, |
| double | numPeople | ||
| ) | const |
| double openstudio::model::SpaceType::getGasEquipmentPowerPerFloorArea | ( | double | floorArea, |
| double | numPeople | ||
| ) | const |
| double openstudio::model::SpaceType::getGasEquipmentPowerPerPerson | ( | double | floorArea, |
| double | numPeople | ||
| ) | const |
| double openstudio::model::SpaceType::getLightingPower | ( | double | floorArea, |
| double | numPeople | ||
| ) | const |
Returns total lighting power for this space type, including lights and luminaires, assuming floorArea (m^2) and numPeople.
| double openstudio::model::SpaceType::getLightingPowerPerFloorArea | ( | double | floorArea, |
| double | numPeople | ||
| ) | const |
Returns the total lighting watts per space floor area for this space type, including lights and luminaires, assuming floorArea (m^2) and numPeople.
| double openstudio::model::SpaceType::getLightingPowerPerPerson | ( | double | floorArea, |
| double | numPeople | ||
| ) | const |
Returns the total lighting watts per person for this space type, including lights and luminaires, assuming floorArea (m^2) and numPeople.
| double openstudio::model::SpaceType::getNumberOfPeople | ( | double | floorArea | ) | const |
| double openstudio::model::SpaceType::getPeoplePerFloorArea | ( | double | floorArea | ) | const |
| void openstudio::model::SpaceType::hardApplySpaceLoadSchedules | ( | ) |
Set all schedules for child space loads to their default value if there is one.
| std::vector<HotWaterEquipment> openstudio::model::SpaceType::hotWaterEquipment | ( | ) | const |
Returns all HotWaterEquipment in this space type.
|
static |
| std::vector<InternalMass> openstudio::model::SpaceType::internalMass | ( | ) | const |
Returns all InternalMass in this space type.
| bool openstudio::model::SpaceType::isDesignSpecificationOutdoorAirDefaulted | ( | ) | const |
Returns true if DesignSpecificationOutdoorAir is not directly specified for this space type.
| boost::optional<double> openstudio::model::SpaceType::lightingPowerPerFloorArea | ( | ) | const |
Returns the total lighting power per space floor area, if possible.
Only works if there are no luminaires in the space type, and if all lights are defined on a per space floor area basis.
| boost::optional<double> openstudio::model::SpaceType::lightingPowerPerPerson | ( | ) | const |
Returns the total lighting power per person, if possible.
Only works if there are no luminaires in the space type, and if all lights are defined on a per person basis.
| std::vector<Lights> openstudio::model::SpaceType::lights | ( | ) | const |
Returns all Lights in this space type.
| std::vector<Luminaire> openstudio::model::SpaceType::luminaires | ( | ) | const |
Returns all Luminaires in this space type.
| std::vector<OtherEquipment> openstudio::model::SpaceType::otherEquipment | ( | ) | const |
Returns all OtherEquipment in this space type.
| std::vector<People> openstudio::model::SpaceType::people | ( | ) | const |
Returns all People in this space type.
| boost::optional<double> openstudio::model::SpaceType::peoplePerFloorArea | ( | ) | const |
Returns the total people per space floor area in this space type, if it can be calculated directly from the underlying people() data (without knowing floorArea).
| boost::optional<RenderingColor> openstudio::model::SpaceType::renderingColor | ( | ) | const |
Returns the rendering color.
| void openstudio::model::SpaceType::resetDefaultConstructionSet | ( | ) |
Resets the default construction set.
| void openstudio::model::SpaceType::resetDefaultScheduleSet | ( | ) |
Resets the default schedule set.
| void openstudio::model::SpaceType::resetDesignSpecificationOutdoorAir | ( | ) |
Resets DesignSpecificationOutdoorAir for this space type.
| void openstudio::model::SpaceType::resetRenderingColor | ( | ) |
Resets the rendering color.
| void openstudio::model::SpaceType::resetStandardsBuildingType | ( | ) |
| void openstudio::model::SpaceType::resetStandardsSpaceType | ( | ) |
| bool openstudio::model::SpaceType::setDefaultConstructionSet | ( | const DefaultConstructionSet & | defaultConstructionSet | ) |
Sets the default construction set.
| bool openstudio::model::SpaceType::setDefaultScheduleSet | ( | const DefaultScheduleSet & | defaultScheduleSet | ) |
Sets the default schedule set.
| bool openstudio::model::SpaceType::setDesignSpecificationOutdoorAir | ( | const DesignSpecificationOutdoorAir & | designSpecificationOutdoorAir | ) |
Sets DesignSpecificationOutdoorAir for this space type.
| bool openstudio::model::SpaceType::setElectricEquipmentPowerPerFloorArea | ( | double | electricEquipmentPowerPerFloorArea | ) |
Sets the electricEquipmentPowerPerFloorArea, using electricEquipment()[0], if it exists, as a template for the remaining ElectricEquipment and ElectricEquipmentDefinition parameters.
All other electricEquipment() in this SpaceType will be removed.
| bool openstudio::model::SpaceType::setElectricEquipmentPowerPerFloorArea | ( | double | electricEquipmentPowerPerFloorArea, |
| const ElectricEquipment & | templateElectricEquipment | ||
| ) |
Sets the electricEquipmentPowerPerFloorArea, using templateElectricEquipment as a template for the remaining ElectricEquipment and ElectricEquipmentDefinition parameters.
All other electricEquipment() in this SpaceType will be removed.
| bool openstudio::model::SpaceType::setElectricEquipmentPowerPerPerson | ( | double | electricEquipmentPowerPerPerson | ) |
Sets the electricEquipmentPowerPerPerson, using electricEquipment()[0], if it exists, as a template for the remaining ElectricEquipment and ElectricEquipmentDefinition parameters.
All other electricEquipment() in this SpaceType will be removed.
| bool openstudio::model::SpaceType::setElectricEquipmentPowerPerPerson | ( | double | electricEquipmentPowerPerPerson, |
| const ElectricEquipment & | templateElectricEquipment | ||
| ) |
Sets the electricEquipmentPowerPerPerson, using templateElectricEquipment as a template for the remaining ElectricEquipment and ElectricEquipmentDefinition parameters.
All other electricEquipment() in this SpaceType will be removed.
| bool openstudio::model::SpaceType::setGasEquipmentPowerPerFloorArea | ( | double | gasEquipmentPowerPerFloorArea | ) |
Sets the gasEquipmentPowerPerFloorArea, using gasEquipment()[0], if it exists, as a template for the remaining GasEquipment and GasEquipmentDefinition parameters.
All other gasEquipment() in this SpaceType will be removed.
| bool openstudio::model::SpaceType::setGasEquipmentPowerPerFloorArea | ( | double | gasEquipmentPowerPerFloorArea, |
| const GasEquipment & | templateGasEquipment | ||
| ) |
Sets the gasEquipmentPowerPerFloorArea, using templateGasEquipment as a template for the remaining GasEquipment and GasEquipmentDefinition parameters.
All other gasEquipment() in this SpaceType will be removed.
| bool openstudio::model::SpaceType::setGasEquipmentPowerPerPerson | ( | double | gasEquipmentPowerPerPerson | ) |
Sets the gasEquipmentPowerPerPerson, using gasEquipment()[0], if it exists, as a template for the remaining GasEquipment and GasEquipmentDefinition parameters.
All other gasEquipment() in this SpaceType will be removed.
| bool openstudio::model::SpaceType::setGasEquipmentPowerPerPerson | ( | double | gasEquipmentPowerPerPerson, |
| const GasEquipment & | templateGasEquipment | ||
| ) |
Sets the gasEquipmentPowerPerPerson, using templateGasEquipment as a template for the remaining GasEquipment and GasEquipmentDefinition parameters.
All other gasEquipment() in this SpaceType will be removed.
| bool openstudio::model::SpaceType::setLightingPowerPerFloorArea | ( | double | lightingPowerPerFloorArea | ) |
Sets the lightingPowerPerFloorArea, using lights()[0], if it exists, as a template for the remaining Lights and LightsDefinition parameters.
All other lights() and luminaires() in this SpaceType will be removed.
| bool openstudio::model::SpaceType::setLightingPowerPerFloorArea | ( | double | lightingPowerPerFloorArea, |
| const Lights & | templateLights | ||
| ) |
Sets the lightingPowerPerFloorArea, using templateLights as a template for the remaining Lights and LightsDefinition parameters.
All lights() and luminaires() in this SpaceType (except for templateLights, if applicable), will be removed.
| bool openstudio::model::SpaceType::setLightingPowerPerPerson | ( | double | lightingPowerPerPerson | ) |
Sets the lightingPowerPerPerson, using lights()[0], if it exists, as a template for the remaining Lights and LightsDefinition parameters.
All other lights() and luminaires() in this SpaceType will be removed.
| bool openstudio::model::SpaceType::setLightingPowerPerPerson | ( | double | lightingPowerPerPerson, |
| const Lights & | templateLights | ||
| ) |
Sets the lightingPowerPerPerson, using templateLights as a template for the remaining Lights and LightsDefinition parameters.
All lights() and luminaires() in this SpaceType (except for templateLights, if applicable), will be removed.
| bool openstudio::model::SpaceType::setPeoplePerFloorArea | ( | double | peoplePerFloorArea | ) |
Sets the peoplePerFloorArea, using people()[0], if it exists, as a template for the remaining People and PeopleDefinition parameters.
| bool openstudio::model::SpaceType::setPeoplePerFloorArea | ( | double | peoplePerFloorArea, |
| const People & | templatePeople | ||
| ) |
Sets the peoplePerFloorArea, using templatePeople as a template for the remaining People and PeopleDefinition parameters.
All people() in this SpaceType (except for templatePeople, if applicable), will be removed.
| bool openstudio::model::SpaceType::setRenderingColor | ( | const RenderingColor & | renderingColor | ) |
Sets the rendering color.
| bool openstudio::model::SpaceType::setSpaceFloorAreaPerPerson | ( | double | spaceFloorAreaPerPerson | ) |
Sets the spaceFloorAreaPerPerson, using people()[0], if it exists, as a template for the remaining People and PeopleDefinition parameters.
| bool openstudio::model::SpaceType::setSpaceFloorAreaPerPerson | ( | double | spaceFloorAreaPerPerson, |
| const People & | templatePeople | ||
| ) |
Sets the spaceFloorAreaPerPerson, using templatePeople as a template for the remaining People and PeopleDefinition parameters.
All people() in this SpaceType (except for templatePeople, if applicable), will be removed.
| bool openstudio::model::SpaceType::setStandardsBuildingType | ( | const std::string & | standardsBuildingType | ) |
Sets the standards building type.
This is a freeform field used to identify the building type for standards. Standards applied to this model will use this field to determine correct levels for lighting, occupancy, etc. More information can be found at https://github.com/NREL/openstudio-standards.
| bool openstudio::model::SpaceType::setStandardsSpaceType | ( | const std::string & | standardsSpaceType | ) |
Sets the standards space type.
This is a freeform field used to identify the space type for standards. Standards applied to this model will use this field to determine correct levels for lighting, occupancy, etc. More information can be found at https://github.com/NREL/openstudio-standards.
| boost::optional<double> openstudio::model::SpaceType::spaceFloorAreaPerPerson | ( | ) | const |
Returns the floor area per person for this space type, if it can be calculated directly from the underlying people() data (without knowing floorArea).
| std::vector<SpaceInfiltrationDesignFlowRate> openstudio::model::SpaceType::spaceInfiltrationDesignFlowRates | ( | ) | const |
Returns all SpaceInfiltrationDesignFlowRate objects in this space type.
| std::vector<SpaceInfiltrationEffectiveLeakageArea> openstudio::model::SpaceType::spaceInfiltrationEffectiveLeakageAreas | ( | ) | const |
Returns all SpaceInfiltrationEffectiveLeakageArea objects in this space type.
| std::vector<Space> openstudio::model::SpaceType::spaces | ( | ) | const |
Get all spaces of this space type, includes spaces that inherit this space type.
| boost::optional<std::string> openstudio::model::SpaceType::standardsBuildingType | ( | ) | const |
Returns the standards building type.
This is a freeform field used to identify the building type for standards. Standards applied to this model will use this field to determine correct levels for lighting, occupancy, etc. More information can be found at https://github.com/NREL/openstudio-standards.
| boost::optional<std::string> openstudio::model::SpaceType::standardsSpaceType | ( | ) | const |
Returns the standards space type.
This is a freeform field used to identify the space type for standards. Standards applied to this model will use this field to determine correct levels for lighting, occupancy, etc. More information can be found at https://github.com/NREL/openstudio-standards.
| std::vector<SteamEquipment> openstudio::model::SpaceType::steamEquipment | ( | ) | const |
Returns all SteamEquipment in this space type.
| std::vector<std::string> openstudio::model::SpaceType::suggestedStandardsBuildingTypes | ( | ) | const |
If standardsBuildingType is empty, returns a list of suggestions.
If standardsBuildingType is not empty, returns standardsBuildingType.
| std::vector<std::string> openstudio::model::SpaceType::suggestedStandardsSpaceTypes | ( | ) | const |
If standardsSpaceType is empty, returns a list of suggestions based on standardsBuildingType.
If standardsSpaceType is not empty, returns standardsSpaceType.
|
related |
|
related |