|
|
virtual | ~Building ()=default |
|
| Building (const Building &other)=default |
|
| Building (Building &&other)=default |
|
Building & | operator= (const Building &)=default |
|
Building & | operator= (Building &&)=default |
|
|
double | northAxis () const |
|
bool | isNorthAxisDefaulted () const |
|
boost::optional< double > | nominalFloortoFloorHeight () const |
|
boost::optional< int > | standardsNumberOfStories () const |
|
boost::optional< int > | standardsNumberOfAboveGroundStories () const |
|
boost::optional< int > | standardsNumberOfLivingUnits () const |
|
boost::optional< double > | nominalFloortoCeilingHeight () const |
|
boost::optional< std::string > | standardsTemplate () const |
| Returns the standards Template. More...
|
|
std::vector< std::string > | suggestedStandardsTemplates () const |
| Returns a list of suggestions from the openstudio-standards JSON data. More...
|
|
boost::optional< std::string > | standardsBuildingType () const |
| Returns the standards building type. More...
|
|
std::vector< std::string > | suggestedStandardsBuildingTypes () const |
| Returns a list of suggestions from the openstudio-standards JSON data. More...
|
|
bool | relocatable () const |
|
bool | isRelocatableDefaulted () const |
|
boost::optional< Schedule > | 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. More...
|
|
|
bool | setNorthAxis (double northAxis) |
|
void | resetNorthAxis () |
|
bool | setNominalFloortoFloorHeight (double nominalFloortoFloorHeight) |
|
void | resetNominalFloortoFloorHeight () |
|
bool | setStandardsNumberOfStories (int value) |
|
void | resetStandardsNumberOfStories () |
|
bool | setStandardsNumberOfAboveGroundStories (int value) |
|
void | resetStandardsNumberOfAboveGroundStories () |
|
bool | setStandardsNumberOfLivingUnits (int value) |
|
void | resetStandardsNumberOfLivingUnits () |
|
bool | setNominalFloortoCeilingHeight (double nominalFloortoCeilingHeight) |
|
void | resetNominalFloortoCeilingHeight () |
|
bool | setStandardsTemplate (const std::string &standardsTemplate) |
| Sets the standards Template. More...
|
|
void | resetStandardsTemplate () |
|
bool | setStandardsBuildingType (const std::string &standardsBuildingType) |
| Sets the standards building type. More...
|
|
void | resetStandardsBuildingType () |
|
bool | setRelocatable (bool isRelocatable) |
|
void | setRelocatableNoFail (bool isRelocatable) |
|
void | resetRelocatable () |
|
|
boost::optional< SpaceType > | spaceType () const |
| Returns the building's space type. More...
|
|
bool | setSpaceType (const SpaceType &spaceType) |
| Sets the building's space type. More...
|
|
void | resetSpaceType () |
| Resets the building's space type. More...
|
|
boost::optional
< DefaultConstructionSet > | defaultConstructionSet () const |
| Returns the default construction set that this space references directly. More...
|
|
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...
|
|
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...
|
|
std::vector< OutputMeter > | meters () const |
| Returns all OutputMeter objects at the Building level. More...
|
|
std::vector< BuildingStory > | buildingStories () const |
| Returns all BuildingStories objects in the Building. More...
|
|
boost::optional< Facility > | facility () const |
| Returns the parent Facility object if it exists. More...
|
|
std::vector< Space > | spaces () const |
| Returns all of the Spaces in the Building. More...
|
|
std::vector< ShadingSurfaceGroup > | shadingSurfaceGroups () const |
| Returns all ShadingSurfaceGroups at the Building level. More...
|
|
std::vector< ThermalZone > | thermalZones () const |
| Returns all of the ThermalZones in the Building. More...
|
|
std::vector< Surface > | exteriorWalls () const |
| Returns all Surfaces which are exterior walls. More...
|
|
std::vector< Surface > | roofs () const |
| Returns all Surfaces which are roofs. More...
|
|
double | floorArea () const |
| Returns the total floor area in square meters. More...
|
|
boost::optional< double > | conditionedFloorArea () const |
| Returns the conditioned floor area in square meters. More...
|
|
double | exteriorSurfaceArea () const |
| Returns the total exterior surface area (m^2). More...
|
|
double | exteriorWallArea () const |
| Returns the total exterior wall area (m^2). More...
|
|
double | airVolume () const |
| Returns the total air volume (m^3) in the building. More...
|
|
double | numberOfPeople () const |
| Returns the number of people in the building. More...
|
|
double | peoplePerFloorArea () const |
| Returns the number of people per floor area (people/m^2). More...
|
|
double | floorAreaPerPerson () const |
| Returns the total floor area per person in this building (m^2/person). More...
|
|
double | lightingPower () const |
| Returns the lighting power (W) in this building. More...
|
|
double | lightingPowerPerFloorArea () const |
| Returns the lighting power density (W/m^2) of this building. More...
|
|
double | lightingPowerPerPerson () const |
| Returns the lighting power per person (W/person) of this building. More...
|
|
double | electricEquipmentPower () const |
| Returns the electric equipment power (W) of this building. More...
|
|
double | electricEquipmentPowerPerFloorArea () const |
| Returns the electric equipment power density (W/m^2) of this building. More...
|
|
double | electricEquipmentPowerPerPerson () const |
| Returns the electric equipment power per person (W/person) of this building. More...
|
|
double | gasEquipmentPower () const |
| Returns the gas equipment power (W) of this building. More...
|
|
double | gasEquipmentPowerPerFloorArea () const |
| Returns the gas equipment power density (W/m^2) of this building. More...
|
|
double | gasEquipmentPowerPerPerson () const |
| Returns the gas equipment power per person (W/person) of this building. More...
|
|
double | infiltrationDesignFlowRate () const |
| Returns the infiltration design flow rate (m^3/s) of this building. More...
|
|
double | infiltrationDesignFlowPerSpaceFloorArea () const |
| Returns the infiltration design flow per space floor area (m^3/m^2*s) of this building. More...
|
|
double | infiltrationDesignFlowPerExteriorSurfaceArea () const |
| Returns the infiltration design flow per exterior surface area (m^3/m^2*s) of this building. More...
|
|
double | infiltrationDesignFlowPerExteriorWallArea () const |
| Returns the infiltration design flow per exterior wall area (m^3/m^2*s) of this building. More...
|
|
double | infiltrationDesignAirChangesPerHour () const |
| Returns the infiltration design air changes per hour (1/h) of this building. More...
|
|
Transformation | transformation () const |
| Returns the Transformation from the Building coordinate system to world coordinates. More...
|
|
std::vector< std::vector
< Point3d > > | generateSkylightPattern (double skylightToProjectedFloorRatio, double desiredWidth, double desiredHeight) const |
| Returns a suggested pattern for skylights targeting a skylight to floor ratio with desired sizes. More...
|
|
double | exteriorPerimeter () const |
|
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...
|
|
ParentObject & | operator= (const ParentObject &)=default |
|
ParentObject & | operator= (ParentObject &&)=default |
|
| ParentObject (const ParentObject &other)=default |
|
| ParentObject (ParentObject &&other)=default |
|
virtual | ~ParentObject ()=default |
|
virtual | ~ModelObject ()=default |
|
| ModelObject (const ModelObject &other)=default |
|
| ModelObject (ModelObject &&other)=default |
|
ModelObject & | operator= (const ModelObject &)=default |
|
ModelObject & | operator= (ModelObject &&)=default |
|
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< 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...
|
|
AdditionalProperties | additionalProperties () const |
| Returns this object's additional properties, constructing a new object if necessary. More...
|
|
bool | hasAdditionalProperties () const |
| Returns true if this object has additional properties. More...
|
|
std::vector< IdfObject > | removeAdditionalProperties () |
| Removes all additional properties that refer to this object. More...
|
|
boost::optional< std::string > | cadObjectId () const |
|
bool | setCADObjectId (const std::string &cadObjectId) |
|
boost::optional< std::string > | gbXMLId () const |
|
bool | setGBXMLId (const std::string &gbXMLId) |
|
boost::optional< std::string > | displayName () const |
|
bool | setDisplayName (const std::string &displayName) |
|
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< double > | getAutosizedValue (const std::string &valueName, const std::string &units) 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< ModelObject > | connectedObject (unsigned port) const |
|
boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
|
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) |
|
WorkspaceObject & | operator= (WorkspaceObject &&)=default |
|
WorkspaceObject & | operator= (const WorkspaceObject &)=default |
|
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 |
|
| WorkspaceObject (const WorkspaceObject &other)=default |
|
| WorkspaceObject (WorkspaceObject &&other)=default |
|
virtual | ~WorkspaceObject ()=default |
|
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 |
|
boost::optional< std::string > | getField (unsigned index, bool returnDefault=false) 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 |
|
Handle | handle () const |
|
IddObject | iddObject () const |
|
| IdfObject (IddObjectType type, bool fastName=false) |
|
| IdfObject (const IdfObject &other) |
|
| IdfObject (const IddObject &, bool fastName=false) |
|
| IdfObject (IdfObject &&other) noexcept |
|
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, bool checkNames=false) 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) |
|
IdfObject & | operator= (IdfObject &&other) noexcept |
|
IdfObject & | operator= (const IdfObject &other) |
|
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 (const std::vector< std::string > &values) |
|
IdfExtensibleGroup | pushExtensibleGroup () |
|
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=false) const |
|
virtual | ~IdfObject ()=default |
|