OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | Related Functions | List of all members
openstudio::model::ConstructionBase Class Reference

#include <ConstructionBase.hpp>

+ Inheritance diagram for openstudio::model::ConstructionBase:

Public Member Functions

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 > 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< RenderingColorrenderingColor () 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< ModelObjectchildren () 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< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () 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< OutputVariableoutputVariables () 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< LifeCycleCostlifeCycleCosts () 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< ScheduleTypeKeygetScheduleTypeKeys (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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< ConstructionBase
ConstructionBaseVector
 
typedef boost::optional
< ConstructionBase
OptionalConstructionBase
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_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)
 

Detailed Description

ConstructionBase is a ResourceObject that serves as a base class for several objects that can be used to specify a construction for a PlanarSurface.

Constructor & Destructor Documentation

virtual openstudio::model::ConstructionBase::~ConstructionBase ( )
inlinevirtual

Member Function Documentation

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).

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 .

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).

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).

Friends And Related Function Documentation

typedef std::vector<ConstructionBase> ConstructionBaseVector
related
typedef boost::optional<ConstructionBase> OptionalConstructionBase
related