|
boost::optional
< DaylightingDeviceLightWell > | addDaylightingDeviceLightWell () const |
| | Add a new daylighting light well associated with this sub surface. More...
|
| |
boost::optional
< DaylightingDeviceShelf > | addDaylightingDeviceShelf () const |
| | Add a new daylighting light shelf associated with this sub surface. More...
|
| |
| boost::optional< ShadingSurface > | addOverhang (double depth, double offset) |
| | Add an overhang to the sub surface, only valid for fixed windows, operable windows, and glass doors. More...
|
| |
| boost::optional< ShadingSurface > | addOverhangByProjectionFactor (double projectionFactor, double offsetFraction) |
| | Add an overhang to the sub surface, only valid for fixed windows, operable windows, and glass doors. More...
|
| |
| boost::optional< SubSurface > | adjacentSubSurface () const |
| | get the adjacent subsurface More...
|
| |
boost::optional
< AirflowNetworkSurface > | airflowNetworkSurface () const |
| |
| bool | allowDaylightingDeviceLightWell () const |
| | Returns true if this sub surface allows the addition of a daylighting light light well. More...
|
| |
| bool | allowDaylightingDeviceShelf () const |
| | Returns true if this sub surface allows the addition of a daylighting light shelf. More...
|
| |
| bool | allowDaylightingDeviceTubularDiffuser () const |
| | Returns true if this sub surface allows the addition of a daylighting light tubular diffuser. More...
|
| |
| bool | allowDaylightingDeviceTubularDome () const |
| | Returns true if this sub surface allows the addition of a daylighting light tubular dome. More...
|
| |
| void | assignDefaultSubSurfaceType () |
| | Assign default sub surface type based on vertices. More...
|
| |
boost::optional
< DaylightingDeviceLightWell > | daylightingDeviceLightWell () const |
| | Get the daylighting light light well associated with this sub surface if there is one. More...
|
| |
boost::optional
< DaylightingDeviceShelf > | daylightingDeviceShelf () const |
| | Get the daylighting light shelf associated with this sub surface if there is one. More...
|
| |
boost::optional
< DaylightingDeviceTubular > | daylightingDeviceTubular () const |
| | Get the daylighting light tubular associated with this sub surface if there is one. More...
|
| |
| double | dividerArea () const |
| |
| double | frameArea () const |
| |
| 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) |
| |
| std::string | outsideBoundaryCondition () const |
| | Return the surface()'s outsideBoundaryCondition, or an empty string. More...
|
| |
| void | resetAdjacentSubSurface () |
| | reset the adjacent subsurface, will clear references on both this and adjacent sub surface More...
|
| |
| void | resetSurfacePropertyOtherSideCoefficients () |
| | Resets the SurfacePropertyOtherSideCoefficients. More...
|
| |
| void | resetSurfacePropertyOtherSideConditionsModel () |
| | Resets the SurfacePropertyOtherSideConditionsModel. More...
|
| |
| double | roughOpeningArea () const |
| |
| std::vector< Point3d > | roughOpeningVertices () const |
| |
| bool | setAdjacentSubSurface (SubSurface &subSurface) |
| | set the adjacent subsurface, will fail unless both sub surfaces are parented by surfaces which are adjacent More...
|
| |
| bool | setSurface (const Surface &surface) |
| | set the surface More...
|
| |
| bool | setSurfacePropertyOtherSideCoefficients (const SurfacePropertyOtherSideCoefficients &otherSideCoefficients) |
| | Sets the SurfacePropertyOtherSideCoefficients. More...
|
| |
| bool | setSurfacePropertyOtherSideConditionsModel (const SurfacePropertyOtherSideConditionsModel &otherSideModel) |
| | Sets the SurfacePropertyOtherSideConditionsModel. More...
|
| |
| std::vector< ShadingSurfaceGroup > | shadingSurfaceGroups () const |
| | Returns any shading surface groups associated with this sub surface. More...
|
| |
| boost::optional< Surface > | surface () const |
| | get the surface More...
|
| |
boost::optional
< SurfacePropertyConvectionCoefficients > | surfacePropertyConvectionCoefficients () const |
| | Returns the SurfacePropertyConvectionCoefficients, if it exists. More...
|
| |
boost::optional
< SurfacePropertyIncidentSolarMultiplier > | surfacePropertyIncidentSolarMultiplier () const |
| | Return the SurfacePropertyIncidentSolarMultiplier that points to this surface if any. More...
|
| |
boost::optional
< SurfacePropertyLocalEnvironment > | surfacePropertyLocalEnvironment () const |
| | Returns the SurfacePropertyLocalEnvironment, if it exists. More...
|
| |
boost::optional
< SurfacePropertyOtherSideCoefficients > | surfacePropertyOtherSideCoefficients () const |
| | Returns the adjacent SurfaceSurfacePropertyOtherSideCoefficients, if it exists. More...
|
| |
boost::optional
< SurfacePropertyOtherSideConditionsModel > | surfacePropertyOtherSideConditionsModel () const |
| | Returns the adjacent SurfacePropertyOtherSideConditionsModel, if it exists. More...
|
| |
|
| | SubSurface (const std::vector< Point3d > &vertices, const Model &model) |
| |
| virtual | ~SubSurface () override=default |
| |
| | SubSurface (const SubSurface &other)=default |
| |
| | SubSurface (SubSurface &&other)=default |
| |
| SubSurface & | operator= (const SubSurface &)=default |
| |
| SubSurface & | operator= (SubSurface &&)=default |
| |
|
| 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
< ShadingControl > | shadingControl () const |
| |
| std::vector< ShadingControl > | shadingControls () const |
| |
| unsigned int | numberofShadingControls () const |
| |
| bool | allowWindowPropertyFrameAndDivider () const |
| |
boost::optional
< WindowPropertyFrameAndDivider > | windowPropertyFrameAndDivider () 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 |
| |
|
| 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 () |
| |
| double | azimuth () const |
| | Returns the surface's azimuth measured clockwise as angle between outward normal and local North (radians). More...
|
| |
| Point3d | centroid () const |
| | Return the centroid of this planar surface's vertices. More...
|
| |
| bool | equalVertices (const PlanarSurface &other) const |
| | Check if this planar surface's vertices are equal to the other's in the building coordinate system. More...
|
| |
| boost::optional< double > | exteriorVisibleAbsorptance () const |
| | Returns exterior visible absorptance (unitless), if available. More...
|
| |
std::vector
< GeneratorPhotovoltaic > | generatorPhotovoltaics () const |
| | Returns any generator photovoltaics associated with this surface. More...
|
| |
| double | grossArea () const |
| | Computes the surface's gross area (m^2). More...
|
| |
| boost::optional< double > | heatCapacity () const |
| |
| boost::optional< double > | interiorVisibleAbsorptance () const |
| |
| bool | isAirWall () const |
| | Checks if this surface is an air wall, returns true if it's a ConstructionAirBoundary. More...
|
| |
| bool | isConvex () const |
| |
| double | netArea () const |
| | Computes the surface's net area (m^2). More...
|
| |
| Vector3d | outwardNormal () const |
| | Returns the outward normal vector in local coordinates. More...
|
| |
| Plane | plane () const |
| | Get the plane, throws openstudio::Exception if cannot compute plane for this surface. More...
|
| |
| 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. More...
|
| |
| bool | setThermalConductance (double value) |
| |
| bool | setUFactor (double value) |
| | Sets the u-factor of this surface in W/m^2*K, if possible. More...
|
| |
| std::vector< ModelObject > | solarCollectors () const |
| | Returns any solar hot water collectors associated with this surface. More...
|
| |
| 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. More...
|
| |
std::vector
< SurfacePropertyConvectionCoefficients > | surfacePropertyConvectionCoefficients () const |
| | Returns any SurfacePropertyConvectionCoefficients associated with this surface, does not return SurfacePropertyConvectionCoefficientsMultipleSurface. More...
|
| |
| boost::optional< double > | thermalConductance () const |
| |
| double | tilt () const |
| | Returns the surface's tilt measured as angle between outward normal and local up (radians). More...
|
| |
virtual std::vector
< std::vector< Point3d > > | triangulation () const |
| | Get a triangulation of this surface, subsurfaces will be replaced by holes in the triangulation. More...
|
| |
| boost::optional< double > | uFactor () const |
| |
| boost::optional< double > | visibleTransmittance () const |
| | Returns visible transmittance (unitless), if available. More...
|
| |
| boost::optional< ConstructionBase > | construction () const |
| | Returns the construction object. More...
|
| |
boost::optional< std::pair
< ConstructionBase, int > > | constructionWithSearchDistance () const |
| | Returns the construction object and the search distance that was needed to find the construction. More...
|
| |
| bool | isConstructionDefaulted () const |
| | Returns true if the construction is not directly referenced by this surface . More...
|
| |
boost::optional
< PlanarSurfaceGroup > | planarSurfaceGroup () const |
| | Returns the containing PlanarSurfaceGroup if available. More...
|
| |
| boost::optional< Space > | space () const |
| | Returns the containing Space if available. More...
|
| |
| std::vector< Point3d > | vertices () const |
| | Returns the vertices. More...
|
| |
| bool | setVertices (const std::vector< Point3d > &vertices) |
| | Sets the vertices. More...
|
| |
| bool | setConstruction (const ConstructionBase &construction) |
| | Sets the construction object. More...
|
| |
| void | resetConstruction () |
| | Resets the construction object. More...
|
| |
| virtual | ~PlanarSurface () override=default |
| |
| | PlanarSurface (const PlanarSurface &other)=default |
| |
| | PlanarSurface (PlanarSurface &&other)=default |
| |
| PlanarSurface & | operator= (const PlanarSurface &)=default |
| |
| PlanarSurface & | operator= (PlanarSurface &&)=default |
| |
| 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...
|
| |
| ParentObject & | operator= (const ParentObject &)=default |
| |
| ParentObject & | operator= (ParentObject &&)=default |
| |
| | ParentObject (const ParentObject &other)=default |
| |
| | ParentObject (ParentObject &&other)=default |
| |
| virtual | ~ParentObject () override=default |
| |
| virtual | ~ModelObject () override=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 |
| |
| 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) |
| |
| WorkspaceObject & | operator= (WorkspaceObject &&)=default |
| |
| WorkspaceObject & | operator= (const WorkspaceObject &)=default |
| |
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 |
| |
| | WorkspaceObject (const WorkspaceObject &other)=default |
| |
| | WorkspaceObject (WorkspaceObject &&other)=default |
| |
| virtual | ~WorkspaceObject () override=default |
| |
| 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 |
| |
| 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 |
| |
| 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 |
| |
| Handle | handle () const |
| |
| IddObject | iddObject () const |
| |
| | IdfObject (IddObjectType type, bool fastName=false) |
| |
| | IdfObject (const IdfObject &other) |
| |
| | IdfObject (const IddObject &, bool fastName=false) |
| |
| | IdfObject (IdfObject &&other) noexcept |
| |
| 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, bool checkNames=false) 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) |
| |
| IdfObject & | operator= (IdfObject &&other) noexcept |
| |
| IdfObject & | operator= (const IdfObject &other) |
| |
| 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 (const std::vector< std::string > &values) |
| |
| IdfExtensibleGroup | pushExtensibleGroup () |
| |
| 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=false) const |
| |
| virtual | ~IdfObject ()=default |
| |
Inheritance diagram for openstudio::model::SubSurface: