 |
OpenStudio:model |
|
OpenStudio:model |
#include <ConstructionBase.hpp>
Inheritance diagram for openstudio::model::ConstructionBase:Public Member Functions | |
| boost::optional< double > | exteriorVisibleAbsorbtance () const |
| boost::optional< double > | exteriorVisibleAbsorptance () const |
| Get the visible absorptance of the exterior side of this construction (dimensionless). More... | |
| double | getNetArea () const |
| Returns the sum of the surface area of all planar surfaces that use this construction (m^2). More... | |
| boost::optional< double > | heatCapacity () const |
| Get the heat capacity of this construction (J/m^2*K). More... | |
| boost::optional< double > | interiorVisibleAbsorbtance () const |
| boost::optional< double > | interiorVisibleAbsorptance () const |
| Get the visible absorptance of the interior side of this construction (dimensionless). More... | |
| bool | isFenestration () const |
| bool | isGreenRoof () const |
| Returns true if the construction has RoofVegetation as the outer layer. More... | |
| bool | isModelPartition () const |
| bool | isOpaque () const |
| bool | isSolarDiffusing () const |
| Returns true if isFenestration and any material layers are solar diffusing. More... | |
| boost::optional< RenderingColor > | renderingColor () const |
| Returns the rendering color. More... | |
| void | resetRenderingColor () |
| Resets the rendering color. More... | |
| bool | setConductance (double value) |
| Set the conductance of this surface in W/m^2*K, if possible. More... | |
| bool | setConductance (double value, double filmResistance) |
| Set the conductance of this surface in W/m^2*K, if possible. More... | |
| bool | setRenderingColor (const RenderingColor &renderingColor) |
| Sets the rendering color. More... | |
| bool | setUFactor (double value) |
| Set the u-factor of this surface in W/m^2*K, if possible. More... | |
| bool | setUFactor (double value, double filmResistance) |
| Set the u-factor of this surface in W/m^2*K, if possible. More... | |
| boost::optional< double > | thermalConductance () const |
| Get the thermal conductance of this construction (W/m^2*K). More... | |
| boost::optional< double > | thermalConductance (double filmResistance) const |
| Get the thermal conductance of this construction (W/m^2*K). More... | |
| boost::optional< double > | uFactor () const |
| Get the u-factor of this construction (W/m^2*K). More... | |
| boost::optional< double > | uFactor (double filmResistance) const |
| Get the u-factor of this construction (W/m^2*K). More... | |
| boost::optional< double > | visibleTransmittance () const |
| Get the visible transmittance of this construction (dimensionless). More... | |
Constructors and Destructors | |
| virtual | ~ConstructionBase () |
Getters | |
| StandardsInformationConstruction | standardsInformation () const |
| Returns this construction's standards information, constructing a new object if necessary. More... | |
| Public Member Functions inherited from openstudio::model::ResourceObject | |
| unsigned | directUseCount (bool excludeChildren=false) const |
| Returns the number of objects that use this resource directly. More... | |
| unsigned | nonResourceObjectUseCount (bool excludeChildren=false) const |
| Returns the number of non-ResourceObjects that use this resource either directly or indirectly. More... | |
| virtual | ~ResourceObject () |
| Public Member Functions inherited from openstudio::model::ParentObject | |
| 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... | |
| virtual | ~ParentObject () |
| 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... | |
| 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< ModelObject > | connectedObject (unsigned port) const |
| boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
| Public Member Functions inherited from openstudio::WorkspaceObject | |
| 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) |
| 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 |
| virtual | ~WorkspaceObject () |
| Public Member Functions inherited from openstudio::IdfObject | |
| 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 |
| 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 |
| boost::optional< QUrl > | getURL (unsigned index, bool returnDefault=false) const |
| Handle | handle () const |
| IddObject | iddObject () const |
| IdfObject (IddObjectType type, bool fastName=false) | |
| IdfObject (const IddObject &, bool fastName=false) | |
| IdfObject (const IdfObject &other) | |
| 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) 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) |
| 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 () |
| IdfExtensibleGroup | pushExtensibleGroup (const std::vector< std::string > &values) |
| 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=true) const |
| virtual | ~IdfObject () |
Related Functions | |
(Note that these are not member functions.) | |
| typedef std::vector < ConstructionBase > | ConstructionBaseVector |
| typedef boost::optional < ConstructionBase > | OptionalConstructionBase |
| Related Functions inherited from openstudio::model::ResourceObject | |
| typedef boost::optional < ResourceObject > | OptionalResourceObject |
| typedef std::vector < ResourceObject > | ResourceObjectVector |
| Related Functions inherited from openstudio::model::ParentObject | |
| std::vector< ModelObject > | getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCosts=false) |
| Returns object and all other objects accessible by calling children() on encountered ParentObjects . More... | |
| std::vector< ModelObject > | getRecursiveChildrenAndResources (const ModelObject &object) |
| Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More... | |
| 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... | |
| typedef std::pair< std::string, std::string > | ScheduleTypeKey |
| Typedef for ScheduleTypeRegistry key. More... | |
Additional Inherited Members | |
| Public Types inherited from openstudio::WorkspaceObject | |
| typedef boost::optional < WorkspaceObject > | OptionalWorkspaceObject |
| typedef std::vector < WorkspaceObject > | WorkspaceObjectVector |
| Public Types inherited from openstudio::IdfObject | |
| typedef std::pair< IdfObject, IdfObject > | IdfObjectPair |
| typedef std::vector< IdfObject > | IdfObjectVector |
| typedef boost::optional < IdfObject > | OptionalIdfObject |
| Static Public Member Functions inherited from openstudio::IdfObject | |
| static boost::optional< IdfObject > | load (const std::string &text) |
| static boost::optional< IdfObject > | load (const std::string &text, const IddObject &iddObject) |
| static int | printedFieldSpace () |
| Protected Types inherited from openstudio::model::ModelObject | |
| typedef detail::ModelObject_Impl | ImplType |
| Protected Types inherited from openstudio::WorkspaceObject | |
| typedef detail::WorkspaceObject_Impl | ImplType |
| Protected Types inherited from openstudio::IdfObject | |
| typedef detail::IdfObject_Impl | ImplType |
| Protected Member Functions inherited from openstudio::model::ResourceObject | |
| ResourceObject (IddObjectType type, const Model &model) | |
| Constructs a new PlanarSurface object in the model. More... | |
| Protected Member Functions inherited from openstudio::model::ParentObject | |
| ParentObject (IddObjectType type, const Model &model) | |
| Constructs a new ParentObject 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) | |
| Protected Member Functions inherited from openstudio::WorkspaceObject | |
| WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl) | |
| Protected Member Functions inherited from openstudio::IdfObject | |
| IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl) | |
ConstructionBase is a ResourceObject that serves as a base class for several objects that can be used to specify a construction for a PlanarSurface.
|
inlinevirtual |
| boost::optional<double> openstudio::model::ConstructionBase::exteriorVisibleAbsorbtance | ( | ) | const |
| boost::optional<double> openstudio::model::ConstructionBase::exteriorVisibleAbsorptance | ( | ) | const |
Get the visible absorptance of the exterior side of this construction (dimensionless).
May require simulation ('EnvelopeSummary' table).
Attribute Name: 'exteriorVisibleAbsorptance'
| double openstudio::model::ConstructionBase::getNetArea | ( | ) | const |
Returns the sum of the surface area of all planar surfaces that use this construction (m^2).
If this construction is used by a Surface that contains one or more SubSurfaces , than the SubSurface areas are subtracted out of the total. If two adjacent surfaces both reference the same construction then only the area of the largest adjacent surface will be counted. If two adjacent surfaces reference different constructions then the net area of each adjacent surface will be included in the net area for their respective constructions.
| boost::optional<double> openstudio::model::ConstructionBase::heatCapacity | ( | ) | const |
Get the heat capacity of this construction (J/m^2*K).
Only works for LayeredConstructions of StandardOpaqueMaterials .
Attribute Name: 'heatCapacity'
| boost::optional<double> openstudio::model::ConstructionBase::interiorVisibleAbsorbtance | ( | ) | const |
| boost::optional<double> openstudio::model::ConstructionBase::interiorVisibleAbsorptance | ( | ) | const |
Get the visible absorptance of the interior side of this construction (dimensionless).
May require simulation ('EnvelopeSummary' table).
Attribute Name: 'interiorVisibleAbsorptance'
| bool openstudio::model::ConstructionBase::isFenestration | ( | ) | const |
| bool openstudio::model::ConstructionBase::isGreenRoof | ( | ) | const |
Returns true if the construction has RoofVegetation as the outer layer.
| bool openstudio::model::ConstructionBase::isModelPartition | ( | ) | const |
| bool openstudio::model::ConstructionBase::isOpaque | ( | ) | const |
| bool openstudio::model::ConstructionBase::isSolarDiffusing | ( | ) | const |
Returns true if isFenestration and any material layers are solar diffusing.
| boost::optional<RenderingColor> openstudio::model::ConstructionBase::renderingColor | ( | ) | const |
Returns the rendering color.
| void openstudio::model::ConstructionBase::resetRenderingColor | ( | ) |
Resets the rendering color.
| bool openstudio::model::ConstructionBase::setConductance | ( | double | value | ) |
Set the conductance of this surface in W/m^2*K, if possible.
value should not include any film coefficients.
| bool openstudio::model::ConstructionBase::setConductance | ( | double | value, |
| double | filmResistance | ||
| ) |
Set the conductance of this surface in W/m^2*K, if possible.
filmResistance (m^2*K/W) may be used to convert value to a u-factor.
| bool openstudio::model::ConstructionBase::setRenderingColor | ( | const RenderingColor & | renderingColor | ) |
Sets the rendering color.
| bool openstudio::model::ConstructionBase::setUFactor | ( | double | value | ) |
Set the u-factor of this surface in W/m^2*K, if possible.
Value should already include appropriate standard film coefficients, assuming still air indoors and 15 mph outdoor air speed. Does not consider any custom SurfacePropertyConvectionCoefficients.
| bool openstudio::model::ConstructionBase::setUFactor | ( | double | value, |
| double | filmResistance | ||
| ) |
Set the u-factor of this surface in W/m^2*K, if possible.
filmResistance (m^2*K/W) may be used to convert value to a conductance.
| StandardsInformationConstruction openstudio::model::ConstructionBase::standardsInformation | ( | ) | const |
Returns this construction's standards information, constructing a new object if necessary.
| boost::optional<double> openstudio::model::ConstructionBase::thermalConductance | ( | ) | const |
Get the thermal conductance of this construction (W/m^2*K).
Does not include film coefficients.
| boost::optional<double> openstudio::model::ConstructionBase::thermalConductance | ( | double | filmResistance | ) | const |
Get the thermal conductance of this construction (W/m^2*K).
filmResistance is subtracted out of the thermalResistance if necessary.
| boost::optional<double> openstudio::model::ConstructionBase::uFactor | ( | ) | const |
Get the u-factor of this construction (W/m^2*K).
Includes standard film coefficients, does not consider any custom SurfacePropertyConvectionCoefficients.
| boost::optional<double> openstudio::model::ConstructionBase::uFactor | ( | double | filmResistance | ) | const |
Get the u-factor of this construction (W/m^2*K).
Includes filmResistance.
| boost::optional<double> openstudio::model::ConstructionBase::visibleTransmittance | ( | ) | const |
Get the visible transmittance of this construction (dimensionless).
May require simulation ('EnvelopeSummary' table).
Attribute Name: 'visibleTransmittance'
|
related |
|
related |