|
|
| | Construction (const Model &model) |
| |
| | Construction (const std::vector< OpaqueMaterial > &opaqueMaterials) |
| |
| | Construction (const std::vector< FenestrationMaterial > &fenestrationMaterials) |
| |
| | Construction (const ModelPartitionMaterial &modelPartitionMaterial) |
| |
| virtual | ~Construction () override=default |
| |
| | Construction (const Construction &other)=default |
| |
| | Construction (Construction &&other)=default |
| |
| Construction & | operator= (const Construction &)=default |
| |
| Construction & | operator= (Construction &&)=default |
| |
| virtual | ~LayeredConstruction () override=default |
| |
| | LayeredConstruction (const LayeredConstruction &other)=default |
| |
| | LayeredConstruction (LayeredConstruction &&other)=default |
| |
| LayeredConstruction & | operator= (const LayeredConstruction &)=default |
| |
| LayeredConstruction & | operator= (LayeredConstruction &&)=default |
| |
| std::vector< Material > | layers () const |
| | Returns the material layers that make up this construction.
|
| |
| Material | getLayer (unsigned layerIndex) const |
| | Get the Material at layerIndex, where layerIndex is between 0 and numLayers() - 1.
|
| |
| bool | eraseLayer (unsigned layerIndex) |
| | Erases the Material at layerIndex, if possible.
|
| |
| bool | insertLayer (unsigned layerIndex, const Material &material) |
| | Insert opaqueMaterial at layerIndex, if possible.
|
| |
| bool | setLayer (unsigned layerIndex, const Material &material) |
| | Set the layer at layerIndex to opaqueMaterial, if possible.
|
| |
| bool | setLayers (const std::vector< Material > &materials) |
| | Set the construction to use opaqueMaterials as its layers, if layersAreValid(opaqueMaterials).
|
| |
| bool | setLayer (const ModelPartitionMaterial &modelPartitionMaterial) |
| | Sets the construction to use modelPartitionMaterial.
|
| |
| bool | isSymmetric () const |
| | Returns true if this is a symmetric layered construction.
|
| |
| bool | equalLayers (const LayeredConstruction &other) const |
| | Returns true if this construction has the same layers as other one.
|
| |
| bool | reverseEqualLayers (const LayeredConstruction &other) const |
| | Returns true if this construction has the same layers but in reverse order as other one.
|
| |
| std::vector< unsigned > | nullLayers () const |
| | Returns layer indices that do not actually point to a Material.
|
| |
| unsigned | numLayers () const |
| | Returns the number of non-null layers in this construction.
|
| |
| std::vector< unsigned > | getLayerIndices (const Material &material) const |
| | Returns the indices from which this construction points to material.
|
| |
| boost::optional< OpaqueMaterial > | insulation () const |
| | Returns the layer designated as insulation, if such a designation has been made.
|
| |
| bool | setInsulation (const OpaqueMaterial &insulationLayer) |
| | Notes that insulationLayer is the perturbable insulation layer.
|
| |
| void | resetInsulation () |
| | Removes any existing insulation layer designations.
|
| |
| void | ensureUniqueLayers () |
| | Ensures that all materials in this construction are used by this construction only.
|
| |
| virtual | ~ConstructionBase () override=default |
| |
| | ConstructionBase (const ConstructionBase &other)=default |
| |
| | ConstructionBase (ConstructionBase &&other)=default |
| |
| ConstructionBase & | operator= (const ConstructionBase &)=default |
| |
| ConstructionBase & | operator= (ConstructionBase &&)=default |
| |
| StandardsInformationConstruction | standardsInformation () const |
| | Returns this construction's standards information, constructing a new object if necessary.
|
| |
| double | getNetArea () const |
| | Returns the sum of the surface area of all planar surfaces that use this construction (m^2).
|
| |
| bool | setUFactor (double value) |
| | Set the u-factor of this surface in W/m^2*K, if possible.
|
| |
| bool | setUFactor (double value, double filmResistance) |
| | Set the u-factor of this surface in W/m^2*K, if possible.
|
| |
| bool | setConductance (double value) |
| | Set the conductance of this surface in W/m^2*K, if possible.
|
| |
| bool | setConductance (double value, double filmResistance) |
| | Set the conductance of this surface in W/m^2*K, if possible.
|
| |
| bool | isOpaque () const |
| |
| bool | isFenestration () const |
| |
| bool | isSolarDiffusing () const |
| | Returns true if isFenestration and any material layers are solar diffusing.
|
| |
| bool | isModelPartition () const |
| |
| bool | isGreenRoof () const |
| | Returns true if the construction has RoofVegetation as the outer layer.
|
| |
| boost::optional< double > | uFactor () const |
| | Get the u-factor of this construction (W/m^2*K).
|
| |
| boost::optional< double > | uFactor (double filmResistance) const |
| | Get the u-factor of this construction (W/m^2*K).
|
| |
| boost::optional< double > | thermalConductance () const |
| | Get the thermal conductance of this construction (W/m^2*K).
|
| |
| boost::optional< double > | thermalConductance (double filmResistance) const |
| | Get the thermal conductance of this construction (W/m^2*K).
|
| |
| boost::optional< double > | heatCapacity () const |
| | Get the heat capacity of this construction (J/m^2*K).
|
| |
| boost::optional< double > | interiorVisibleAbsorptance () const |
| | Get the visible absorptance of the interior side of this construction (dimensionless).
|
| |
| boost::optional< double > | exteriorVisibleAbsorptance () const |
| | Get the visible absorptance of the exterior side of this construction (dimensionless).
|
| |
| boost::optional< double > | visibleTransmittance () const |
| | Get the visible transmittance of this construction (dimensionless).
|
| |
| boost::optional< RenderingColor > | renderingColor () const |
| | Returns the rendering color.
|
| |
| bool | setRenderingColor (const RenderingColor &renderingColor) |
| | Sets the rendering color.
|
| |
| void | resetRenderingColor () |
| | Resets the rendering color.
|
| |
| unsigned | directUseCount (bool excludeChildren=false) const |
| | Returns the number of objects that use this resource directly.
|
| |
| unsigned | nonResourceObjectUseCount (bool excludeChildren=false) const |
| | Returns the number of non-ResourceObjects that use this resource either directly or indirectly.
|
| |
| ResourceObject & | operator= (const ResourceObject &)=default |
| |
| ResourceObject & | operator= (ResourceObject &&)=default |
| |
| | ResourceObject (const ResourceObject &other)=default |
| |
| | ResourceObject (ResourceObject &&other)=default |
| |
| virtual | ~ResourceObject () override=default |
| |
| ParentObject & | operator= (const ParentObject &)=default |
| |
| ParentObject & | operator= (ParentObject &&)=default |
| |
| | ParentObject (const ParentObject &other)=default |
| |
| | ParentObject (ParentObject &&other)=default |
| |
| virtual | ~ParentObject () override=default |
| |
| std::vector< ModelObject > | children () const |
| | Return direct child objects in the Model.
|
| |
| std::vector< IddObjectType > | allowableChildTypes () const |
| | Returns a vector of allowable children types.
|
| |
| virtual | ~ModelObject () override=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().
|
| |
| ModelObject | clone (Model model) const |
| | Creates a deep copy of this object, placing it in model.
|
| |
| Component | createComponent () const |
| | Method for creating sharable Model snippets.
|
| |
| Model | model () const |
| | Returns the Model that contains this object.
|
| |
| boost::optional< ParentObject > | parent () const |
| | Return this object's parent in the hierarchy, if it has one.
|
| |
| std::vector< ResourceObject > | resources () const |
| | Get the resources directly used by this ModelObject.
|
| |
| template<typename T > |
| std::vector< T > | getModelObjectSources () const |
| | Get all objects of type T that point to this object.
|
| |
| template<typename T > |
| std::vector< T > | getModelObjectSources (IddObjectType iddObjectType) const |
| | Get all objects of type T that point to this object.
|
| |
| template<typename T > |
| boost::optional< T > | getModelObjectTarget (unsigned index) const |
| | Get the object of type T pointed to by this object from field index.
|
| |
| template<typename T > |
| std::vector< T > | getModelObjectTargets () const |
| | Get all objects of type T to which this object points.
|
| |
| const std::vector< std::string > & | outputVariableNames () const |
| | Get all output variables names that could be associated with this object.
|
| |
| std::vector< OutputVariable > | outputVariables () const |
| | Get all output variables associated with this object, must run simulation to generate data.
|
| |
| boost::optional< openstudio::TimeSeries > | getData (const OutputVariable &variable, const std::string &envPeriod) const |
| | Get data associated with this output variable and this object.
|
| |
| std::vector< LifeCycleCost > | lifeCycleCosts () const |
| | Returns the list of all LifeCycleCosts that refer to this object.
|
| |
| std::vector< IdfObject > | removeLifeCycleCosts () |
| | Removes all LifeCycleCosts that refer to this object.
|
| |
| IddObjectType | iddObjectType () const |
| | This is a virtual function that will tell you the type of iddObject you are dealing with.
|
| |
| AdditionalProperties | additionalProperties () const |
| | Returns this object's additional properties, constructing a new object if necessary.
|
| |
| bool | hasAdditionalProperties () const |
| | Returns true if this object has additional properties.
|
| |
| std::vector< IdfObject > | removeAdditionalProperties () |
| | Removes all additional properties that refer to this object.
|
| |
| 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
|
| |
| bool | operator< (const ModelObject &right) const |
| |
| bool | operator== (const ModelObject &other) const |
| | equality test
|
| |
| bool | operator!= (const ModelObject &other) const |
| | inequality test
|
| |
| std::vector< ScheduleTypeKey > | getScheduleTypeKeys (const Schedule &schedule) const |
| | Return the ScheduleTypeKeys indicating how schedule is used in this object.
|
| |
| boost::optional< double > | getAutosizedValue (const std::string &valueName, const std::string &units) const |
| | Gets the autosized component value from the sql file.
|
| |
| virtual std::vector< EMSActuatorNames > | emsActuatorNames () const |
| | Return the names of the available ems actuators.
|
| |
| virtual std::vector< std::string > | emsInternalVariableNames () const |
| | Return the names of the available ems internal variables.
|
| |
| boost::optional< ModelObject > | connectedObject (unsigned port) const |
| |
| boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
| |
| bool | canBeSource () const |
| |
| bool | canBeSource () const |
| |
| bool | canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const |
| |
| bool | canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const |
| |
| std::vector< std::string > | canBeTarget () const |
| |
| std::vector< std::string > | canBeTarget () const |
| |
| std::vector< unsigned > | getSourceIndices (const Handle &targetHandle) const |
| |
| std::vector< unsigned > | getSourceIndices (const Handle &targetHandle) const |
| |
| std::vector< WorkspaceObject > | getSources (IddObjectType type) const |
| |
| std::vector< WorkspaceObject > | getSources (IddObjectType type) const |
| |
| boost::optional< WorkspaceObject > | getTarget (unsigned index) const |
| |
| boost::optional< WorkspaceObject > | getTarget (unsigned index) const |
| |
| IdfObject | idfObject () |
| |
| IdfObject | idfObject () const |
| |
| bool | initialized () const |
| |
| bool | initialized () const |
| |
| bool | isSource () const |
| |
| bool | isSource () const |
| |
| bool | isTarget () const |
| |
| bool | isTarget () const |
| |
| unsigned | numSources () const |
| |
| unsigned | numSources () const |
| |
| bool | objectListFieldsEqual (const WorkspaceObject &other) const |
| |
| bool | objectListFieldsEqual (const WorkspaceObject &other) const |
| |
| bool | objectListFieldsNonConflicting (const WorkspaceObject &other) const |
| |
| bool | objectListFieldsNonConflicting (const WorkspaceObject &other) const |
| |
| bool | operator< (const WorkspaceObject &right) const |
| |
| bool | operator< (const WorkspaceObject &right) const |
| |
| std::ostream & | operator<< (std::ostream &os, const WorkspaceObject &workspaceObject) |
| |
| WorkspaceObject & | operator= (const WorkspaceObject &)=default |
| |
| WorkspaceObject & | operator= (const WorkspaceObject &)=default |
| |
| WorkspaceObject & | operator= (WorkspaceObject &&)=default |
| |
| WorkspaceObject & | operator= (WorkspaceObject &&)=default |
| |
| std::vector< openstudio::IdfObject > | remove () |
| |
| std::vector< openstudio::IdfObject > | remove () |
| |
| bool | setPointer (unsigned index, const Handle &targetHandle) |
| |
| bool | setPointer (unsigned index, const Handle &targetHandle) |
| |
| std::vector< WorkspaceObject > | sources () const |
| |
| std::vector< WorkspaceObject > | sources () const |
| |
| std::vector< WorkspaceObject > | targets () const |
| |
| std::vector< WorkspaceObject > | targets () const |
| |
| Workspace | workspace () const |
| |
| Workspace | workspace () const |
| |
| | WorkspaceObject (const WorkspaceObject &other)=default |
| |
| | WorkspaceObject (const WorkspaceObject &other)=default |
| |
| | WorkspaceObject (WorkspaceObject &&other)=default |
| |
| | WorkspaceObject (WorkspaceObject &&other)=default |
| |
| virtual | ~WorkspaceObject () override=default |
| |
| virtual | ~WorkspaceObject () override=default |
| |
| std::string | briefDescription () const |
| |
| std::string | briefDescription () const |
| |
| T | cast () const |
| |
| std::vector< T > | castVector (const std::vector< U > &objects) |
| |
| std::vector< std::vector< std::string > > | clearExtensibleGroups () |
| |
| std::vector< std::vector< std::string > > | clearExtensibleGroups () |
| |
| IdfObject | clone (bool keepHandle=false) const |
| |
| IdfObject | clone (bool keepHandle=false) const |
| |
| std::string | comment () const |
| |
| std::string | comment () const |
| |
| boost::optional< std::string > | createName (bool overwrite=true) |
| |
| boost::optional< std::string > | createName (bool overwrite=true) |
| |
| std::vector< unsigned > | dataFields () const |
| |
| std::vector< unsigned > | dataFields () const |
| |
| bool | dataFieldsEqual (const IdfObject &other) const |
| |
| bool | dataFieldsEqual (const IdfObject &other) const |
| |
| std::vector< std::string > | eraseExtensibleGroup (unsigned groupIndex) |
| |
| std::vector< std::string > | eraseExtensibleGroup (unsigned groupIndex) |
| |
| std::vector< IdfExtensibleGroup > | extensibleGroups () const |
| |
| std::vector< IdfExtensibleGroup > | extensibleGroups () const |
| |
| boost::optional< std::string > | fieldComment (unsigned index, bool returnDefault=false) const |
| |
| boost::optional< std::string > | fieldComment (unsigned index, bool returnDefault=false) const |
| |
| boost::optional< double > | getDouble (unsigned index, bool returnDefault=false) const |
| |
| boost::optional< double > | getDouble (unsigned index, bool returnDefault=false) const |
| |
| IdfExtensibleGroup | getExtensibleGroup (unsigned groupIndex) const |
| |
| IdfExtensibleGroup | getExtensibleGroup (unsigned groupIndex) const |
| |
| boost::optional< std::string > | getField (unsigned index, bool returnDefault=false) 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 |
| |
| boost::optional< int > | getInt (unsigned index, bool returnDefault=false) const |
| |
| OSOptionalQuantity | getQuantity (unsigned index, bool returnDefault=false, bool returnIP=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< std::string > | getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const |
| |
| boost::optional< unsigned > | getUnsigned (unsigned index, bool returnDefault=false) const |
| |
| boost::optional< unsigned > | getUnsigned (unsigned index, bool returnDefault=false) const |
| |
| Handle | handle () const |
| |
| Handle | handle () const |
| |
| IddObject | iddObject () const |
| |
| IddObject | iddObject () const |
| |
| | IdfObject (const IddObject &, bool fastName=false) |
| |
| | IdfObject (const IddObject &, bool fastName=false) |
| |
| | IdfObject (const IdfObject &other) |
| |
| | IdfObject (const IdfObject &other) |
| |
| | IdfObject (IddObjectType type, bool fastName=false) |
| |
| | IdfObject (IddObjectType type, bool fastName=false) |
| |
| | IdfObject (IdfObject &&other) noexcept |
| |
| | IdfObject (IdfObject &&other) noexcept |
| |
| void | initializeFields (bool fill_default=false) |
| |
| void | initializeFields (bool fill_default=false) |
| |
| IdfExtensibleGroup | insertExtensibleGroup (unsigned groupIndex) |
| |
| IdfExtensibleGroup | insertExtensibleGroup (unsigned groupIndex) |
| |
| IdfExtensibleGroup | insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values) |
| |
| IdfExtensibleGroup | insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values) |
| |
| bool | isDataField (unsigned index) const |
| |
| bool | isDataField (unsigned index) const |
| |
| bool | isEmpty (unsigned index) const |
| |
| bool | isEmpty (unsigned index) const |
| |
| bool | isObjectListField (unsigned index) const |
| |
| bool | isObjectListField (unsigned index) const |
| |
| bool | isValid (StrictnessLevel level, bool checkNames=false) const |
| |
| bool | isValid (StrictnessLevel level, bool checkNames=false) const |
| |
| boost::optional< unsigned > | maxExtensibleGroups () const |
| |
| boost::optional< unsigned > | maxExtensibleGroups () const |
| |
| boost::optional< unsigned > | maxFields () const |
| |
| boost::optional< unsigned > | maxFields () const |
| |
| unsigned | minExtensibleGroups () const |
| |
| unsigned | minExtensibleGroups () const |
| |
| unsigned | minFields () const |
| |
| unsigned | minFields () const |
| |
| boost::optional< std::string > | name (bool returnDefault=false) const |
| |
| boost::optional< std::string > | name (bool returnDefault=false) const |
| |
| std::string | nameString (bool returnDefault=false) const |
| |
| std::string | nameString (bool returnDefault=false) const |
| |
| unsigned | numExtensibleGroups () const |
| |
| unsigned | numExtensibleGroups () const |
| |
| unsigned | numFields () const |
| |
| unsigned | numFields () const |
| |
| unsigned | numNonextensibleFields () const |
| |
| unsigned | numNonextensibleFields () const |
| |
| std::vector< unsigned > | objectListFields () const |
| |
| std::vector< unsigned > | objectListFields () const |
| |
| bool | objectListFieldsEqual (const IdfObject &other) const |
| |
| bool | objectListFieldsEqual (const IdfObject &other) const |
| |
| bool | objectListFieldsNonConflicting (const IdfObject &other) const |
| |
| bool | objectListFieldsNonConflicting (const IdfObject &other) const |
| |
| bool | operator!= (const IdfObject &other) const |
| |
| bool | operator!= (const IdfObject &other) const |
| |
| std::ostream & | operator<< (std::ostream &os, const IdfObject &IdfObject) |
| |
| IdfObject & | operator= (const IdfObject &other) |
| |
| IdfObject & | operator= (const IdfObject &other) |
| |
| IdfObject & | operator= (IdfObject &&other) noexcept |
| |
| IdfObject & | operator= (IdfObject &&other) noexcept |
| |
| bool | operator== (const IdfObject &other) const |
| |
| bool | operator== (const IdfObject &other) const |
| |
| boost::optional< T > | optionalCast () const |
| |
| std::vector< std::string > | popExtensibleGroup () |
| |
| 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 () |
| |
| IdfExtensibleGroup | pushExtensibleGroup (const std::vector< std::string > &values) |
| |
| IdfExtensibleGroup | pushExtensibleGroup (const std::vector< std::string > &values) |
| |
| std::vector< unsigned > | requiredFields () const |
| |
| std::vector< unsigned > | requiredFields () const |
| |
| void | setComment (const std::string &msg) |
| |
| void | setComment (const std::string &msg) |
| |
| bool | setDouble (unsigned index, double value) |
| |
| bool | setDouble (unsigned index, double value) |
| |
| bool | setFieldComment (unsigned index, const std::string &cmnt) |
| |
| bool | setFieldComment (unsigned index, const std::string &cmnt) |
| |
| bool | setInt (unsigned index, int value) |
| |
| bool | setInt (unsigned index, int value) |
| |
| boost::optional< std::string > | setName (const std::string &newName) |
| |
| boost::optional< std::string > | setName (const std::string &newName) |
| |
| bool | setQuantity (unsigned index, const Quantity &q) |
| |
| bool | setQuantity (unsigned index, const Quantity &q) |
| |
| bool | setString (unsigned index, const std::string &value) |
| |
| bool | setString (unsigned index, const std::string &value) |
| |
| bool | setUnsigned (unsigned index, unsigned value) |
| |
| bool | setUnsigned (unsigned index, unsigned value) |
| |
| std::vector< T > | subsetCastVector (const std::vector< U > &original) |
| |
| ValidityReport | validityReport (StrictnessLevel level, bool checkNames=false) const |
| |
| ValidityReport | validityReport (StrictnessLevel level, bool checkNames=false) const |
| |
| virtual | ~IdfObject ()=default |
| |
| virtual | ~IdfObject ()=default |
| |
Inheritance diagram for openstudio::model::Construction: