#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

bool	isPartofTotalFloorAreaDefaulted () const

Setters
void	setPartofTotalFloorArea (bool partofTotalFloorArea)

void	resetPartofTotalFloorArea ()

Other
boost::optional< SpaceType >	spaceType () 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< ConstructionBase >	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. 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< Schedule >	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. 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< ThermalZone >	thermalZone () const

bool	setThermalZone (ThermalZone &thermalZone)

void	resetThermalZone ()

boost::optional< BuildingStory >	buildingStory () const

bool	setBuildingStory (const BuildingStory &buildingStory)

void	resetBuildingStory ()

std::vector< ShadingSurfaceGroup >	shadingSurfaceGroups () const
	Returns all ShadingSurfaceGroups in this space. More...

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

std::vector< Surface >	surfaces () const
	Returns all Surfaces in this space. More...

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

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

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

std::vector< Luminaire >	luminaires () const
	Returns all Luminaires in this space. More...

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

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

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

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

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

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

std::vector< DaylightingControl >	daylightingControls () const
	Returns all DaylightingControls in this space. More...

std::vector< IlluminanceMap >	illuminanceMaps () const
	Returns all IlluminanceMaps in this space. More...

std::vector< GlareSensor >	glareSensors () 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	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...

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

void	hardApplySpaceLoadSchedules ()
	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< Surface >	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. 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::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

void	setDirectionofRelativeNorth (double directionofRelativeNorth)

void	resetDirectionofRelativeNorth ()

void	setXOrigin (double xOrigin)

void	resetXOrigin ()

void	setYOrigin (double yOrigin)

void	resetYOrigin ()

void	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< 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 boost::optional< Space >	fromFloorPrint (const std::vector< Point3d > &floorPrint, double floorHeight, Model &model)
	Create a space from a floor print and extrude distance. More...

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< Space >	OptionalSpace

typedef std::vector< Space >	SpaceVector

Related Functions inherited from openstudio::model::PlanarSurfaceGroup
typedef boost::optional < PlanarSurfaceGroup >	OptionalPlanarSurfaceGroup

typedef std::vector < PlanarSurfaceGroup >	PlanarSurfaceGroupVector

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::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)

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)

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<BuildingStory> openstudio::model::Space::buildingStory ( ) const

std::vector<DaylightingControl> openstudio::model::Space::daylightingControls ( ) const

Returns all DaylightingControls in this space.

boost::optional<DefaultConstructionSet> openstudio::model::Space::defaultConstructionSet ( ) const

Returns the default construction set that this space references directly.

boost::optional<DefaultScheduleSet> openstudio::model::Space::defaultScheduleSet ( ) const

Returns the default schedule set that this space references directly.

boost::optional<DesignSpecificationOutdoorAir> 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<ElectricEquipment> openstudio::model::Space::electricEquipment ( ) const

Returns all ElectricEquipment in this space.

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<Surface> 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<Point3d> 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<Space> 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<GasEquipment> 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<ConstructionBase> 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<std::pair<ConstructionBase, int> > openstudio::model::Space::getDefaultConstructionWithSearchDistance ( const PlanarSurface & planarSurface ) const

boost::optional<Schedule> 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<GlareSensor> 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.

void openstudio::model::Space::hardApplySpaceLoadSchedules ( )

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<HotWaterEquipment> openstudio::model::Space::hotWaterEquipment ( ) const

Returns all HotWaterEquipment in this space.

static IddObjectType openstudio::model::Space::iddObjectType ( )

static

std::vector<IlluminanceMap> 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<InteriorPartitionSurfaceGroup> openstudio::model::Space::interiorPartitionSurfaceGroups ( ) const

Returns all InteriorPartitionSurfaceGroups in this space.

std::vector<InternalMass> 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::isPartofTotalFloorAreaDefaulted ( ) const

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<Lights> openstudio::model::Space::lights ( ) const

Returns all Lights in this space.

std::vector<Luminaire> 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<OtherEquipment> openstudio::model::Space::otherEquipment ( ) const

Returns all OtherEquipment in this space.

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

std::vector<People> 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::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::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.