OpenStudio:model
Loading...
Searching...
No Matches
openstudio::model::SubSurface Class Reference

#include <SubSurface.hpp>

+ Inheritance diagram for openstudio::model::SubSurface:

Public Member Functions

Constructors and Destructors
 SubSurface (const std::vector< Point3d > &vertices, const Model &model)
 
virtual ~SubSurface () override=default
 
 SubSurface (const SubSurface &other)=default
 
 SubSurface (SubSurface &&other)=default
 
SubSurfaceoperator= (const SubSurface &)=default
 
SubSurfaceoperator= (SubSurface &&)=default
 
Getters
std::string subSurfaceType () const
 
bool isSubSurfaceTypeDefaulted () const
 
boost::optional< double > viewFactortoGround () const
 
bool isViewFactortoGroundDefaulted () const
 
bool isViewFactortoGroundAutocalculated () const
 
bool allowShadingControl () const
 
OS_DEPRECATED boost::optional< ShadingControlshadingControl () const
 
std::vector< ShadingControlshadingControls () const
 
unsigned int numberofShadingControls () const
 
bool allowWindowPropertyFrameAndDivider () const
 
boost::optional< WindowPropertyFrameAndDividerwindowPropertyFrameAndDivider () const
 
double multiplier () const
 
bool isMultiplierDefaulted () const
 
boost::optional< double > numberofVertices () const
 
bool isNumberofVerticesDefaulted () const
 
bool isNumberofVerticesAutocalculated () const
 
boost::optional< double > assemblyUFactor () const
 
boost::optional< double > assemblySHGC () const
 
boost::optional< double > assemblyVisibleTransmittance () const
 
Setters
bool setSubSurfaceType (const std::string &subSurfaceType)
 
void resetSubSurfaceType ()
 
bool setViewFactortoGround (boost::optional< double > viewFactortoGround)
 
bool setViewFactortoGround (double viewFactortoGround)
 
void resetViewFactortoGround ()
 
void autocalculateViewFactortoGround ()
 
OS_DEPRECATED bool setShadingControl (const ShadingControl &shadingControl)
 
OS_DEPRECATED void resetShadingControl ()
 
bool addShadingControl (ShadingControl &shadingControl)
 
bool addShadingControls (std::vector< ShadingControl > &shadingControls)
 
void removeShadingControl (ShadingControl &shadingControl)
 
void removeAllShadingControls ()
 
bool setWindowPropertyFrameAndDivider (const WindowPropertyFrameAndDivider &windowPropertyFrameAndDivider)
 
void resetWindowPropertyFrameAndDivider ()
 
bool setMultiplier (double multiplier)
 
void resetMultiplier ()
 
bool setNumberofVertices (boost::optional< double > numberofVertices)
 
bool setNumberofVertices (double numberofVertices)
 
void resetNumberofVertices ()
 
void autocalculateNumberofVertices ()
 
boost::optional< Surfacesurface () const
 get the surface
 
bool setSurface (const Surface &surface)
 set the surface
 
boost::optional< SubSurfaceadjacentSubSurface () const
 get the adjacent subsurface
 
bool setAdjacentSubSurface (SubSurface &subSurface)
 set the adjacent subsurface, will fail unless both sub surfaces are parented by surfaces which are adjacent
 
void resetAdjacentSubSurface ()
 reset the adjacent subsurface, will clear references on both this and adjacent sub surface
 
boost::optional< SurfacePropertyConvectionCoefficientssurfacePropertyConvectionCoefficients () const
 Returns the SurfacePropertyConvectionCoefficients, if it exists.
 
boost::optional< SurfacePropertyLocalEnvironmentsurfacePropertyLocalEnvironment () const
 Returns the SurfacePropertyLocalEnvironment, if it exists.
 
boost::optional< SurfacePropertyIncidentSolarMultipliersurfacePropertyIncidentSolarMultiplier () const
 Return the SurfacePropertyIncidentSolarMultiplier that points to this surface if any.
 
boost::optional< SurfacePropertyOtherSideCoefficientssurfacePropertyOtherSideCoefficients () const
 Returns the adjacent SurfaceSurfacePropertyOtherSideCoefficients, if it exists.
 
bool setSurfacePropertyOtherSideCoefficients (const SurfacePropertyOtherSideCoefficients &otherSideCoefficients)
 Sets the SurfacePropertyOtherSideCoefficients.
 
void resetSurfacePropertyOtherSideCoefficients ()
 Resets the SurfacePropertyOtherSideCoefficients.
 
boost::optional< SurfacePropertyOtherSideConditionsModelsurfacePropertyOtherSideConditionsModel () const
 Returns the adjacent SurfacePropertyOtherSideConditionsModel, if it exists.
 
bool setSurfacePropertyOtherSideConditionsModel (const SurfacePropertyOtherSideConditionsModel &otherSideModel)
 Sets the SurfacePropertyOtherSideConditionsModel.
 
void resetSurfacePropertyOtherSideConditionsModel ()
 Resets the SurfacePropertyOtherSideConditionsModel.
 
void assignDefaultSubSurfaceType ()
 Assign default sub surface type based on vertices.
 
std::string outsideBoundaryCondition () const
 Return the surface()'s outsideBoundaryCondition, or an empty string.
 
boost::optional< ShadingSurfaceaddOverhang (double depth, double offset)
 Add an overhang to the sub surface, only valid for fixed windows, operable windows, and glass doors.
 
boost::optional< ShadingSurfaceaddOverhangByProjectionFactor (double projectionFactor, double offsetFraction)
 Add an overhang to the sub surface, only valid for fixed windows, operable windows, and glass doors.
 
std::vector< ShadingSurfaceGroupshadingSurfaceGroups () const
 Returns any shading surface groups associated with this sub surface.
 
bool allowDaylightingDeviceShelf () const
 Returns true if this sub surface allows the addition of a daylighting light shelf.
 
boost::optional< DaylightingDeviceShelfdaylightingDeviceShelf () const
 Get the daylighting light shelf associated with this sub surface if there is one.
 
boost::optional< DaylightingDeviceShelfaddDaylightingDeviceShelf () const
 Add a new daylighting light shelf associated with this sub surface.
 
bool allowDaylightingDeviceTubularDome () const
 Returns true if this sub surface allows the addition of a daylighting light tubular dome.
 
bool allowDaylightingDeviceTubularDiffuser () const
 Returns true if this sub surface allows the addition of a daylighting light tubular diffuser.
 
boost::optional< DaylightingDeviceTubulardaylightingDeviceTubular () const
 Get the daylighting light tubular associated with this sub surface if there is one.
 
bool allowDaylightingDeviceLightWell () const
 Returns true if this sub surface allows the addition of a daylighting light light well.
 
boost::optional< DaylightingDeviceLightWelldaylightingDeviceLightWell () const
 Get the daylighting light light well associated with this sub surface if there is one.
 
boost::optional< DaylightingDeviceLightWelladdDaylightingDeviceLightWell () const
 Add a new daylighting light well associated with this sub surface.
 
AirflowNetworkSurface getAirflowNetworkSurface (const AirflowNetworkDetailedOpening &surfaceAirflowLeakage)
 
AirflowNetworkSurface getAirflowNetworkSurface (const AirflowNetworkSimpleOpening &surfaceAirflowLeakage)
 
AirflowNetworkSurface getAirflowNetworkSurface (const AirflowNetworkCrack &surfaceAirflowLeakage)
 
AirflowNetworkSurface getAirflowNetworkSurface (const AirflowNetworkEffectiveLeakageArea &surfaceAirflowLeakage)
 
AirflowNetworkSurface getAirflowNetworkSurface (const AirflowNetworkHorizontalOpening &surfaceAirflowLeakage)
 
AirflowNetworkSurface getAirflowNetworkSurface (const AirflowNetworkSpecifiedFlowRate &surfaceAirflowLeakage)
 
boost::optional< AirflowNetworkSurfaceairflowNetworkSurface () const
 
double roughOpeningArea () const
 
std::vector< Point3droughOpeningVertices () const
 
double frameArea () const
 
double dividerArea () const
 
- Public Member Functions inherited from openstudio::model::PlanarSurface
boost::optional< ConstructionBaseconstruction () const
 Returns the construction object.
 
boost::optional< std::pair< ConstructionBase, int > > constructionWithSearchDistance () const
 Returns the construction object and the search distance that was needed to find the construction.
 
bool isConstructionDefaulted () const
 Returns true if the construction is not directly referenced by this surface .
 
boost::optional< PlanarSurfaceGroupplanarSurfaceGroup () const
 Returns the containing PlanarSurfaceGroup if available.
 
boost::optional< Spacespace () const
 Returns the containing Space if available.
 
std::vector< Point3dvertices () const
 Returns the vertices.
 
virtual ~PlanarSurface () override=default
 
 PlanarSurface (const PlanarSurface &other)=default
 
 PlanarSurface (PlanarSurface &&other)=default
 
PlanarSurfaceoperator= (const PlanarSurface &)=default
 
PlanarSurfaceoperator= (PlanarSurface &&)=default
 
bool setVertices (const std::vector< Point3d > &vertices)
 Sets the vertices.
 
bool setConstruction (const ConstructionBase &construction)
 Sets the construction object.
 
void resetConstruction ()
 Resets the construction object.
 
bool isAirWall () const
 Checks if this surface is an air wall, returns true if it's a ConstructionAirBoundary.
 
double grossArea () const
 Computes the surface's gross area (m^2).
 
bool subtractFromGrossArea () const
 Reports if user should subtract this surface's net area from parent's gross area to compute parent's net area (e.g.
 
double netArea () const
 Computes the surface's net area (m^2).
 
Vector3d outwardNormal () const
 Returns the outward normal vector in local coordinates.
 
double tilt () const
 Returns the surface's tilt measured as angle between outward normal and local up (radians).
 
double azimuth () const
 Returns the surface's azimuth measured clockwise as angle between outward normal and local North (radians).
 
boost::optional< double > uFactor () const
 
bool setUFactor (double value)
 Sets the u-factor of this surface in W/m^2*K, if possible.
 
boost::optional< double > thermalConductance () const
 
bool setThermalConductance (double value)
 
boost::optional< double > heatCapacity () const
 
boost::optional< double > interiorVisibleAbsorptance () const
 
boost::optional< double > exteriorVisibleAbsorptance () const
 Returns exterior visible absorptance (unitless), if available.
 
boost::optional< double > visibleTransmittance () const
 Returns visible transmittance (unitless), if available.
 
bool equalVertices (const PlanarSurface &other) const
 Check if this planar surface's vertices are equal to the other's in the building coordinate system.
 
bool reverseEqualVertices (const PlanarSurface &other) const
 Check if this planar surface's vertices are reverse equal to the other's in the building coordinate system.
 
Plane plane () const
 Get the plane, throws openstudio::Exception if cannot compute plane for this surface.
 
virtual std::vector< std::vector< Point3d > > triangulation () const
 Get a triangulation of this surface, subsurfaces will be replaced by holes in the triangulation.
 
Point3d centroid () const
 Return the centroid of this planar surface's vertices.
 
std::vector< ModelObjectsolarCollectors () const
 Returns any solar hot water collectors associated with this surface.
 
std::vector< GeneratorPhotovoltaicgeneratorPhotovoltaics () const
 Returns any generator photovoltaics associated with this surface.
 
std::vector< SurfacePropertyConvectionCoefficientssurfacePropertyConvectionCoefficients () const
 Returns any SurfacePropertyConvectionCoefficients associated with this surface, does not return SurfacePropertyConvectionCoefficientsMultipleSurface.
 
bool isConvex () const
 
- Public Member Functions inherited from openstudio::model::ParentObject
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject () override=default
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model.
 
std::vector< IddObjectTypeallowableChildTypes () const
 Returns a vector of allowable children types.
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject () override=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (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< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one.
 
std::vector< ResourceObjectresources () 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< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data.
 
boost::optional< openstudio::TimeSeriesgetData (const OutputVariable &variable, const std::string &envPeriod) const
 Get data associated with this output variable and this object.
 
std::vector< LifeCycleCostlifeCycleCosts () const
 Returns the list of all LifeCycleCosts that refer to this object.
 
std::vector< IdfObjectremoveLifeCycleCosts ()
 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< IdfObjectremoveAdditionalProperties ()
 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< ScheduleTypeKeygetScheduleTypeKeys (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< EMSActuatorNamesemsActuatorNames () 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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 
- Public Member Functions inherited from openstudio::WorkspaceObject
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< WorkspaceObjectgetSources (IddObjectType type) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
boost::optional< WorkspaceObjectgetTarget (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)
 
WorkspaceObjectoperator= (const WorkspaceObject &)=default
 
WorkspaceObjectoperator= (const WorkspaceObject &)=default
 
WorkspaceObjectoperator= (WorkspaceObject &&)=default
 
WorkspaceObjectoperator= (WorkspaceObject &&)=default
 
std::vector< openstudio::IdfObjectremove ()
 
std::vector< openstudio::IdfObjectremove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
std::vector< WorkspaceObjecttargets () 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
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
std::string briefDescription () const
 
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< IdfExtensibleGroupextensibleGroups () const
 
std::vector< IdfExtensibleGroupextensibleGroups () 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)
 
IdfObjectoperator= (const IdfObject &other)
 
IdfObjectoperator= (const IdfObject &other)
 
IdfObjectoperator= (IdfObject &&other) noexcept
 
IdfObjectoperator= (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
 

Static Public Member Functions

Static Methods
static IddObjectType iddObjectType ()
 
static std::vector< std::string > validSubSurfaceTypeValues ()
 
- Static Public Member Functions inherited from openstudio::model::PlanarSurface
static std::vector< PlanarSurfacefindPlanarSurfaces (const std::vector< PlanarSurface > &planarSurfaces, boost::optional< double > minDegreesFromNorth, boost::optional< double > maxDegreesFromNorth, boost::optional< double > minDegreesTilt, boost::optional< double > maxDegreesTilt, double tol=1)
 Find PlanarSurfaces within angular range, specified in degrees in the site coordinate system, an unset optional means no limit.
 
static double filmResistance (const FilmResistanceType &type)
 Film resistances from ASHRAE Fundamentals, Chapter 25, Table 1 for non-reflective surfaces.
 
static double stillAirFilmResistance (double tilt)
 Film resistance of still air on surface with tilt (rad).
 
- Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObjectload (const std::string &text)
 
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
 
static int printedFieldSpace ()
 

Related Symbols

(Note that these are not member symbols.)

using OptionalSubSurface = boost::optional<SubSurface>
 
using SubSurfaceVector = std::vector<SubSurface>
 

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional< WorkspaceObjectOptionalWorkspaceObject
 
typedef std::vector< WorkspaceObjectWorkspaceObjectVector
 
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject, IdfObjectIdfObjectPair
 
typedef std::vector< IdfObjectIdfObjectVector
 
typedef boost::optional< IdfObjectOptionalIdfObject
 
- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- 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::PlanarSurface
 PlanarSurface (IddObjectType type, const std::vector< Point3d > &vertices, const Model &model)
 Constructs a new PlanarSurface object in the model.
 
- Protected Member Functions inherited from openstudio::model::ParentObject
 ParentObject (IddObjectType type, const Model &model)
 Constructs a new ParentObject object in the model.
 
- 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)
 

Detailed Description

SubSurface is a PlanarSurface that wraps the OpenStudio IDD object 'OS_SubSurface'.

Constructor & Destructor Documentation

◆ SubSurface() [1/3]

openstudio::model::SubSurface::SubSurface ( const std::vector< Point3d > & vertices,
const Model & model )
explicit

◆ ~SubSurface()

virtual openstudio::model::SubSurface::~SubSurface ( )
overridevirtualdefault

◆ SubSurface() [2/3]

openstudio::model::SubSurface::SubSurface ( const SubSurface & other)
default

◆ SubSurface() [3/3]

openstudio::model::SubSurface::SubSurface ( SubSurface && other)
default

Member Function Documentation

◆ addDaylightingDeviceLightWell()

boost::optional< DaylightingDeviceLightWell > openstudio::model::SubSurface::addDaylightingDeviceLightWell ( ) const

Add a new daylighting light well associated with this sub surface.

Only succeeds if this is a fixed window, operable window, or glass door. Will return existing daylighting light well if there already is one.

◆ addDaylightingDeviceShelf()

boost::optional< DaylightingDeviceShelf > openstudio::model::SubSurface::addDaylightingDeviceShelf ( ) const

Add a new daylighting light shelf associated with this sub surface.

Only succeeds if this is a fixed window, operable window, or glass door. Will return existing daylighting light shelf if there already is one.

◆ addOverhang()

boost::optional< ShadingSurface > openstudio::model::SubSurface::addOverhang ( double depth,
double offset )

Add an overhang to the sub surface, only valid for fixed windows, operable windows, and glass doors.

◆ addOverhangByProjectionFactor()

boost::optional< ShadingSurface > openstudio::model::SubSurface::addOverhangByProjectionFactor ( double projectionFactor,
double offsetFraction )

Add an overhang to the sub surface, only valid for fixed windows, operable windows, and glass doors.

Offset is a fraction of the total window height, projection factor is based on height and offset.

◆ addShadingControl()

bool openstudio::model::SubSurface::addShadingControl ( ShadingControl & shadingControl)

◆ addShadingControls()

bool openstudio::model::SubSurface::addShadingControls ( std::vector< ShadingControl > & shadingControls)

◆ adjacentSubSurface()

boost::optional< SubSurface > openstudio::model::SubSurface::adjacentSubSurface ( ) const

get the adjacent subsurface

◆ airflowNetworkSurface()

boost::optional< AirflowNetworkSurface > openstudio::model::SubSurface::airflowNetworkSurface ( ) const

◆ allowDaylightingDeviceLightWell()

bool openstudio::model::SubSurface::allowDaylightingDeviceLightWell ( ) const

Returns true if this sub surface allows the addition of a daylighting light light well.

◆ allowDaylightingDeviceShelf()

bool openstudio::model::SubSurface::allowDaylightingDeviceShelf ( ) const

Returns true if this sub surface allows the addition of a daylighting light shelf.

◆ allowDaylightingDeviceTubularDiffuser()

bool openstudio::model::SubSurface::allowDaylightingDeviceTubularDiffuser ( ) const

Returns true if this sub surface allows the addition of a daylighting light tubular diffuser.

◆ allowDaylightingDeviceTubularDome()

bool openstudio::model::SubSurface::allowDaylightingDeviceTubularDome ( ) const

Returns true if this sub surface allows the addition of a daylighting light tubular dome.

◆ allowShadingControl()

bool openstudio::model::SubSurface::allowShadingControl ( ) const

◆ allowWindowPropertyFrameAndDivider()

bool openstudio::model::SubSurface::allowWindowPropertyFrameAndDivider ( ) const

◆ assemblySHGC()

boost::optional< double > openstudio::model::SubSurface::assemblySHGC ( ) const

◆ assemblyUFactor()

boost::optional< double > openstudio::model::SubSurface::assemblyUFactor ( ) const

◆ assemblyVisibleTransmittance()

boost::optional< double > openstudio::model::SubSurface::assemblyVisibleTransmittance ( ) const

◆ assignDefaultSubSurfaceType()

void openstudio::model::SubSurface::assignDefaultSubSurfaceType ( )

Assign default sub surface type based on vertices.

◆ autocalculateNumberofVertices()

void openstudio::model::SubSurface::autocalculateNumberofVertices ( )

◆ autocalculateViewFactortoGround()

void openstudio::model::SubSurface::autocalculateViewFactortoGround ( )

◆ daylightingDeviceLightWell()

boost::optional< DaylightingDeviceLightWell > openstudio::model::SubSurface::daylightingDeviceLightWell ( ) const

Get the daylighting light light well associated with this sub surface if there is one.

◆ daylightingDeviceShelf()

boost::optional< DaylightingDeviceShelf > openstudio::model::SubSurface::daylightingDeviceShelf ( ) const

Get the daylighting light shelf associated with this sub surface if there is one.

◆ daylightingDeviceTubular()

boost::optional< DaylightingDeviceTubular > openstudio::model::SubSurface::daylightingDeviceTubular ( ) const

Get the daylighting light tubular associated with this sub surface if there is one.

◆ dividerArea()

double openstudio::model::SubSurface::dividerArea ( ) const

◆ frameArea()

double openstudio::model::SubSurface::frameArea ( ) const

◆ getAirflowNetworkSurface() [1/6]

AirflowNetworkSurface openstudio::model::SubSurface::getAirflowNetworkSurface ( const AirflowNetworkCrack & surfaceAirflowLeakage)

◆ getAirflowNetworkSurface() [2/6]

AirflowNetworkSurface openstudio::model::SubSurface::getAirflowNetworkSurface ( const AirflowNetworkDetailedOpening & surfaceAirflowLeakage)

◆ getAirflowNetworkSurface() [3/6]

AirflowNetworkSurface openstudio::model::SubSurface::getAirflowNetworkSurface ( const AirflowNetworkEffectiveLeakageArea & surfaceAirflowLeakage)

◆ getAirflowNetworkSurface() [4/6]

AirflowNetworkSurface openstudio::model::SubSurface::getAirflowNetworkSurface ( const AirflowNetworkHorizontalOpening & surfaceAirflowLeakage)

◆ getAirflowNetworkSurface() [5/6]

AirflowNetworkSurface openstudio::model::SubSurface::getAirflowNetworkSurface ( const AirflowNetworkSimpleOpening & surfaceAirflowLeakage)

◆ getAirflowNetworkSurface() [6/6]

AirflowNetworkSurface openstudio::model::SubSurface::getAirflowNetworkSurface ( const AirflowNetworkSpecifiedFlowRate & surfaceAirflowLeakage)

◆ iddObjectType()

static IddObjectType openstudio::model::SubSurface::iddObjectType ( )
static

◆ isMultiplierDefaulted()

bool openstudio::model::SubSurface::isMultiplierDefaulted ( ) const

◆ isNumberofVerticesAutocalculated()

bool openstudio::model::SubSurface::isNumberofVerticesAutocalculated ( ) const

◆ isNumberofVerticesDefaulted()

bool openstudio::model::SubSurface::isNumberofVerticesDefaulted ( ) const

◆ isSubSurfaceTypeDefaulted()

bool openstudio::model::SubSurface::isSubSurfaceTypeDefaulted ( ) const

◆ isViewFactortoGroundAutocalculated()

bool openstudio::model::SubSurface::isViewFactortoGroundAutocalculated ( ) const

◆ isViewFactortoGroundDefaulted()

bool openstudio::model::SubSurface::isViewFactortoGroundDefaulted ( ) const

◆ multiplier()

double openstudio::model::SubSurface::multiplier ( ) const

◆ numberofShadingControls()

unsigned int openstudio::model::SubSurface::numberofShadingControls ( ) const

◆ numberofVertices()

boost::optional< double > openstudio::model::SubSurface::numberofVertices ( ) const

◆ operator=() [1/2]

SubSurface & openstudio::model::SubSurface::operator= ( const SubSurface & )
default

◆ operator=() [2/2]

SubSurface & openstudio::model::SubSurface::operator= ( SubSurface && )
default

◆ outsideBoundaryCondition()

std::string openstudio::model::SubSurface::outsideBoundaryCondition ( ) const

Return the surface()'s outsideBoundaryCondition, or an empty string.

◆ removeAllShadingControls()

void openstudio::model::SubSurface::removeAllShadingControls ( )

◆ removeShadingControl()

void openstudio::model::SubSurface::removeShadingControl ( ShadingControl & shadingControl)

◆ resetAdjacentSubSurface()

void openstudio::model::SubSurface::resetAdjacentSubSurface ( )

reset the adjacent subsurface, will clear references on both this and adjacent sub surface

◆ resetMultiplier()

void openstudio::model::SubSurface::resetMultiplier ( )

◆ resetNumberofVertices()

void openstudio::model::SubSurface::resetNumberofVertices ( )

◆ resetShadingControl()

OS_DEPRECATED void openstudio::model::SubSurface::resetShadingControl ( )

◆ resetSubSurfaceType()

void openstudio::model::SubSurface::resetSubSurfaceType ( )

◆ resetSurfacePropertyOtherSideCoefficients()

void openstudio::model::SubSurface::resetSurfacePropertyOtherSideCoefficients ( )

◆ resetSurfacePropertyOtherSideConditionsModel()

void openstudio::model::SubSurface::resetSurfacePropertyOtherSideConditionsModel ( )

◆ resetViewFactortoGround()

void openstudio::model::SubSurface::resetViewFactortoGround ( )

◆ resetWindowPropertyFrameAndDivider()

void openstudio::model::SubSurface::resetWindowPropertyFrameAndDivider ( )

◆ roughOpeningArea()

double openstudio::model::SubSurface::roughOpeningArea ( ) const

◆ roughOpeningVertices()

std::vector< Point3d > openstudio::model::SubSurface::roughOpeningVertices ( ) const

◆ setAdjacentSubSurface()

bool openstudio::model::SubSurface::setAdjacentSubSurface ( SubSurface & subSurface)

set the adjacent subsurface, will fail unless both sub surfaces are parented by surfaces which are adjacent

◆ setMultiplier()

bool openstudio::model::SubSurface::setMultiplier ( double multiplier)

◆ setNumberofVertices() [1/2]

bool openstudio::model::SubSurface::setNumberofVertices ( boost::optional< double > numberofVertices)

◆ setNumberofVertices() [2/2]

bool openstudio::model::SubSurface::setNumberofVertices ( double numberofVertices)

◆ setShadingControl()

OS_DEPRECATED bool openstudio::model::SubSurface::setShadingControl ( const ShadingControl & shadingControl)

◆ setSubSurfaceType()

bool openstudio::model::SubSurface::setSubSurfaceType ( const std::string & subSurfaceType)

◆ setSurface()

bool openstudio::model::SubSurface::setSurface ( const Surface & surface)

set the surface

◆ setSurfacePropertyOtherSideCoefficients()

bool openstudio::model::SubSurface::setSurfacePropertyOtherSideCoefficients ( const SurfacePropertyOtherSideCoefficients & otherSideCoefficients)

◆ setSurfacePropertyOtherSideConditionsModel()

bool openstudio::model::SubSurface::setSurfacePropertyOtherSideConditionsModel ( const SurfacePropertyOtherSideConditionsModel & otherSideModel)

◆ setViewFactortoGround() [1/2]

bool openstudio::model::SubSurface::setViewFactortoGround ( boost::optional< double > viewFactortoGround)

◆ setViewFactortoGround() [2/2]

bool openstudio::model::SubSurface::setViewFactortoGround ( double viewFactortoGround)

◆ setWindowPropertyFrameAndDivider()

bool openstudio::model::SubSurface::setWindowPropertyFrameAndDivider ( const WindowPropertyFrameAndDivider & windowPropertyFrameAndDivider)

◆ shadingControl()

OS_DEPRECATED boost::optional< ShadingControl > openstudio::model::SubSurface::shadingControl ( ) const

◆ shadingControls()

std::vector< ShadingControl > openstudio::model::SubSurface::shadingControls ( ) const

◆ shadingSurfaceGroups()

std::vector< ShadingSurfaceGroup > openstudio::model::SubSurface::shadingSurfaceGroups ( ) const

Returns any shading surface groups associated with this sub surface.

◆ subSurfaceType()

std::string openstudio::model::SubSurface::subSurfaceType ( ) const

◆ surface()

boost::optional< Surface > openstudio::model::SubSurface::surface ( ) const

get the surface

◆ surfacePropertyConvectionCoefficients()

boost::optional< SurfacePropertyConvectionCoefficients > openstudio::model::SubSurface::surfacePropertyConvectionCoefficients ( ) const

Returns the SurfacePropertyConvectionCoefficients, if it exists.

◆ surfacePropertyIncidentSolarMultiplier()

boost::optional< SurfacePropertyIncidentSolarMultiplier > openstudio::model::SubSurface::surfacePropertyIncidentSolarMultiplier ( ) const

Return the SurfacePropertyIncidentSolarMultiplier that points to this surface if any.

◆ surfacePropertyLocalEnvironment()

boost::optional< SurfacePropertyLocalEnvironment > openstudio::model::SubSurface::surfacePropertyLocalEnvironment ( ) const

Returns the SurfacePropertyLocalEnvironment, if it exists.

◆ surfacePropertyOtherSideCoefficients()

boost::optional< SurfacePropertyOtherSideCoefficients > openstudio::model::SubSurface::surfacePropertyOtherSideCoefficients ( ) const

Returns the adjacent SurfaceSurfacePropertyOtherSideCoefficients, if it exists.

◆ surfacePropertyOtherSideConditionsModel()

boost::optional< SurfacePropertyOtherSideConditionsModel > openstudio::model::SubSurface::surfacePropertyOtherSideConditionsModel ( ) const

Returns the adjacent SurfacePropertyOtherSideConditionsModel, if it exists.

◆ validSubSurfaceTypeValues()

static std::vector< std::string > openstudio::model::SubSurface::validSubSurfaceTypeValues ( )
static

◆ viewFactortoGround()

boost::optional< double > openstudio::model::SubSurface::viewFactortoGround ( ) const

◆ windowPropertyFrameAndDivider()

boost::optional< WindowPropertyFrameAndDivider > openstudio::model::SubSurface::windowPropertyFrameAndDivider ( ) const

Friends And Related Symbol Documentation

◆ OptionalSubSurface

using OptionalSubSurface = boost::optional<SubSurface>
related

◆ SubSurfaceVector

using SubSurfaceVector = std::vector<SubSurface>
related