 |
OpenStudio:model |
#include <StandardsInformationConstruction.hpp>
Inheritance diagram for openstudio::model::StandardsInformationConstruction:Public Member Functions | |
Constructors and Destructors | |
| virtual | ~StandardsInformationConstruction ()=default |
| StandardsInformationConstruction (const StandardsInformationConstruction &other)=default | |
| StandardsInformationConstruction (StandardsInformationConstruction &&other)=default | |
| StandardsInformationConstruction & | operator= (const StandardsInformationConstruction &)=default |
| StandardsInformationConstruction & | operator= (StandardsInformationConstruction &&)=default |
Getters | |
| ConstructionBase | construction () const |
| Return the ConstructionBase object that this object describes. More... | |
| boost::optional< std::string > | intendedSurfaceType () const |
| Return the surface type to which this construction should be applied. More... | |
| boost::optional< std::string > | standardsConstructionType () const |
| This is a freeform field used to identify the construction type for standards. More... | |
| std::vector< std::string > | suggestedStandardsConstructionTypes () const |
| Returns a list of suggestions for standards construction type based on intendedSurfaceType. More... | |
| boost::optional< Material > | perturbableLayer () const |
| Return the layer of construction() whose thickness can be perturbed (usually to reach a certain property value for the overall construction), if the construction() exists and is a LayeredConstruction. More... | |
| boost::optional< std::string > | perturbableLayerType () const |
| Return a description of the perturbableLayer(), for instance, 'Insulation'. More... | |
| bool | isPerturbableLayerTypeDefaulted () const |
| boost::optional< std::string > | otherPerturbableLayerType () const |
| std::vector< std::string > | suggestedConstructionStandards () const |
| Returns a list of suggestions for construction standard. More... | |
| boost::optional< std::string > | constructionStandard () const |
| Identifies the standard which specifies this construction. More... | |
| std::vector< std::string > | suggestedConstructionStandardSources () const |
| Returns a list of suggestions for construction standard source based on construction standard. More... | |
| boost::optional< std::string > | constructionStandardSource () const |
| Identifies the table or section in standard which specifies this construction. More... | |
| boost::optional< std::string > | fenestrationType () const |
| Specific type of fenestration that this construction represents. More... | |
| boost::optional< std::string > | fenestrationAssemblyContext () const |
| Where the fenestration assembled. More... | |
| boost::optional< std::string > | fenestrationNumberOfPanes () const |
| Number of panes for this fenestration construction. More... | |
| boost::optional< std::string > | fenestrationFrameType () const |
| Type of framing for this fenestration construction. More... | |
| boost::optional< std::string > | fenestrationDividerType () const |
| Type of divider for this fenestration construction. More... | |
| boost::optional< std::string > | fenestrationTint () const |
| Tint of this fenestration construction. More... | |
| boost::optional< std::string > | fenestrationGasFill () const |
| Type of gas used between panes of this fenestration construction. More... | |
| bool | fenestrationLowEmissivityCoating () const |
| Does this fenestration construction include a low-e coating. More... | |
Setters | |
| bool | setIntendedSurfaceType (const std::string &type) |
| Sets the intendedSurfaceType to type. More... | |
| void | resetIntendedSurfaceType () |
| bool | setStandardsConstructionType (const std::string &type) |
| Set the constructionType to type. More... | |
| void | resetStandardsConstructionType () |
| bool | setPerturbableLayer (unsigned layerIndex) |
| Set the perturbableLayer to the one at layerIndex. More... | |
| bool | setPerturbableLayer (const Material &material) |
| Set the perturbableLayer to material. More... | |
| void | resetPerturbableLayer () |
| Clears all PerturbableLayer information, including type. More... | |
| bool | setPerturbableLayerType (const std::string &type) |
| Set the perturbableLayerType to type. More... | |
| void | resetPerturbableLayerType () |
| bool | setOtherPerturbableLayerType (const std::string &otherPerturbableLayerType) |
| void | resetOtherPerturbableLayerType () |
| bool | setConstructionStandard (const std::string &constructionStandard) |
| void | resetConstructionStandard () |
| bool | setConstructionStandardSource (const std::string &constructionStandardSource) |
| void | resetConstructionStandardSource () |
| bool | setFenestrationType (const std::string &fenestrationType) |
| void | resetFenestrationType () |
| bool | setFenestrationAssemblyContext (const std::string &fenestrationAssemblyContext) |
| void | resetFenestrationAssemblyContext () |
| bool | setFenestrationNumberOfPanes (const std::string &fenestrationNumberofPanes) |
| void | resetFenestrationNumberOfPanes () |
| bool | setFenestrationFrameType (const std::string &fenestrationFrameType) |
| void | resetFenestrationFrameType () |
| bool | setFenestrationDividerType (const std::string &fenestrationDividerType) |
| void | resetFenestrationDividerType () |
| bool | setFenestrationTint (const std::string &fenestrationTint) |
| void | resetFenestrationTint () |
| bool | setFenestrationGasFill (const std::string &fenestrationGasFill) |
| void | resetFenestrationGasFill () |
| bool | setFenestrationLowEmissivityCoating (bool fenestrationLowEmissivityCoating) |
| void | setFenestrationLowEmissivityCoatingNoFail (bool fenestrationLowEmissivityCoating) |
| void | resetFenestrationLowEmissivityCoating () |
| Public Member Functions inherited from openstudio::model::ModelObject | |
| 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 |
Static Public Member Functions | |
Static Methods | |
| static std::vector< std::string > | standardPerturbableLayerTypeValues () |
| static std::vector< std::string > | fenestrationTypeValues () |
| static std::vector< std::string > | fenestrationAssemblyContextValues () |
| static std::vector< std::string > | fenestrationNumberOfPanesValues () |
| static std::vector< std::string > | fenestrationFrameTypeValues () |
| static std::vector< std::string > | fenestrationDividerTypeValues () |
| static std::vector< std::string > | fenestrationTintValues () |
| static std::vector< std::string > | fenestrationGasFillValues () |
| static std::vector< std::string > | intendedSurfaceTypeValues () |
| static IddObjectType | iddObjectType () |
Related Functions | |
(Note that these are not member functions.) | |
| using | OptionalStandardsInformationConstruction = boost::optional< StandardsInformationConstruction > |
| using | StandardsInformationConstructionVector = std::vector< StandardsInformationConstruction > |
| 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 | |
| using | ImplType = detail::ModelObject_Impl |
| 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) | |
StandardsInformationConstruction is the ModelObject that wraps OpenStudio IDD object 'OS:StandardsInformation:ConstructionFields'.
StandardsInformationConstruction provides a place to register information about a construction that building energy standards often need to know, but is irrelevant to simulation. It contains user-specified values that are not generally checked against input or output data.
|
virtualdefault |
|
default |
|
default |
| ConstructionBase openstudio::model::StandardsInformationConstruction::construction | ( | ) | const |
Return the ConstructionBase object that this object describes.
| boost::optional<std::string> openstudio::model::StandardsInformationConstruction::constructionStandard | ( | ) | const |
Identifies the standard which specifies this construction.
| boost::optional<std::string> openstudio::model::StandardsInformationConstruction::constructionStandardSource | ( | ) | const |
Identifies the table or section in standard which specifies this construction.
| boost::optional<std::string> openstudio::model::StandardsInformationConstruction::fenestrationAssemblyContext | ( | ) | const |
Where the fenestration assembled.
|
static |
| boost::optional<std::string> openstudio::model::StandardsInformationConstruction::fenestrationDividerType | ( | ) | const |
Type of divider for this fenestration construction.
|
static |
| boost::optional<std::string> openstudio::model::StandardsInformationConstruction::fenestrationFrameType | ( | ) | const |
Type of framing for this fenestration construction.
|
static |
| boost::optional<std::string> openstudio::model::StandardsInformationConstruction::fenestrationGasFill | ( | ) | const |
Type of gas used between panes of this fenestration construction.
|
static |
| bool openstudio::model::StandardsInformationConstruction::fenestrationLowEmissivityCoating | ( | ) | const |
Does this fenestration construction include a low-e coating.
| boost::optional<std::string> openstudio::model::StandardsInformationConstruction::fenestrationNumberOfPanes | ( | ) | const |
Number of panes for this fenestration construction.
|
static |
| boost::optional<std::string> openstudio::model::StandardsInformationConstruction::fenestrationTint | ( | ) | const |
Tint of this fenestration construction.
|
static |
| boost::optional<std::string> openstudio::model::StandardsInformationConstruction::fenestrationType | ( | ) | const |
Specific type of fenestration that this construction represents.
|
static |
|
static |
| boost::optional<std::string> openstudio::model::StandardsInformationConstruction::intendedSurfaceType | ( | ) | const |
Return the surface type to which this construction should be applied.
|
static |
| bool openstudio::model::StandardsInformationConstruction::isPerturbableLayerTypeDefaulted | ( | ) | const |
|
default |
|
default |
| boost::optional<std::string> openstudio::model::StandardsInformationConstruction::otherPerturbableLayerType | ( | ) | const |
| boost::optional<Material> openstudio::model::StandardsInformationConstruction::perturbableLayer | ( | ) | const |
Return the layer of construction() whose thickness can be perturbed (usually to reach a certain property value for the overall construction), if the construction() exists and is a LayeredConstruction.
| boost::optional<std::string> openstudio::model::StandardsInformationConstruction::perturbableLayerType | ( | ) | const |
Return a description of the perturbableLayer(), for instance, 'Insulation'.
| void openstudio::model::StandardsInformationConstruction::resetConstructionStandard | ( | ) |
| void openstudio::model::StandardsInformationConstruction::resetConstructionStandardSource | ( | ) |
| void openstudio::model::StandardsInformationConstruction::resetFenestrationAssemblyContext | ( | ) |
| void openstudio::model::StandardsInformationConstruction::resetFenestrationDividerType | ( | ) |
| void openstudio::model::StandardsInformationConstruction::resetFenestrationFrameType | ( | ) |
| void openstudio::model::StandardsInformationConstruction::resetFenestrationGasFill | ( | ) |
| void openstudio::model::StandardsInformationConstruction::resetFenestrationLowEmissivityCoating | ( | ) |
| void openstudio::model::StandardsInformationConstruction::resetFenestrationNumberOfPanes | ( | ) |
| void openstudio::model::StandardsInformationConstruction::resetFenestrationTint | ( | ) |
| void openstudio::model::StandardsInformationConstruction::resetFenestrationType | ( | ) |
| void openstudio::model::StandardsInformationConstruction::resetIntendedSurfaceType | ( | ) |
| void openstudio::model::StandardsInformationConstruction::resetOtherPerturbableLayerType | ( | ) |
| void openstudio::model::StandardsInformationConstruction::resetPerturbableLayer | ( | ) |
Clears all PerturbableLayer information, including type.
| void openstudio::model::StandardsInformationConstruction::resetPerturbableLayerType | ( | ) |
| void openstudio::model::StandardsInformationConstruction::resetStandardsConstructionType | ( | ) |
| bool openstudio::model::StandardsInformationConstruction::setConstructionStandard | ( | const std::string & | constructionStandard | ) |
| bool openstudio::model::StandardsInformationConstruction::setConstructionStandardSource | ( | const std::string & | constructionStandardSource | ) |
| bool openstudio::model::StandardsInformationConstruction::setFenestrationAssemblyContext | ( | const std::string & | fenestrationAssemblyContext | ) |
| bool openstudio::model::StandardsInformationConstruction::setFenestrationDividerType | ( | const std::string & | fenestrationDividerType | ) |
| bool openstudio::model::StandardsInformationConstruction::setFenestrationFrameType | ( | const std::string & | fenestrationFrameType | ) |
| bool openstudio::model::StandardsInformationConstruction::setFenestrationGasFill | ( | const std::string & | fenestrationGasFill | ) |
| bool openstudio::model::StandardsInformationConstruction::setFenestrationLowEmissivityCoating | ( | bool | fenestrationLowEmissivityCoating | ) |
| void openstudio::model::StandardsInformationConstruction::setFenestrationLowEmissivityCoatingNoFail | ( | bool | fenestrationLowEmissivityCoating | ) |
| bool openstudio::model::StandardsInformationConstruction::setFenestrationNumberOfPanes | ( | const std::string & | fenestrationNumberofPanes | ) |
| bool openstudio::model::StandardsInformationConstruction::setFenestrationTint | ( | const std::string & | fenestrationTint | ) |
| bool openstudio::model::StandardsInformationConstruction::setFenestrationType | ( | const std::string & | fenestrationType | ) |
| bool openstudio::model::StandardsInformationConstruction::setIntendedSurfaceType | ( | const std::string & | type | ) |
Sets the intendedSurfaceType to type.
| bool openstudio::model::StandardsInformationConstruction::setOtherPerturbableLayerType | ( | const std::string & | otherPerturbableLayerType | ) |
| bool openstudio::model::StandardsInformationConstruction::setPerturbableLayer | ( | unsigned | layerIndex | ) |
Set the perturbableLayer to the one at layerIndex.
Returns false if construction() is not a LayeredConstruction or
| bool openstudio::model::StandardsInformationConstruction::setPerturbableLayer | ( | const Material & | material | ) |
Set the perturbableLayer to material.
Returns false if construction() is not a LayeredConstruction or
| bool openstudio::model::StandardsInformationConstruction::setPerturbableLayerType | ( | const std::string & | type | ) |
Set the perturbableLayerType to type.
Can be one of the provided types, or a free-form string.
| bool openstudio::model::StandardsInformationConstruction::setStandardsConstructionType | ( | const std::string & | type | ) |
Set the constructionType to type.
To be used with standardsinterface, this string should match an appropriate enumeration value in the standardsinterface::DataDictionary. The enumeration for which this should be a value generally varies by intendedSurfaceType().
|
static |
| boost::optional<std::string> openstudio::model::StandardsInformationConstruction::standardsConstructionType | ( | ) | const |
This is a freeform field used to identify the construction type for standards.
| std::vector<std::string> openstudio::model::StandardsInformationConstruction::suggestedConstructionStandards | ( | ) | const |
Returns a list of suggestions for construction standard.
| std::vector<std::string> openstudio::model::StandardsInformationConstruction::suggestedConstructionStandardSources | ( | ) | const |
Returns a list of suggestions for construction standard source based on construction standard.
| std::vector<std::string> openstudio::model::StandardsInformationConstruction::suggestedStandardsConstructionTypes | ( | ) | const |
Returns a list of suggestions for standards construction type based on intendedSurfaceType.
|
related |
|
related |