 |
OpenStudio:model |
#include <BuildingStory.hpp>
Inheritance diagram for openstudio::model::BuildingStory:Public Member Functions | |
| boost::optional < DefaultConstructionSet > | defaultConstructionSet () const |
| Returns the default construction set that this space references directly. 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 object The building's default schedule set The building's space type's default schedule set. More... | |
| boost::optional< RenderingColor > | renderingColor () const |
| Returns the rendering color. More... | |
| void | resetDefaultConstructionSet () |
| Resets the default construction set for this space. More... | |
| void | resetDefaultScheduleSet () |
| Resets the default schedule set for this space. More... | |
| void | resetRenderingColor () |
| Resets the rendering color. More... | |
| bool | setDefaultConstructionSet (const DefaultConstructionSet &defaultConstructionSet) |
| Sets the default construction set for this space directly. More... | |
| bool | setDefaultScheduleSet (const DefaultScheduleSet &defaultScheduleSet) |
| Sets the default schedule set for this space directly. More... | |
| bool | setRenderingColor (const RenderingColor &renderingColor) |
| Sets the rendering color. More... | |
| std::vector< Space > | spaces () const |
| Gets all spaces on this building story. More... | |
Constructors and Destructors | |
| BuildingStory (const Model &model) | |
| virtual | ~BuildingStory () |
Getters | |
| boost::optional< double > | nominalZCoordinate () const |
| boost::optional< double > | nominalFloortoFloorHeight () const |
| boost::optional< double > | nominalFloortoCeilingHeight () const |
| openstudio::BoundingBox | boundingBoxBuildingCoordinates () const |
| Get the BoundingBox in building coordinates. More... | |
| openstudio::BoundingBox | boundingBoxSiteCoordinates () const |
| Get the BoundingBox in site coordinates. More... | |
Setters | |
| bool | setNominalZCoordinate (double nominalZCoordinate) |
| void | resetNominalZCoordinate () |
| bool | setNominalFloortoFloorHeight (double nominalFloortoFloorHeight) |
| void | resetNominalFloortoFloorHeight () |
| bool | setNominalFloortoCeilingHeight (double nominalFloortoCeilingHeight) |
| void | resetNominalFloortoCeilingHeight () |
| 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< 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 (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< ModelObject > | connectedObject (unsigned port) const |
| boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Static Public Member Functions | |
| static IddObjectType | iddObjectType () |
Related Functions | |
(Note that these are not member functions.) | |
| typedef std::vector < BuildingStory > | BuildingStoryVector |
| typedef boost::optional < BuildingStory > | OptionalBuildingStory |
| 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... | |
Additional Inherited Members | |
| Protected Types inherited from openstudio::model::ModelObject | |
| typedef detail::ModelObject_Impl | ImplType |
| 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) | |
BuildingStory is a ModelObject that wraps the OpenStudio IDD object 'OS_BuildingStory'.
|
explicit |
|
inlinevirtual |
| openstudio::BoundingBox openstudio::model::BuildingStory::boundingBoxBuildingCoordinates | ( | ) | const |
Get the BoundingBox in building coordinates.
| openstudio::BoundingBox openstudio::model::BuildingStory::boundingBoxSiteCoordinates | ( | ) | const |
Get the BoundingBox in site coordinates.
| boost::optional<DefaultConstructionSet> openstudio::model::BuildingStory::defaultConstructionSet | ( | ) | const |
Returns the default construction set that this space references directly.
| boost::optional<DefaultScheduleSet> openstudio::model::BuildingStory::defaultScheduleSet | ( | ) | const |
Returns the default schedule set that this space references directly.
| boost::optional<Schedule> openstudio::model::BuildingStory::getDefaultSchedule | ( | const DefaultScheduleType & | defaultScheduleType | ) | const |
Returns the default schedule set for the specified type if available by searching (in order): This object The building's default schedule set The building's space type's default schedule set.
|
static |
| boost::optional<double> openstudio::model::BuildingStory::nominalFloortoCeilingHeight | ( | ) | const |
| boost::optional<double> openstudio::model::BuildingStory::nominalFloortoFloorHeight | ( | ) | const |
| boost::optional<double> openstudio::model::BuildingStory::nominalZCoordinate | ( | ) | const |
| boost::optional<RenderingColor> openstudio::model::BuildingStory::renderingColor | ( | ) | const |
Returns the rendering color.
| void openstudio::model::BuildingStory::resetDefaultConstructionSet | ( | ) |
Resets the default construction set for this space.
| void openstudio::model::BuildingStory::resetDefaultScheduleSet | ( | ) |
Resets the default schedule set for this space.
| void openstudio::model::BuildingStory::resetNominalFloortoCeilingHeight | ( | ) |
| void openstudio::model::BuildingStory::resetNominalFloortoFloorHeight | ( | ) |
| void openstudio::model::BuildingStory::resetNominalZCoordinate | ( | ) |
| void openstudio::model::BuildingStory::resetRenderingColor | ( | ) |
Resets the rendering color.
| bool openstudio::model::BuildingStory::setDefaultConstructionSet | ( | const DefaultConstructionSet & | defaultConstructionSet | ) |
Sets the default construction set for this space directly.
| bool openstudio::model::BuildingStory::setDefaultScheduleSet | ( | const DefaultScheduleSet & | defaultScheduleSet | ) |
Sets the default schedule set for this space directly.
| bool openstudio::model::BuildingStory::setNominalFloortoCeilingHeight | ( | double | nominalFloortoCeilingHeight | ) |
| bool openstudio::model::BuildingStory::setNominalFloortoFloorHeight | ( | double | nominalFloortoFloorHeight | ) |
| bool openstudio::model::BuildingStory::setNominalZCoordinate | ( | double | nominalZCoordinate | ) |
| bool openstudio::model::BuildingStory::setRenderingColor | ( | const RenderingColor & | renderingColor | ) |
Sets the rendering color.
| std::vector<Space> openstudio::model::BuildingStory::spaces | ( | ) | const |
Gets all spaces on this building story.
|
related |
|
related |