 |
OpenStudio:model |
#include "Building.hpp"
Static Public Member Functions | |
| static IddObjectType | iddObjectType () |
Protected Member Functions | |
| Building (Model &model) | |
Related Functions | |
| typedef std::vector< Building > | BuildingVector |
| typedef boost::optional< Building > | OptionalBuilding |
Building derives from ParentObject and is an interface to the OpenStudio IDD object named "Building".
Building is a unique object which parents all Spaces in the model. Conceptually, the Building object represents the envelope shell and everything inside (lighting, equipment, etc). The Building is a child of the Facility object which includes the Building as well as exterior equipment, parking lot lighting, water systems for grounds, etc.
|
inlinevirtual |
|
explicitprotected |
| double openstudio::model::Building::airVolume | ( | ) | const |
Returns the total air volume (m^3) in the building.
Includes space multipliers in the calculation.
| std::vector<BuildingStory> openstudio::model::Building::buildingStories | ( | ) | const |
Returns all BuildingStories objects in the Building.
| boost::optional<double> openstudio::model::Building::conditionedFloorArea | ( | ) | const |
Returns the conditioned floor area in square meters.
Currently requires EnergyPlus simulation output to calculate. Attribute name: conditionedFloorArea
| boost::optional<DefaultConstructionSet> openstudio::model::Building::defaultConstructionSet | ( | ) | const |
Returns the default construction set that this space references directly.
| boost::optional<DefaultScheduleSet> openstudio::model::Building::defaultScheduleSet | ( | ) | const |
Returns the default schedule set that this space references directly.
| double openstudio::model::Building::electricEquipmentPower | ( | ) | const |
Returns the electric equipment power (W) of this building.
| double openstudio::model::Building::electricEquipmentPowerPerFloorArea | ( | ) | const |
Returns the electric equipment power density (W/m^2) of this building.
| double openstudio::model::Building::electricEquipmentPowerPerPerson | ( | ) | const |
Returns the electric equipment power per person (W/person) of this building.
| double openstudio::model::Building::exteriorPerimeter | ( | ) |
| double openstudio::model::Building::exteriorSurfaceArea | ( | ) | const |
Returns the total exterior surface area (m^2).
Includes space multipliers in calculation.
| double openstudio::model::Building::exteriorWallArea | ( | ) | const |
Returns the total exterior wall area (m^2).
Includes space multipliers in the calculation.
| std::vector<Surface> openstudio::model::Building::exteriorWalls | ( | ) | const |
Returns all Surfaces which are exterior walls.
| boost::optional<Facility> openstudio::model::Building::facility | ( | ) | const |
Returns the parent Facility object if it exists.
| double openstudio::model::Building::floorArea | ( | ) | const |
Returns the total floor area in square meters.
Includes only spaces marked as included in floor area. Includes space multipliers in calculation. Attribute name: floorArea
| double openstudio::model::Building::floorAreaPerPerson | ( | ) | const |
Returns the total floor area per person in this building (m^2/person).
| double openstudio::model::Building::gasEquipmentPower | ( | ) | const |
Returns the gas equipment power (W) of this building.
| double openstudio::model::Building::gasEquipmentPowerPerFloorArea | ( | ) | const |
Returns the gas equipment power density (W/m^2) of this building.
| double openstudio::model::Building::gasEquipmentPowerPerPerson | ( | ) | const |
Returns the gas equipment power per person (W/person) of this building.
| std::vector<std::vector<Point3d> > openstudio::model::Building::generateSkylightPattern | ( | double | skylightToProjectedFloorRatio, |
| double | desiredWidth, | ||
| double | desiredHeight | ||
| ) | const |
Returns a suggested pattern for skylights targeting a skylight to floor ratio with desired sizes.
Pattern will be in Building coordinates, on the z = 0 plane, with normal in positive z direction.
| boost::optional<Schedule> openstudio::model::Building::getDefaultSchedule | ( | const DefaultScheduleType & | defaultScheduleType | ) | const |
Returns the default schedule set for the specified type if available by searching (in order): The building's default schedule set The building's space type's default schedule set.
|
static |
| double openstudio::model::Building::infiltrationDesignAirChangesPerHour | ( | ) | const |
Returns the infiltration design air changes per hour (1/h) of this building.
Ignores SpaceInfiltrationEffectiveLeakageArea and SpaceInfiltrationFlowCoefficient objects.
| double openstudio::model::Building::infiltrationDesignFlowPerExteriorSurfaceArea | ( | ) | const |
Returns the infiltration design flow per exterior surface area (m^3/m^2*s) of this building.
Ignores SpaceInfiltrationEffectiveLeakageArea and SpaceInfiltrationFlowCoefficient objects.
| double openstudio::model::Building::infiltrationDesignFlowPerExteriorWallArea | ( | ) | const |
Returns the infiltration design flow per exterior wall area (m^3/m^2*s) of this building.
Ignores SpaceInfiltrationEffectiveLeakageArea and SpaceInfiltrationFlowCoefficient objects.
| double openstudio::model::Building::infiltrationDesignFlowPerSpaceFloorArea | ( | ) | const |
Returns the infiltration design flow per space floor area (m^3/m^2*s) of this building.
Ignores SpaceInfiltrationEffectiveLeakageArea and SpaceInfiltrationFlowCoefficient objects.
| double openstudio::model::Building::infiltrationDesignFlowRate | ( | ) | const |
Returns the infiltration design flow rate (m^3/s) of this building.
Ignores SpaceInfiltrationEffectiveLeakageArea and SpaceInfiltrationFlowCoefficient objects.
| bool openstudio::model::Building::isNorthAxisDefaulted | ( | ) | const |
| bool openstudio::model::Building::isRelocatableDefaulted | ( | ) | const |
| double openstudio::model::Building::lightingPower | ( | ) | const |
Returns the lighting power (W) in this building.
| double openstudio::model::Building::lightingPowerPerFloorArea | ( | ) | const |
Returns the lighting power density (W/m^2) of this building.
| double openstudio::model::Building::lightingPowerPerPerson | ( | ) | const |
Returns the lighting power per person (W/person) of this building.
| std::vector<OutputMeter> openstudio::model::Building::meters | ( | ) | const |
Returns all OutputMeter objects at the Building level.
| boost::optional<double> openstudio::model::Building::nominalFloortoCeilingHeight | ( | ) | const |
| boost::optional<double> openstudio::model::Building::nominalFloortoFloorHeight | ( | ) | const |
| double openstudio::model::Building::northAxis | ( | ) | const |
| double openstudio::model::Building::numberOfPeople | ( | ) | const |
Returns the number of people in the building.
| double openstudio::model::Building::peoplePerFloorArea | ( | ) | const |
Returns the number of people per floor area (people/m^2).
| bool openstudio::model::Building::relocatable | ( | ) | const |
| void openstudio::model::Building::resetDefaultConstructionSet | ( | ) |
Resets the default construction set for this space.
| void openstudio::model::Building::resetDefaultScheduleSet | ( | ) |
Resets the default schedule set for this space.
| void openstudio::model::Building::resetNominalFloortoCeilingHeight | ( | ) |
| void openstudio::model::Building::resetNominalFloortoFloorHeight | ( | ) |
| void openstudio::model::Building::resetNorthAxis | ( | ) |
| void openstudio::model::Building::resetRelocatable | ( | ) |
| void openstudio::model::Building::resetSpaceType | ( | ) |
Resets the building's space type.
| void openstudio::model::Building::resetStandardsBuildingType | ( | ) |
| void openstudio::model::Building::resetStandardsNumberOfAboveGroundStories | ( | ) |
| void openstudio::model::Building::resetStandardsNumberOfLivingUnits | ( | ) |
| void openstudio::model::Building::resetStandardsNumberOfStories | ( | ) |
| void openstudio::model::Building::resetStandardsTemplate | ( | ) |
| std::vector<Surface> openstudio::model::Building::roofs | ( | ) | const |
Returns all Surfaces which are roofs.
| bool openstudio::model::Building::setDefaultConstructionSet | ( | const DefaultConstructionSet & | defaultConstructionSet | ) |
Sets the default construction set for this space directly.
| bool openstudio::model::Building::setDefaultScheduleSet | ( | const DefaultScheduleSet & | defaultScheduleSet | ) |
Sets the default schedule set for this space directly.
| bool openstudio::model::Building::setNominalFloortoCeilingHeight | ( | double | nominalFloortoCeilingHeight | ) |
| bool openstudio::model::Building::setNominalFloortoFloorHeight | ( | double | nominalFloortoFloorHeight | ) |
| bool openstudio::model::Building::setNorthAxis | ( | double | northAxis | ) |
| bool openstudio::model::Building::setRelocatable | ( | bool | isRelocatable | ) |
| void openstudio::model::Building::setRelocatableNoFail | ( | bool | isRelocatable | ) |
| bool openstudio::model::Building::setSpaceType | ( | const SpaceType & | spaceType | ) |
Sets the building's space type.
| bool openstudio::model::Building::setStandardsBuildingType | ( | const std::string & | standardsBuildingType | ) |
Sets the standards building type.
This is a freeform field used to identify the building type for standards. Standards applied to this model will use this field to determine correct levels for lighting, occupancy, etc. More information can be found at https://github.com/NREL/openstudio-standards.
| bool openstudio::model::Building::setStandardsNumberOfAboveGroundStories | ( | int | value | ) |
| bool openstudio::model::Building::setStandardsNumberOfLivingUnits | ( | int | value | ) |
| bool openstudio::model::Building::setStandardsNumberOfStories | ( | int | value | ) |
| bool openstudio::model::Building::setStandardsTemplate | ( | const std::string & | standardsTemplate | ) |
Sets the standards Template.
This is a freeform field used to identify the energy standard template for standards. Standards applied to this model will use this field to determine correct levels for lighting, occupancy, etc. More information can be found at https://github.com/NREL/openstudio-standards.
| std::vector<ShadingSurfaceGroup> openstudio::model::Building::shadingSurfaceGroups | ( | ) | const |
Returns all ShadingSurfaceGroups at the Building level.
| std::vector<Space> openstudio::model::Building::spaces | ( | ) | const |
| boost::optional<SpaceType> openstudio::model::Building::spaceType | ( | ) | const |
Returns the building's space type.
| boost::optional<std::string> openstudio::model::Building::standardsBuildingType | ( | ) | const |
Returns the standards building type.
This is a freeform field used to identify the building type for standards. Standards applied to this model will use this field to determine correct levels for lighting, occupancy, etc. More information can be found at https://github.com/NREL/openstudio-standards.
| boost::optional<int> openstudio::model::Building::standardsNumberOfAboveGroundStories | ( | ) | const |
| boost::optional<int> openstudio::model::Building::standardsNumberOfLivingUnits | ( | ) | const |
| boost::optional<int> openstudio::model::Building::standardsNumberOfStories | ( | ) | const |
| boost::optional<std::string> openstudio::model::Building::standardsTemplate | ( | ) | const |
Returns the standards Template.
This is a freeform field used to identify the energy standard template for standards. Standards applied to this model will use this field to determine correct levels for lighting, occupancy, etc. More information can be found at https://github.com/NREL/openstudio-standards.
| std::vector<std::string> openstudio::model::Building::suggestedStandardsBuildingTypes | ( | ) | const |
Returns a list of suggestions from the openstudio-standards JSON data.
If standardsBuildingType is not empty, and not already present in the suggestions, it is added to the list of suggestion
| std::vector<std::string> openstudio::model::Building::suggestedStandardsTemplates | ( | ) | const |
Returns a list of suggestions from the openstudio-standards JSON data.
If standardsTemplate is not empty, and not already present in the suggestions, it is added to the list of suggestion
| std::vector<ThermalZone> openstudio::model::Building::thermalZones | ( | ) | const |
Returns all of the ThermalZones in the Building.
| Transformation openstudio::model::Building::transformation | ( | ) | const |
Returns the Transformation from the Building coordinate system to world coordinates.
|
related |
|
related |