OpenStudio:model
openstudio::model::Space Class Reference

#include <Space.hpp>

Inheritance diagram for openstudio::model::Space:

## Public Member Functions

Constructors and Destructors
Space (const Model &model)
Creates a new space in the model, if a building level space type is defined then the space inherits that by default. More...

virtual ~Space ()

Getters
bool partofTotalFloorArea () const

Setters
bool setPartofTotalFloorArea (bool partofTotalFloorArea)

void resetPartofTotalFloorArea ()

Other
boost::optional< SpaceTypespaceType () const
Returns the space type for this space. More...

bool isSpaceTypeDefaulted () const
Returns true if space type for this space is inherited from the building. More...

bool setSpaceType (const SpaceType &spaceType)
Sets the space type for this space. More...

void resetSpaceType ()
Resets the space type for this space. More...

boost::optional
< DefaultConstructionSet
defaultConstructionSet () const
Returns the default construction set that this space references directly. More...

boost::optional< ConstructionBasegetDefaultConstruction (const PlanarSurface &planarSurface) const
Returns the default construction for this planar surface if available by searching (in order): This space's default construction set, search distance = 1 This space's space type's default construction set, search distance = 2 This space's building story's default construction set, search distance = 3 This space's building's default construction set, search distance = 4 This space's building's space type's default construction set, search distance = 5. More...

boost::optional< std::pair
< ConstructionBase, int > >
getDefaultConstructionWithSearchDistance (const PlanarSurface &planarSurface) const

bool setDefaultConstructionSet (const DefaultConstructionSet &defaultConstructionSet)
Sets the default construction set for this space directly. More...

void resetDefaultConstructionSet ()
Resets the default construction set for this space. More...

boost::optional
< DefaultScheduleSet
defaultScheduleSet () const
Returns the default schedule set that this space references directly. More...

boost::optional< SchedulegetDefaultSchedule (const DefaultScheduleType &defaultScheduleType) const
Returns the default schedule set for the specified type if available by searching (in order): This space's default schedule set This space's space type's default schedule set This space's building story's default schedule set The building's default schedule set The building's space type's default schedule set. More...

bool setDefaultScheduleSet (const DefaultScheduleSet &defaultScheduleSet)
Sets the default schedule set for this space directly. More...

void resetDefaultScheduleSet ()
Resets the default schedule set for this space. More...

boost::optional< ThermalZonethermalZone () const

bool setThermalZone (ThermalZone &thermalZone)

void resetThermalZone ()

boost::optional< BuildingStorybuildingStory () const

bool setBuildingStory (const BuildingStory &buildingStory)

void resetBuildingStory ()

boost::optional< BuildingUnitbuildingUnit () const

bool setBuildingUnit (const BuildingUnit &buildingUnit)

void resetBuildingUnit ()

Returns all ShadingSurfaceGroups in this space. More...

std::vector
< InteriorPartitionSurfaceGroup
interiorPartitionSurfaceGroups () const
Returns all InteriorPartitionSurfaceGroups in this space. More...

std::vector< Surfacesurfaces () const
Returns all Surfaces in this space. More...

std::vector< InternalMassinternalMass () const
Returns all InternalMass in this space. More...

std::vector< Peoplepeople () const
Returns all People in this space. More...

std::vector< Lightslights () const
Returns all Lights in this space. More...

std::vector< Luminaireluminaires () const
Returns all Luminaires in this space. More...

std::vector< ElectricEquipmentelectricEquipment () const
Returns all ElectricEquipment in this space. More...

std::vector
< ElectricEquipmentITEAirCooled
electricEquipmentITEAirCooled () const
Returns all ElectricEquipmentITEAirCooled in this space. More...

std::vector< GasEquipmentgasEquipment () const
Returns all GasEquipment in this space. More...

std::vector< HotWaterEquipmenthotWaterEquipment () const
Returns all HotWaterEquipment in this space. More...

std::vector< SteamEquipmentsteamEquipment () const
Returns all SteamEquipment in this space. More...

std::vector< OtherEquipmentotherEquipment () const
Returns all OtherEquipment in this space. More...

std::vector< WaterUseEquipmentwaterUseEquipment () const
Returns all WaterUseEquipment in this space. More...

std::vector< DaylightingControldaylightingControls () const
Returns all DaylightingControls in this space. More...

std::vector< IlluminanceMapilluminanceMaps () const
Returns all IlluminanceMaps in this space. More...

std::vector< GlareSensorglareSensors () const
Returns all GlareSensors in this space. More...

std::vector
< SpaceInfiltrationDesignFlowRate
spaceInfiltrationDesignFlowRates () const
Returns all SpaceInfiltrationDesignFlowRate objects in this space. More...

std::vector
< SpaceInfiltrationEffectiveLeakageArea
spaceInfiltrationEffectiveLeakageAreas () const
Returns all SpaceInfiltrationEffectiveLeakageArea objects in this space. More...

boost::optional
< DesignSpecificationOutdoorAir
designSpecificationOutdoorAir () const
Returns DesignSpecificationOutdoorAir for this space, if not set directly on this space then the SpaceType's DesignSpecificationOutdoorAir will be returned. More...

bool isDesignSpecificationOutdoorAirDefaulted () const
Returns true if DesignSpecificationOutdoorAir is not directly specified for this space. More...

bool setDesignSpecificationOutdoorAir (const DesignSpecificationOutdoorAir &designSpecificationOutdoorAir)
Sets DesignSpecificationOutdoorAir for this space. More...

void resetDesignSpecificationOutdoorAir ()
Resets DesignSpecificationOutdoorAir for this space. More...

int multiplier () const
Returns the multiplier for this space, comes from thermal zone, defaults to 1. More...

double floorArea () const
Returns the floor area (m^2). More...

double exteriorArea () const
Returns the exterior area (gross area of surfaces with outdoor boundary condition) (m^2). More...

double exteriorWallArea () const
Returns the exterior wall area (gross area of surfaces with outdoor boundary condition) (m^2). More...

double volume () const
Returns the volume (m^3). More...

double numberOfPeople () const
Returns the number of people in the space (people). More...

bool setNumberOfPeople (double numberOfPeople)
Sets the number of people in this space by using people()[0], if it exists, as a template for the remaining People and People definition parameters. More...

bool setNumberOfPeople (double numberOfPeople, const People &templatePeople)
Sets the number of people in this space using templatePeople as a template for the remaining People and People definition parameters. More...

double peoplePerFloorArea () const
Returns the total people per floor area in this space (people/m^2). More...

bool setPeoplePerFloorArea (double peoplePerFloorArea)
Sets the people per floor area in this space by using people()[0], if it exists, as a template for the remaining People and People definition parameters. More...

bool setPeoplePerFloorArea (double peoplePerFloorArea, const People &templatePeople)
Sets the people per floor area in this space using templatePeople as a template for the remaining People and People definition parameters. More...

double floorAreaPerPerson () const
Returns the total floor area per person in this space (m^2/person). More...

bool setFloorAreaPerPerson (double floorAreaPerPerson)
Sets the floor area per person in this space by using people()[0], if it exists, as a template for the remaining People and People definition parameters. More...

bool setFloorAreaPerPerson (double floorAreaPerPerson, const People &templatePeople)
Sets the floor area per person in this Space using templatePeople as a template for the remaining People and People definition parameters. More...

double lightingPower () const
Returns the lighting power (W) of this space. More...

bool setLightingPower (double lightingPower)
Sets the lighting power in this space by using lights()[0], if it exists, as a template for the remaining Lights and Lights Definition parameters. More...

bool setLightingPower (double lightingPower, const Lights &templateLights)
Sets the lighting power in this space using templateLights as a template for the remaining Lights and Lights Definition parameters. More...

double lightingPowerPerFloorArea () const
Returns the lighting power density (W/m^2) of this zone. More...

bool setLightingPowerPerFloorArea (double lightingPowerPerFloorArea)
Sets the lighting power per floor area in this space by using lights()[0], if it exists, as a template for the remaining Lights and Lights Definition parameters. More...

bool setLightingPowerPerFloorArea (double lightingPowerPerFloorArea, const Lights &templateLights)
Sets the lighting power per floor area in this space using templateLights as a template for the remaining Lights and Lights Definition parameters. More...

double lightingPowerPerPerson () const
Returns the lighting power per person (W/person) of this zone. More...

bool setLightingPowerPerPerson (double lightingPowerPerPerson)
Sets the lighting power per person in this space by using lights()[0], if it exists, as a template for the remaining Lights and Lights Definition parameters. More...

bool setLightingPowerPerPerson (double lightingPowerPerPerson, const Lights &templateLights)
Sets the lighting power per person in this space using templateLights as a template for the remaining Lights and Lights Definition parameters. More...

double electricEquipmentPower () const
Returns the electric equipment power (W) of this space. More...

bool setElectricEquipmentPower (double electricEquipmentPower)
Sets the electric equipment power in this space by using electricEquipment()[0], if it exists, as a template for the remaining ElectricEquipment and ElectricEquipment Definition parameters. More...

bool setElectricEquipmentPower (double electricEquipmentPower, const ElectricEquipment &templateElectricEquipment)
Sets the electric equipment power in this space using templateElectricEquipment as a template for the remaining ElectricEquipment and ElectricEquipment Definition parameters. More...

double electricEquipmentPowerPerFloorArea () const
Returns the electric equipment power density (W/m^2) of this space. More...

bool setElectricEquipmentPowerPerFloorArea (double electricEquipmentPowerPerFloorArea)
Sets the electric equipment power per floor area in this space by using electricEquipment()[0], if it exists, as a template for the remaining ElectricEquipment and ElectricEquipment Definition parameters. More...

bool setElectricEquipmentPowerPerFloorArea (double electricEquipmentPowerPerFloorArea, const ElectricEquipment &templateElectricEquipment)
Sets the electric equipment power per floor area in this space using templateElectricEquipment as a template for the remaining ElectricEquipment and ElectricEquipment Definition parameters. More...

double electricEquipmentPowerPerPerson () const
Returns the electric equipment power per person (W/person) of this space. More...

bool setElectricEquipmentPowerPerPerson (double electricEquipmentPowerPerPerson)
Sets the electric equipment power per person in this space by using electricEquipment()[0], if it exists, as a template for the remaining ElectricEquipment and ElectricEquipment Definition parameters. More...

bool setElectricEquipmentPowerPerPerson (double electricEquipmentPowerPerPerson, const ElectricEquipment &templateElectricEquipment)
Sets the electric equipment power per person in this space using templateElectricEquipment as a template for the remaining ElectricEquipment and ElectricEquipment Definition parameters. More...

double electricEquipmentITEAirCooledPower () const
Returns the IT equipment power (W) of this space. More...

double electricEquipmentITEAirCooledPowerPerFloorArea () const
Returns the IT equipment power density (W/m^2) of this space. More...

double gasEquipmentPower () const
Returns the gas equipment power (W) of this space. More...

bool setGasEquipmentPower (double gasEquipmentPower)
Sets the gas equipment power in this space by using gasEquipment()[0], if it exists, as a template for the remaining GasEquipment and GasEquipment Definition parameters. More...

bool setGasEquipmentPower (double gasEquipmentPower, const GasEquipment &templateGasEquipment)
Sets the gas equipment power in this space using templateGasEquipment as a template for the remaining GasEquipment and GasEquipment Definition parameters. More...

double gasEquipmentPowerPerFloorArea () const
Returns the gas equipment power density (W/m^2) of this space. More...

bool setGasEquipmentPowerPerFloorArea (double gasEquipmentPowerPerFloorArea)
Sets the gas equipment power per floor area in this space by using gasEquipment()[0], if it exists, as a template for the remaining GasEquipment and GasEquipment Definition parameters. More...

bool setGasEquipmentPowerPerFloorArea (double gasEquipmentPowerPerFloorArea, const GasEquipment &templateGasEquipment)
Sets the gas equipment power per floor area in this space using templateGasEquipment as a template for the remaining GasEquipment and GasEquipment Definition parameters. More...

double gasEquipmentPowerPerPerson () const
Returns the gas equipment power per person (W/person) of this space. More...

bool setGasEquipmentPowerPerPerson (double gasEquipmentPowerPerPerson)
Sets the gas equipment power per person in this space by using gasEquipment()[0], if it exists, as a template for the remaining GasEquipment and GasEquipment Definition parameters. More...

bool setGasEquipmentPowerPerPerson (double gasEquipmentPowerPerPerson, const GasEquipment &templateGasEquipment)
Sets the gas equipment power per person in this space using templateGasEquipment as a template for the remaining GasEquipment and GasEquipment Definition parameters. More...

double infiltrationDesignFlowRate () const
Returns the infiltration design flow rate (m^3/s) in the space. More...

double infiltrationDesignFlowPerSpaceFloorArea () const
Returns the infiltration design flow per space floor area (m^3/m^2*s) in the space. More...

double infiltrationDesignFlowPerExteriorSurfaceArea () const
Returns the infiltration design flow per exterior surface area (m^3/m^2*s) in the space. More...

double infiltrationDesignFlowPerExteriorWallArea () const
Returns the infiltration design flow per exterior wall area (m^3/m^2*s) in the space. More...

double infiltrationDesignAirChangesPerHour () const
Returns the infiltration design air changes per hour (1/h) in the space. More...

The following functionality is used by the EnergyPlus translator, the primary aim is to preserve information while putting the space into a state where it can easily be translated to EnergyPlus: Clone the space type if there is a space type Hard apply schedules to space type loads if there is a space type Move space loads from space type to space if there is a space type Merge space type default constructions with space default constructions if there is a space type Hard apply schedules to space loads If hard sizing loads, make each space load refer to unique definition and hard size it Remove the cloned space type if there is a space type. More...

Set all schedules for child space loads to their default value if there is one. More...

void hardApplyConstructions ()
Set all constructions for child surfaces to their default value if there is one. More...

void unmatchSurfaces ()
Unmatch any matched surfaces and sub surfaces in this space. More...

void matchSurfaces (Space &other)
Match surfaces and sub surfaces in this space with those in the other. More...

void intersectSurfaces (Space &other)
Intersect surfaces in this space with those in the other. More...

std::vector< SurfacefindSurfaces (boost::optional< double > minDegreesFromNorth, boost::optional< double > maxDegreesFromNorth, boost::optional< double > minDegreesTilt, boost::optional< double > maxDegreesTilt, double tol=1)
Find surfaces within angular range, specified in degrees and in the site coordinate system, an unset optional means no limit. More...

std::vector< Point3d > floorPrint () const
Returns the floor print of the space. More...

bool isPlenum () const
Return true if the ThermalZone is a plenum, otherwise returns false. More...

Public Member Functions inherited from openstudio::model::PlanarSurfaceGroup
openstudio::BoundingBox boundingBox () const
Get the BoundingBox in local coordinates. More...

openstudio::BoundingBox boundingBoxBuildingCoordinates () const
Get the BoundingBox in building coordinates. More...

openstudio::BoundingBox boundingBoxParentCoordinates () const
Get the BoundingBox in parent coordinates. More...

openstudio::BoundingBox boundingBoxSiteCoordinates () const
Get the BoundingBox in site coordinates. More...

openstudio::Transformation buildingTransformation () const
Returns the transformation from local coordinates to building coordinates. More...

bool changeTransformation (const openstudio::Transformation &transformation)
Changes the transformation from local coordinates to parent coordinates, this method alter geometry of children relative to the group so that it stays in the same place with the new transformation. More...

bool setTransformation (const openstudio::Transformation &transformation)
Sets the transformation from local coordinates to parent coordinates, this method can be used to move the group. More...

openstudio::Transformation siteTransformation () const
Returns the transformation from local coordinates to site coordinates. More...

openstudio::Transformation transformation () const
Returns the transformation from local coordinates to parent coordinates. More...

virtual ~PlanarSurfaceGroup ()

double directionofRelativeNorth () const

bool isDirectionofRelativeNorthDefaulted () const

double xOrigin () const

bool isXOriginDefaulted () const

double yOrigin () const

bool isYOriginDefaulted () const

double zOrigin () const

bool isZOriginDefaulted () const

bool setDirectionofRelativeNorth (double directionofRelativeNorth)

void resetDirectionofRelativeNorth ()

bool setXOrigin (double xOrigin)

void resetXOrigin ()

bool setYOrigin (double yOrigin)

void resetYOrigin ()

bool setZOrigin (double zOrigin)

void resetZOrigin ()

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...

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...

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...

Returns this object's additional properties, constructing a new object if necessary. More...

Returns true if this object has additional properties. More...

Removes all additional properties that refer to this object. 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< 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 boost::optional< SpacefromFloorPrint (const std::vector< Point3d > &floorPrint, double floorHeight, Model &model)
Create a space from a floor print and extrude distance. More...

static IddObjectType iddObjectType ()

## Related Functions

(Note that these are not member functions.)

typedef boost::optional< SpaceOptionalSpace

typedef std::vector< SpaceSpaceVector

Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType

Protected Member Functions inherited from openstudio::model::PlanarSurfaceGroup
PlanarSurfaceGroup (IddObjectType iddObjectType, const Model &model)

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

Space is a PlanarSurfaceGroup that wraps the OpenStudio IDD object 'OS_Space'.

## Constructor & Destructor Documentation

 openstudio::model::Space::Space ( const Model & model )
explicit

Creates a new space in the model, if a building level space type is defined then the space inherits that by default.

 virtual openstudio::model::Space::~Space ( )
inlinevirtual

## Member Function Documentation

 boost::optional openstudio::model::Space::buildingStory ( ) const
 boost::optional openstudio::model::Space::buildingUnit ( ) const
 std::vector openstudio::model::Space::daylightingControls ( ) const

Returns all DaylightingControls in this space.

 boost::optional openstudio::model::Space::defaultConstructionSet ( ) const

Returns the default construction set that this space references directly.

 boost::optional openstudio::model::Space::defaultScheduleSet ( ) const

Returns the default schedule set that this space references directly.

 boost::optional openstudio::model::Space::designSpecificationOutdoorAir ( ) const

Returns DesignSpecificationOutdoorAir for this space, if not set directly on this space then the SpaceType's DesignSpecificationOutdoorAir will be returned.

 std::vector openstudio::model::Space::electricEquipment ( ) const

Returns all ElectricEquipment in this space.

 std::vector openstudio::model::Space::electricEquipmentITEAirCooled ( ) const

Returns all ElectricEquipmentITEAirCooled in this space.

 double openstudio::model::Space::electricEquipmentITEAirCooledPower ( ) const

Returns the IT equipment power (W) of this space.

Does not include space multiplier in calculation. Does include equipment multiplier in calculation.

 double openstudio::model::Space::electricEquipmentITEAirCooledPowerPerFloorArea ( ) const

Returns the IT equipment power density (W/m^2) of this space.

Does not include space multiplier in calculation. Does include equipment multiplier in calculation.

 double openstudio::model::Space::electricEquipmentPower ( ) const

Returns the electric equipment power (W) of this space.

Does not include space multiplier in calculation. Does include equipment multiplier in calculation.

 double openstudio::model::Space::electricEquipmentPowerPerFloorArea ( ) const

Returns the electric equipment power density (W/m^2) of this space.

Does not include space multiplier in calculation. Does include equipment multiplier in calculation.

 double openstudio::model::Space::electricEquipmentPowerPerPerson ( ) const

Returns the electric equipment power per person (W/person) of this space.

Does not include space multiplier in calculation. Does include equipment multiplier in calculation.

 double openstudio::model::Space::exteriorArea ( ) const

Returns the exterior area (gross area of surfaces with outdoor boundary condition) (m^2).

Does not include space multiplier in calculation.

 double openstudio::model::Space::exteriorWallArea ( ) const

Returns the exterior wall area (gross area of surfaces with outdoor boundary condition) (m^2).

Does not include space multiplier in calculation.

 std::vector openstudio::model::Space::findSurfaces ( boost::optional< double > minDegreesFromNorth, boost::optional< double > maxDegreesFromNorth, boost::optional< double > minDegreesTilt, boost::optional< double > maxDegreesTilt, double tol = 1 )

Find surfaces within angular range, specified in degrees and in the site coordinate system, an unset optional means no limit.

Values for degrees from North are between 0 and 360 and for degrees tilt they are between 0 and 180. Note that maxDegreesFromNorth may be less than minDegreesFromNorth, e.g. to search between NorthWest and NorthEast set minDegreesFromNorth = 315 and maxDegreesFromNorth = 45. The value of maxDegreesTilt must be greater than or equal to minDegreesTilt. A tolerance of one degree is applied by default.

 double openstudio::model::Space::floorArea ( ) const

Returns the floor area (m^2).

Does not include area of floor surfaces which are air walls. Does not consider if space is included in building floor area. Does not include space multiplier in calculation.

 double openstudio::model::Space::floorAreaPerPerson ( ) const

Returns the total floor area per person in this space (m^2/person).

Does not include space multiplier in calculation. Does include people multiplier in calculation.

 std::vector openstudio::model::Space::floorPrint ( ) const

Returns the floor print of the space.

Will return empty vector if all floors in space are not on the same x,y plane.

 static boost::optional openstudio::model::Space::fromFloorPrint ( const std::vector< Point3d > & floorPrint, double floorHeight, Model & model )
static

Create a space from a floor print and extrude distance.

 std::vector openstudio::model::Space::gasEquipment ( ) const

Returns all GasEquipment in this space.

 double openstudio::model::Space::gasEquipmentPower ( ) const

Returns the gas equipment power (W) of this space.

Does not include space multiplier in calculation. Does include equipment multiplier in calculation.

 double openstudio::model::Space::gasEquipmentPowerPerFloorArea ( ) const

Returns the gas equipment power density (W/m^2) of this space.

Does not include space multiplier in calculation. Does include equipment multiplier in calculation.

 double openstudio::model::Space::gasEquipmentPowerPerPerson ( ) const

Returns the gas equipment power per person (W/person) of this space.

Does not include space multiplier in calculation. Does include equipment multiplier in calculation.

 boost::optional openstudio::model::Space::getDefaultConstruction ( const PlanarSurface & planarSurface ) const

Returns the default construction for this planar surface if available by searching (in order): This space's default construction set, search distance = 1 This space's space type's default construction set, search distance = 2 This space's building story's default construction set, search distance = 3 This space's building's default construction set, search distance = 4 This space's building's space type's default construction set, search distance = 5.

 boost::optional > openstudio::model::Space::getDefaultConstructionWithSearchDistance ( const PlanarSurface & planarSurface ) const
 boost::optional openstudio::model::Space::getDefaultSchedule ( const DefaultScheduleType & defaultScheduleType ) const

Returns the default schedule set for the specified type if available by searching (in order): This space's default schedule set This space's space type's default schedule set This space's building story's default schedule set The building's default schedule set The building's space type's default schedule set.

 std::vector openstudio::model::Space::glareSensors ( ) const

Returns all GlareSensors in this space.

 void openstudio::model::Space::hardApplyConstructions ( )

Set all constructions for child surfaces to their default value if there is one.

Set all schedules for child space loads to their default value if there is one.

 void openstudio::model::Space::hardApplySpaceType ( bool hardSizeLoads )

The following functionality is used by the EnergyPlus translator, the primary aim is to preserve information while putting the space into a state where it can easily be translated to EnergyPlus: Clone the space type if there is a space type Hard apply schedules to space type loads if there is a space type Move space loads from space type to space if there is a space type Merge space type default constructions with space default constructions if there is a space type Hard apply schedules to space loads If hard sizing loads, make each space load refer to unique definition and hard size it Remove the cloned space type if there is a space type.

 std::vector openstudio::model::Space::hotWaterEquipment ( ) const

Returns all HotWaterEquipment in this space.

 static IddObjectType openstudio::model::Space::iddObjectType ( )
static
 std::vector openstudio::model::Space::illuminanceMaps ( ) const

Returns all IlluminanceMaps in this space.

 double openstudio::model::Space::infiltrationDesignAirChangesPerHour ( ) const

Returns the infiltration design air changes per hour (1/h) in the space.

Ignores SpaceInfiltrationEffectiveLeakageArea objects. Does not include space multiplier in calculation.

 double openstudio::model::Space::infiltrationDesignFlowPerExteriorSurfaceArea ( ) const

Returns the infiltration design flow per exterior surface area (m^3/m^2*s) in the space.

Ignores SpaceInfiltrationEffectiveLeakageArea objects. Does not include space multiplier in calculation.

 double openstudio::model::Space::infiltrationDesignFlowPerExteriorWallArea ( ) const

Returns the infiltration design flow per exterior wall area (m^3/m^2*s) in the space.

Ignores SpaceInfiltrationEffectiveLeakageArea objects. Does not include space multiplier in calculation.

 double openstudio::model::Space::infiltrationDesignFlowPerSpaceFloorArea ( ) const

Returns the infiltration design flow per space floor area (m^3/m^2*s) in the space.

Ignores SpaceInfiltrationEffectiveLeakageArea objects. Does not include space multiplier in calculation.

 double openstudio::model::Space::infiltrationDesignFlowRate ( ) const

Returns the infiltration design flow rate (m^3/s) in the space.

Ignores SpaceInfiltrationEffectiveLeakageArea objects. Does not include space multiplier in calculation.

 std::vector openstudio::model::Space::interiorPartitionSurfaceGroups ( ) const

Returns all InteriorPartitionSurfaceGroups in this space.

 std::vector openstudio::model::Space::internalMass ( ) const

Returns all InternalMass in this space.

 void openstudio::model::Space::intersectSurfaces ( Space & other )

Intersect surfaces in this space with those in the other.

 bool openstudio::model::Space::isDesignSpecificationOutdoorAirDefaulted ( ) const

Returns true if DesignSpecificationOutdoorAir is not directly specified for this space.

 bool openstudio::model::Space::isPlenum ( ) const

Return true if the ThermalZone is a plenum, otherwise returns false.

 bool openstudio::model::Space::isSpaceTypeDefaulted ( ) const

Returns true if space type for this space is inherited from the building.

 double openstudio::model::Space::lightingPower ( ) const

Returns the lighting power (W) of this space.

Does not include space multiplier in calculation. Does include lighting multiplier in calculation.

 double openstudio::model::Space::lightingPowerPerFloorArea ( ) const

Returns the lighting power density (W/m^2) of this zone.

Does not include space multiplier in calculation. Does include lighting multiplier in calculation.

 double openstudio::model::Space::lightingPowerPerPerson ( ) const

Returns the lighting power per person (W/person) of this zone.

Does not include space multiplier in calculation. Does include lighting multiplier in calculation.

 std::vector openstudio::model::Space::lights ( ) const

Returns all Lights in this space.

 std::vector openstudio::model::Space::luminaires ( ) const

Returns all Luminaires in this space.

 void openstudio::model::Space::matchSurfaces ( Space & other )

Match surfaces and sub surfaces in this space with those in the other.

 int openstudio::model::Space::multiplier ( ) const

Returns the multiplier for this space, comes from thermal zone, defaults to 1.

 double openstudio::model::Space::numberOfPeople ( ) const

Returns the number of people in the space (people).

Does not include space multiplier in calculation. Does include people multiplier in calculation.

 std::vector openstudio::model::Space::otherEquipment ( ) const

Returns all OtherEquipment in this space.

 bool openstudio::model::Space::partofTotalFloorArea ( ) const
 std::vector openstudio::model::Space::people ( ) const

Returns all People in this space.

 double openstudio::model::Space::peoplePerFloorArea ( ) const

Returns the total people per floor area in this space (people/m^2).

Does not include space multiplier in calculation. Does include people multiplier in calculation.

 void openstudio::model::Space::resetBuildingStory ( )
 void openstudio::model::Space::resetBuildingUnit ( )
 void openstudio::model::Space::resetDefaultConstructionSet ( )

Resets the default construction set for this space.

 void openstudio::model::Space::resetDefaultScheduleSet ( )

Resets the default schedule set for this space.

 void openstudio::model::Space::resetDesignSpecificationOutdoorAir ( )

Resets DesignSpecificationOutdoorAir for this space.

 void openstudio::model::Space::resetPartofTotalFloorArea ( )
 void openstudio::model::Space::resetSpaceType ( )

Resets the space type for this space.

 void openstudio::model::Space::resetThermalZone ( )
 bool openstudio::model::Space::setBuildingStory ( const BuildingStory & buildingStory )
 bool openstudio::model::Space::setBuildingUnit ( const BuildingUnit & buildingUnit )
 bool openstudio::model::Space::setDefaultConstructionSet ( const DefaultConstructionSet & defaultConstructionSet )

Sets the default construction set for this space directly.

 bool openstudio::model::Space::setDefaultScheduleSet ( const DefaultScheduleSet & defaultScheduleSet )

Sets the default schedule set for this space directly.

 bool openstudio::model::Space::setDesignSpecificationOutdoorAir ( const DesignSpecificationOutdoorAir & designSpecificationOutdoorAir )

Sets DesignSpecificationOutdoorAir for this space.

 bool openstudio::model::Space::setElectricEquipmentPower ( double electricEquipmentPower )

Sets the electric equipment power in this space by using electricEquipment()[0], if it exists, as a template for the remaining ElectricEquipment and ElectricEquipment Definition parameters.

All other electricEquipment() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final ElectricEquipment object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setElectricEquipmentPower ( double electricEquipmentPower, const ElectricEquipment & templateElectricEquipment )

Sets the electric equipment power in this space using templateElectricEquipment as a template for the remaining ElectricEquipment and ElectricEquipment Definition parameters.

All other electricEquipment() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final ElectricEquipment object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setElectricEquipmentPowerPerFloorArea ( double electricEquipmentPowerPerFloorArea )

Sets the electric equipment power per floor area in this space by using electricEquipment()[0], if it exists, as a template for the remaining ElectricEquipment and ElectricEquipment Definition parameters.

All other electricEquipment() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final ElectricEquipment object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setElectricEquipmentPowerPerFloorArea ( double electricEquipmentPowerPerFloorArea, const ElectricEquipment & templateElectricEquipment )

Sets the electric equipment power per floor area in this space using templateElectricEquipment as a template for the remaining ElectricEquipment and ElectricEquipment Definition parameters.

All other electricEquipment() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final ElectricEquipment object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setElectricEquipmentPowerPerPerson ( double electricEquipmentPowerPerPerson )

Sets the electric equipment power per person in this space by using electricEquipment()[0], if it exists, as a template for the remaining ElectricEquipment and ElectricEquipment Definition parameters.

All other electricEquipment() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final ElectricEquipment object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setElectricEquipmentPowerPerPerson ( double electricEquipmentPowerPerPerson, const ElectricEquipment & templateElectricEquipment )

Sets the electric equipment power per person in this space using templateElectricEquipment as a template for the remaining ElectricEquipment and ElectricEquipment Definition parameters.

All other electricEquipment() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final ElectricEquipment object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setFloorAreaPerPerson ( double floorAreaPerPerson )

Sets the floor area per person in this space by using people()[0], if it exists, as a template for the remaining People and People definition parameters.

All other people() in this SpaceType will be removed, the SpaceType will be made unique and modified, if necessary, and the final People object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setFloorAreaPerPerson ( double floorAreaPerPerson, const People & templatePeople )

Sets the floor area per person in this Space using templatePeople as a template for the remaining People and People definition parameters.

All other people() in this SpaceType will be removed, the SpaceType will be made unique and modified, if necessary, and the final People object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setGasEquipmentPower ( double gasEquipmentPower )

Sets the gas equipment power in this space by using gasEquipment()[0], if it exists, as a template for the remaining GasEquipment and GasEquipment Definition parameters.

All other gasEquipment() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final GasEquipment object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setGasEquipmentPower ( double gasEquipmentPower, const GasEquipment & templateGasEquipment )

Sets the gas equipment power in this space using templateGasEquipment as a template for the remaining GasEquipment and GasEquipment Definition parameters.

All other gasEquipment() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final GasEquipment object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setGasEquipmentPowerPerFloorArea ( double gasEquipmentPowerPerFloorArea )

Sets the gas equipment power per floor area in this space by using gasEquipment()[0], if it exists, as a template for the remaining GasEquipment and GasEquipment Definition parameters.

All other gasEquipment() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final GasEquipment object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setGasEquipmentPowerPerFloorArea ( double gasEquipmentPowerPerFloorArea, const GasEquipment & templateGasEquipment )

Sets the gas equipment power per floor area in this space using templateGasEquipment as a template for the remaining GasEquipment and GasEquipment Definition parameters.

All other gasEquipment() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final GasEquipment object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setGasEquipmentPowerPerPerson ( double gasEquipmentPowerPerPerson )

Sets the gas equipment power per person in this space by using gasEquipment()[0], if it exists, as a template for the remaining GasEquipment and GasEquipment Definition parameters.

All other gasEquipment() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final GasEquipment object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setGasEquipmentPowerPerPerson ( double gasEquipmentPowerPerPerson, const GasEquipment & templateGasEquipment )

Sets the gas equipment power per person in this space using templateGasEquipment as a template for the remaining GasEquipment and GasEquipment Definition parameters.

All other gasEquipment() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final GasEquipment object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setLightingPower ( double lightingPower )

Sets the lighting power in this space by using lights()[0], if it exists, as a template for the remaining Lights and Lights Definition parameters.

All other lights() and luminaires() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final Lights object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setLightingPower ( double lightingPower, const Lights & templateLights )

Sets the lighting power in this space using templateLights as a template for the remaining Lights and Lights Definition parameters.

All other lights() and luminaires in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final Lights object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setLightingPowerPerFloorArea ( double lightingPowerPerFloorArea )

Sets the lighting power per floor area in this space by using lights()[0], if it exists, as a template for the remaining Lights and Lights Definition parameters.

All other lights() and luminaires() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final Lights object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setLightingPowerPerFloorArea ( double lightingPowerPerFloorArea, const Lights & templateLights )

Sets the lighting power per floor area in this space using templateLights as a template for the remaining Lights and Lights Definition parameters.

All other lights() and luminaires() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final Lights object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setLightingPowerPerPerson ( double lightingPowerPerPerson )

Sets the lighting power per person in this space by using lights()[0], if it exists, as a template for the remaining Lights and Lights Definition parameters.

All other lights() and luminaires() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final Lights object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setLightingPowerPerPerson ( double lightingPowerPerPerson, const Lights & templateLights )

Sets the lighting power per person in this space using templateLights as a template for the remaining Lights and Lights Definition parameters.

All other lights() and luminaires() in this space will be removed, the SpaceType will be made unique and modified, if necessary, and the final Lights object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setNumberOfPeople ( double numberOfPeople )

Sets the number of people in this space by using people()[0], if it exists, as a template for the remaining People and People definition parameters.

All other people() in this SpaceType will be removed, the SpaceType will be made unique and modified, if necessary, and the final People object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setNumberOfPeople ( double numberOfPeople, const People & templatePeople )

Sets the number of people in this space using templatePeople as a template for the remaining People and People definition parameters.

All other people() in this SpaceType will be removed, the SpaceType will be made unique and modified, if necessary, and the final People object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setPartofTotalFloorArea ( bool partofTotalFloorArea )
 bool openstudio::model::Space::setPeoplePerFloorArea ( double peoplePerFloorArea )

Sets the people per floor area in this space by using people()[0], if it exists, as a template for the remaining People and People definition parameters.

All other people() in this SpaceType will be removed, the SpaceType will be made unique and modified, if necessary, and the final People object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setPeoplePerFloorArea ( double peoplePerFloorArea, const People & templatePeople )

Sets the people per floor area in this space using templatePeople as a template for the remaining People and People definition parameters.

All other people() in this SpaceType will be removed, the SpaceType will be made unique and modified, if necessary, and the final People object will be attached directly to this Space, not to a SpaceType.

 bool openstudio::model::Space::setSpaceType ( const SpaceType & spaceType )

Sets the space type for this space.

 bool openstudio::model::Space::setThermalZone ( ThermalZone & thermalZone )

Returns all ShadingSurfaceGroups in this space.

 std::vector openstudio::model::Space::spaceInfiltrationDesignFlowRates ( ) const

Returns all SpaceInfiltrationDesignFlowRate objects in this space.

 std::vector openstudio::model::Space::spaceInfiltrationEffectiveLeakageAreas ( ) const

Returns all SpaceInfiltrationEffectiveLeakageArea objects in this space.

 boost::optional openstudio::model::Space::spaceType ( ) const

Returns the space type for this space.

 std::vector openstudio::model::Space::steamEquipment ( ) const

Returns all SteamEquipment in this space.

 std::vector openstudio::model::Space::surfaces ( ) const

Returns all Surfaces in this space.

 boost::optional openstudio::model::Space::thermalZone ( ) const
 void openstudio::model::Space::unmatchSurfaces ( )

Unmatch any matched surfaces and sub surfaces in this space.

 double openstudio::model::Space::volume ( ) const

Returns the volume (m^3).

Does not include space multiplier in calculation.

 std::vector openstudio::model::Space::waterUseEquipment ( ) const

Returns all WaterUseEquipment in this space.

## Friends And Related Function Documentation

 typedef boost::optional OptionalSpace
related
 typedef std::vector SpaceVector
related