 |
OpenStudioCore:model |
|
OpenStudioCore:model |
#include "LayeredConstruction.hpp"
Public Member Functions | |
| virtual | ~LayeredConstruction () |
| std::vector< Material > | layers () const |
| Material | getLayer (unsigned layerIndex) const |
| bool | eraseLayer (unsigned layerIndex) |
| bool | insertLayer (unsigned layerIndex, const Material &material) |
| bool | setLayer (unsigned layerIndex, const Material &material) |
| bool | setLayers (const std::vector< Material > &materials) |
| bool | setLayer (const ModelPartitionMaterial &modelPartitionMaterial) |
| bool | isSymmetric () const |
| bool | equalLayers (const LayeredConstruction &other) const |
| bool | reverseEqualLayers (const LayeredConstruction &other) const |
| std::vector< unsigned > | nullLayers () const |
| unsigned | numLayers () const |
| std::vector< unsigned > | getLayerIndices (const Material &material) const |
| boost::optional< OpaqueMaterial > | insulation () const |
| bool | setInsulation (const OpaqueMaterial &insulationLayer) |
| void | resetInsulation () |
| void | ensureUniqueLayers () |
Static Public Member Functions | |
| static bool | layersAreValid (const std::vector< Material > &materials) |
| static bool | layersAreValid (const std::vector< OpaqueMaterial > &opaqueMaterials) |
| static bool | layersAreValid (const std::vector< FenestrationMaterial > &fenestrationMaterials) |
Related Functions | |
| typedef std::vector < LayeredConstruction > | LayeredConstructionVector |
| typedef boost::optional < LayeredConstruction > | OptionalLayeredConstruction |
LayeredConstruction is a ConstructionBase that serves as a base class to concrete construction classes that are composed of Material layers.
|
inlinevirtual |
| void openstudio::model::LayeredConstruction::ensureUniqueLayers | ( | ) |
Ensures that all materials in this construction are used by this construction only.
Allows standards to then appply standards specified material properties to each layer (e.g. SRI).
| bool openstudio::model::LayeredConstruction::equalLayers | ( | const LayeredConstruction & | other | ) | const |
Returns true if this construction has the same layers as other one.
| bool openstudio::model::LayeredConstruction::eraseLayer | ( | unsigned | layerIndex | ) |
Erases the Material at layerIndex, if possible.
Must have 0 <= layerIndex < numLayers, and resulting construction must satisfy layersAreValid.
| Material openstudio::model::LayeredConstruction::getLayer | ( | unsigned | layerIndex | ) | const |
Get the Material at layerIndex, where layerIndex is between 0 and numLayers() - 1.
Throws a openstudio::Exception if layerIndex >= numLayers.
| std::vector<unsigned> openstudio::model::LayeredConstruction::getLayerIndices | ( | const Material & | material | ) | const |
Returns the indices from which this construction points to material.
| bool openstudio::model::LayeredConstruction::insertLayer | ( | unsigned | layerIndex, |
| const Material & | material | ||
| ) |
Insert opaqueMaterial at layerIndex, if possible.
Must have 0 <= layerIndex <= numLayers, and this construction must have no layers or satisfy isOpaque == true. Furthermore, the resulting construction must satisfy layersAreValid.
| boost::optional<OpaqueMaterial> openstudio::model::LayeredConstruction::insulation | ( | ) | const |
Returns the layer designated as insulation, if such a designation has been made.
| bool openstudio::model::LayeredConstruction::isSymmetric | ( | ) | const |
Returns true if this is a symmetric layered construction.
| std::vector<Material> openstudio::model::LayeredConstruction::layers | ( | ) | const |
Returns the material layers that make up this construction.
Listed in order from outside in, that is, the Material at index 0 faces out from the point of view of the Zone, should this LayeredConstruction be associated with a PlanarSurface.
|
static |
Returns true if materials defines a valid EnergyPlus construction.
Returns false if layers are empty. Checks the following rules if first layer is an OpaqueMaterial:
Checks the following rules if first layer is a FenestrationMaterial:
Checks the following rules if first layer is a ModelPartitionMaterial:
|
static |
|
static |
| std::vector<unsigned> openstudio::model::LayeredConstruction::nullLayers | ( | ) | const |
Returns layer indices that do not actually point to a Material.
Before simulation, the returned vector should be empty.
| unsigned openstudio::model::LayeredConstruction::numLayers | ( | ) | const |
Returns the number of non-null layers in this construction.
| void openstudio::model::LayeredConstruction::resetInsulation | ( | ) |
Removes any existing insulation layer designations.
Does not touch the actual composition of the construction.
| bool openstudio::model::LayeredConstruction::reverseEqualLayers | ( | const LayeredConstruction & | other | ) | const |
Returns true if this construction has the same layers but in reverse order as other one.
| bool openstudio::model::LayeredConstruction::setInsulation | ( | const OpaqueMaterial & | insulationLayer | ) |
Notes that insulationLayer is the perturbable insulation layer.
Only works if insulationLayer is already in this construction.
| bool openstudio::model::LayeredConstruction::setLayer | ( | unsigned | layerIndex, |
| const Material & | material | ||
| ) |
Set the layer at layerIndex to opaqueMaterial, if possible.
Must have 0 <= layerIndex < numLayers, and this construction must satisfy isOpaque == true. Furthermore, the resulting construction must satisfy layersAreValid.
| bool openstudio::model::LayeredConstruction::setLayer | ( | const ModelPartitionMaterial & | modelPartitionMaterial | ) |
Sets the construction to use modelPartitionMaterial.
Clears out all previous Material layers.
| bool openstudio::model::LayeredConstruction::setLayers | ( | const std::vector< Material > & | materials | ) |
Set the construction to use opaqueMaterials as its layers, if layersAreValid(opaqueMaterials).
Clears out all previous Material layers.
|
related |
|
related |