 |
OpenStudio:model |
#include <ShadingControl.hpp>
Inheritance diagram for openstudio::model::ShadingControl:Public Member Functions | |
Constructors and Destructors | |
| ShadingControl (const Construction &construction) | |
| Create a ShadingControl object which references the passed in construction for the shaded state. More... | |
| ShadingControl (const ShadingMaterial &shadingMaterial) | |
| Create a ShadingControl object which references the passed in material for the shading layer. More... | |
| virtual | ~ShadingControl () |
Getters | |
| std::string | shadingType () const |
| boost::optional< Construction > | construction () const |
| boost::optional< ShadingMaterial > | shadingMaterial () const |
| std::string | shadingControlType () const |
| bool | isShadingControlTypeDefaulted () const |
| boost::optional< Schedule > | schedule () const |
| boost::optional< double > | setpoint () const |
| bool | isSetpointDefaulted () const |
| bool | glareControlIsActive () const |
| std::string | typeofSlatAngleControlforBlinds () const |
| bool | isTypeofSlatAngleControlforBlindsDefaulted () const |
| boost::optional< Schedule > | slatAngleSchedule () const |
| boost::optional< double > | setpoint2 () const |
| std::string | multipleSurfaceControlType () const |
Setters | |
| bool | setShadingType (const std::string &shadingType) |
| Sets the shading type field. More... | |
| bool | setShadingControlType (const std::string &shadingControlType) |
| void | resetShadingControlType () |
| bool | setSchedule (const Schedule &schedule) |
| void | resetSchedule () |
| bool | setSetpoint (double setpoint) |
| void | resetSetpoint () |
| bool | setGlareControlIsActive (bool glareControlIsActive) |
| void | resetGlareControlIsActive () |
| bool | setTypeofSlatAngleControlforBlinds (const std::string &typeofSlatAngleControlforBlinds) |
| void | resetTypeofSlatAngleControlforBlinds () |
| bool | setSlatAngleSchedule (const Schedule &slatAngleSchedule) |
| void | resetSlatAngleSchedule () |
| bool | setSetpoint2 (double setpoint2) |
| bool | setMultipleSurfaceControlType (const std::string &multipleSurfaceControlType) |
Other | |
| bool | isControlTypeValueNeedingSetpoint1 () |
| bool | isControlTypeValueNeedingSetpoint2 () |
| bool | isControlTypeValueAllowingSchedule () |
| bool | isControlTypeValueRequiringSchedule () |
| bool | isTypeValueAllowingSlatAngleControl () |
| std::vector< SubSurface > | subSurfaces () const |
| unsigned int | numberofSubSurfaces () const |
| boost::optional< unsigned > | subSurfaceIndex (const SubSurface &subSurface) const |
| bool | addSubSurface (const SubSurface &subSurface) |
| bool | addSubSurface (const SubSurface &subSurface, unsigned index) |
| bool | setSubSurfaceIndex (const SubSurface &subSurface, unsigned index) |
| bool | removeSubSurface (const SubSurface &subSurface) |
| bool | removeSubSurface (unsigned index) |
| bool | addSubSurfaces (const std::vector< SubSurface > &subSurfaces) |
| Does not clear any subSurfaces already added, just calls calls addSubSurface for each It will return the global status, but will continue trying if there are problems (eg: if you make or a vector that has a subSurface from another model, the valid subSurfaces will be added indeed, but it'll eventually return false) More... | |
| bool | setSubSurfaces (const std::vector< SubSurface > &subSurfaces) |
| void | removeAllSubSurfaces () |
| 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< ModelObject > | children () 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< 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 (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< ModelObject > | connectedObject (unsigned port) const |
| boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Static Public Member Functions | |
| static IddObjectType | iddObjectType () |
| static std::vector< std::string > | multipleSurfaceControlTypeValues () |
| static std::vector< std::string > | shadingControlTypeValues () |
| static std::vector< std::string > | shadingTypeValues () |
| static std::vector< std::string > | typeofSlatAngleControlforBlindsValues () |
Related Functions | |
(Note that these are not member functions.) | |
| typedef boost::optional < ShadingControl > | OptionalShadingControl |
| typedef std::vector < ShadingControl > | ShadingControlVector |
| Related Functions inherited from openstudio::model::ResourceObject | |
| typedef boost::optional < ResourceObject > | OptionalResourceObject |
| typedef std::vector < ResourceObject > | ResourceObjectVector |
| Related Functions inherited from openstudio::model::ParentObject | |
| std::vector< ModelObject > | getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true) |
| Returns object and all other objects accessible by calling children() on encountered ParentObjects . More... | |
| std::vector< ModelObject > | getRecursiveChildrenAndResources (const ModelObject &object) |
| Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More... | |
| 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 | |
| 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) | |
ShadingControl is a ResourceObject that wraps the OpenStudio IDD object 'OS:ShadingControl'.
|
explicit |
Create a ShadingControl object which references the passed in construction for the shaded state.
This constructor should be used to model switchable glazing only at this time, other configurations will not be supported by the Radiance ForwardTranslator. Note that changes to the construction made after this constructor will not be reflected in this ShadingControl object. If changes to the construction are made a new ShadingControl object should be constructed.
|
explicit |
Create a ShadingControl object which references the passed in material for the shading layer.
This constructor is preferred for all configurations other than switchable glazing.
|
inlinevirtual |
| bool openstudio::model::ShadingControl::addSubSurface | ( | const SubSurface & | subSurface | ) |
| bool openstudio::model::ShadingControl::addSubSurface | ( | const SubSurface & | subSurface, |
| unsigned | index | ||
| ) |
| bool openstudio::model::ShadingControl::addSubSurfaces | ( | const std::vector< SubSurface > & | subSurfaces | ) |
Does not clear any subSurfaces already added, just calls calls addSubSurface for each It will return the global status, but will continue trying if there are problems (eg: if you make or a vector that has a subSurface from another model, the valid subSurfaces will be added indeed, but it'll eventually return false)
| boost::optional<Construction> openstudio::model::ShadingControl::construction | ( | ) | const |
| bool openstudio::model::ShadingControl::glareControlIsActive | ( | ) | const |
|
static |
| bool openstudio::model::ShadingControl::isControlTypeValueAllowingSchedule | ( | ) |
| bool openstudio::model::ShadingControl::isControlTypeValueNeedingSetpoint1 | ( | ) |
| bool openstudio::model::ShadingControl::isControlTypeValueNeedingSetpoint2 | ( | ) |
| bool openstudio::model::ShadingControl::isControlTypeValueRequiringSchedule | ( | ) |
| bool openstudio::model::ShadingControl::isSetpointDefaulted | ( | ) | const |
| bool openstudio::model::ShadingControl::isShadingControlTypeDefaulted | ( | ) | const |
| bool openstudio::model::ShadingControl::isTypeofSlatAngleControlforBlindsDefaulted | ( | ) | const |
| bool openstudio::model::ShadingControl::isTypeValueAllowingSlatAngleControl | ( | ) |
| std::string openstudio::model::ShadingControl::multipleSurfaceControlType | ( | ) | const |
|
static |
| unsigned int openstudio::model::ShadingControl::numberofSubSurfaces | ( | ) | const |
| void openstudio::model::ShadingControl::removeAllSubSurfaces | ( | ) |
| bool openstudio::model::ShadingControl::removeSubSurface | ( | const SubSurface & | subSurface | ) |
| bool openstudio::model::ShadingControl::removeSubSurface | ( | unsigned | index | ) |
| void openstudio::model::ShadingControl::resetGlareControlIsActive | ( | ) |
| void openstudio::model::ShadingControl::resetSchedule | ( | ) |
| void openstudio::model::ShadingControl::resetSetpoint | ( | ) |
| void openstudio::model::ShadingControl::resetShadingControlType | ( | ) |
| void openstudio::model::ShadingControl::resetSlatAngleSchedule | ( | ) |
| void openstudio::model::ShadingControl::resetTypeofSlatAngleControlforBlinds | ( | ) |
| boost::optional<Schedule> openstudio::model::ShadingControl::schedule | ( | ) | const |
| bool openstudio::model::ShadingControl::setGlareControlIsActive | ( | bool | glareControlIsActive | ) |
| bool openstudio::model::ShadingControl::setMultipleSurfaceControlType | ( | const std::string & | multipleSurfaceControlType | ) |
| boost::optional<double> openstudio::model::ShadingControl::setpoint | ( | ) | const |
| boost::optional<double> openstudio::model::ShadingControl::setpoint2 | ( | ) | const |
| bool openstudio::model::ShadingControl::setSchedule | ( | const Schedule & | schedule | ) |
| bool openstudio::model::ShadingControl::setSetpoint | ( | double | setpoint | ) |
| bool openstudio::model::ShadingControl::setSetpoint2 | ( | double | setpoint2 | ) |
| bool openstudio::model::ShadingControl::setShadingControlType | ( | const std::string & | shadingControlType | ) |
| bool openstudio::model::ShadingControl::setShadingType | ( | const std::string & | shadingType | ) |
Sets the shading type field.
There is no error checking to ensure that shadingType is correct given the shaded construction or shading material.
| bool openstudio::model::ShadingControl::setSlatAngleSchedule | ( | const Schedule & | slatAngleSchedule | ) |
| bool openstudio::model::ShadingControl::setSubSurfaceIndex | ( | const SubSurface & | subSurface, |
| unsigned | index | ||
| ) |
| bool openstudio::model::ShadingControl::setSubSurfaces | ( | const std::vector< SubSurface > & | subSurfaces | ) |
| bool openstudio::model::ShadingControl::setTypeofSlatAngleControlforBlinds | ( | const std::string & | typeofSlatAngleControlforBlinds | ) |
| std::string openstudio::model::ShadingControl::shadingControlType | ( | ) | const |
|
static |
| boost::optional<ShadingMaterial> openstudio::model::ShadingControl::shadingMaterial | ( | ) | const |
| std::string openstudio::model::ShadingControl::shadingType | ( | ) | const |
|
static |
| boost::optional<Schedule> openstudio::model::ShadingControl::slatAngleSchedule | ( | ) | const |
| boost::optional<unsigned> openstudio::model::ShadingControl::subSurfaceIndex | ( | const SubSurface & | subSurface | ) | const |
| std::vector<SubSurface> openstudio::model::ShadingControl::subSurfaces | ( | ) | const |
| std::string openstudio::model::ShadingControl::typeofSlatAngleControlforBlinds | ( | ) | const |
|
static |
|
related |
|
related |