 |
OpenStudio:model |
#include <InternalMass.hpp>
Inheritance diagram for openstudio::model::InternalMass:Public Member Functions | |
Constructors and Destructors | |
| InternalMass (const InternalMassDefinition &internalMassDefinition) | |
| virtual | ~InternalMass () |
Getters | |
| InternalMassDefinition | internalMassDefinition () const |
| Gets the InternalMassDefinition object. More... | |
| boost::optional < SurfacePropertyConvectionCoefficients > | surfacePropertyConvectionCoefficients () const |
| Returns the SurfacePropertyConvectionCoefficients, if it exists. More... | |
Setters | |
| bool | setInternalMassDefinition (const InternalMassDefinition &definition) |
| Sets the InternalMassDefinition object. More... | |
| bool | setMultiplier (double multiplier) |
| void | resetMultiplier () |
Other | |
| boost::optional< double > | surfaceArea () const |
| Returns the surfaceArea if possible based on the underlying data of internalMassDefinition(). More... | |
| boost::optional< double > | surfaceAreaPerFloorArea () const |
| Returns the surfaceAreaPerFloorArea if possible based on the underlying data of internalMassDefinition(). More... | |
| boost::optional< double > | surfaceAreaPerPerson () const |
| Returns the surfaceAreaPerPerson if possible based on the underlying data of internalMassDefinition(). More... | |
| double | getSurfaceArea (double floorArea, double numPeople) const |
| Returns the construction surface area represented by this instance, assuming floorArea (m^2) and numPeople. More... | |
| double | getSurfaceAreaPerFloorArea (double floorArea, double numPeople) const |
| Returns the m^2/m^2 of construction surface area per floor area represented by this instance, assuming floorArea (m^2) and numPeople. More... | |
| double | getSurfaceAreaPerPerson (double floorArea, double numPeople) const |
| Returns the m^2/person of construction surface area represented by this instance, assuming floorArea (m^2) and numPeople. More... | |
| Public Member Functions inherited from openstudio::model::SpaceLoadInstance | |
| SpaceLoadDefinition | definition () const |
| Returns the definition of this instance. More... | |
| double | floorArea () const |
| Returns the floor area associated with this space load instance. More... | |
| bool | isMultiplierDefaulted () const |
| Returns true if the multiplier is defaulted. More... | |
| void | makeUnique () |
| Ensures that no other instances share this instances definition. More... | |
| double | multiplier () const |
| Gets the multiplier for this space instance, defaults to 1. More... | |
| int | quantity () const |
| Returns the number of instances this space load instance represents. More... | |
| bool | setDefinition (const SpaceLoadDefinition &definition) |
| Sets the definition of this instance. More... | |
| virtual | ~SpaceLoadInstance () |
| Public Member Functions inherited from openstudio::model::SpaceLoad | |
| bool | hardApplySchedules () |
| Directly applies default schedules to this space load if found. More... | |
| bool | hardSize () |
| Converts space load levels to absolute values rather than by per area, etc. More... | |
| bool | isAbsolute () const |
| Returns true if the load represents an absolute quantity that must be added when combining space types. More... | |
| void | resetSpaceType () |
| bool | setSpaceType (const SpaceType &spaceType) |
| Sets the parent SpaceType. More... | |
| boost::optional< SpaceType > | spaceType () const |
| Returns the parent SpaceType. More... | |
| virtual | ~SpaceLoad () |
| Public Member Functions inherited from openstudio::model::SpaceItem | |
| void | resetSpace () |
| bool | setSpace (const Space &space) |
| Sets the parent Space. More... | |
| boost::optional< Space > | space () const |
| Returns the parent Space. More... | |
| virtual | ~SpaceItem () |
| 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... | |
| 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< InternalMass > | InternalMassVector |
| typedef boost::optional < InternalMass > | OptionalInternalMass |
| Related Functions inherited from openstudio::model::SpaceLoadInstance | |
| typedef boost::optional < SpaceLoadInstance > | OptionalSpaceLoadInstance |
| typedef std::vector < SpaceLoadInstance > | SpaceLoadInstanceVector |
| Related Functions inherited from openstudio::model::SpaceLoad | |
| typedef boost::optional < SpaceLoad > | OptionalSpaceLoad |
| typedef std::vector< SpaceLoad > | SpaceLoadVector |
| Related Functions inherited from openstudio::model::SpaceItem | |
| typedef boost::optional < SpaceItem > | OptionalSpaceItem |
| typedef std::vector< SpaceItem > | SpaceItemVector |
| 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::SpaceLoadInstance | |
| SpaceLoadInstance (IddObjectType type, const SpaceLoadDefinition &definition) | |
| Constructs a new SpaceLoadInstance object in the model. More... | |
| Protected Member Functions inherited from openstudio::model::SpaceLoad | |
| SpaceLoad (IddObjectType type, const Model &model) | |
| Constructs a new SpaceLoad object in the model. More... | |
| Protected Member Functions inherited from openstudio::model::SpaceItem | |
| SpaceItem (IddObjectType type, const Model &model) | |
| Constructs a new SpaceItem 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) | |
InternalMass is a SpaceLoadInstance that wraps the OpenStudio IDD object 'OS_InternalMass'.
Its fields are derived from the EnergyPlus IDD object 'InternalMass'.
|
explicit |
|
inlinevirtual |
| double openstudio::model::InternalMass::getSurfaceArea | ( | double | floorArea, |
| double | numPeople | ||
| ) | const |
Returns the construction surface area represented by this instance, assuming floorArea (m^2) and numPeople.
| double openstudio::model::InternalMass::getSurfaceAreaPerFloorArea | ( | double | floorArea, |
| double | numPeople | ||
| ) | const |
Returns the m^2/m^2 of construction surface area per floor area represented by this instance, assuming floorArea (m^2) and numPeople.
| double openstudio::model::InternalMass::getSurfaceAreaPerPerson | ( | double | floorArea, |
| double | numPeople | ||
| ) | const |
Returns the m^2/person of construction surface area represented by this instance, assuming floorArea (m^2) and numPeople.
|
static |
| InternalMassDefinition openstudio::model::InternalMass::internalMassDefinition | ( | ) | const |
Gets the InternalMassDefinition object.
| void openstudio::model::InternalMass::resetMultiplier | ( | ) |
| bool openstudio::model::InternalMass::setInternalMassDefinition | ( | const InternalMassDefinition & | definition | ) |
Sets the InternalMassDefinition object.
| bool openstudio::model::InternalMass::setMultiplier | ( | double | multiplier | ) |
| boost::optional<double> openstudio::model::InternalMass::surfaceArea | ( | ) | const |
Returns the surfaceArea if possible based on the underlying data of internalMassDefinition().
| boost::optional<double> openstudio::model::InternalMass::surfaceAreaPerFloorArea | ( | ) | const |
Returns the surfaceAreaPerFloorArea if possible based on the underlying data of internalMassDefinition().
| boost::optional<double> openstudio::model::InternalMass::surfaceAreaPerPerson | ( | ) | const |
Returns the surfaceAreaPerPerson if possible based on the underlying data of internalMassDefinition().
| boost::optional<SurfacePropertyConvectionCoefficients> openstudio::model::InternalMass::surfacePropertyConvectionCoefficients | ( | ) | const |
Returns the SurfacePropertyConvectionCoefficients, if it exists.
|
related |
|
related |