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

#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 ()=default
 
 ShadingControl (const ShadingControl &other)=default
 
 ShadingControl (ShadingControl &&other)=default
 
ShadingControloperator= (const ShadingControl &)=default
 
ShadingControloperator= (ShadingControl &&)=default
 
Getters
std::string shadingType () const
 
boost::optional< Constructionconstruction () const
 
boost::optional< ShadingMaterialshadingMaterial () const
 
std::string shadingControlType () const
 
bool isShadingControlTypeDefaulted () const
 
boost::optional< Scheduleschedule () const
 
boost::optional< double > setpoint () const
 
bool isSetpointDefaulted () const
 
bool glareControlIsActive () const
 
std::string typeofSlatAngleControlforBlinds () const
 
bool isTypeofSlatAngleControlforBlindsDefaulted () const
 
boost::optional< ScheduleslatAngleSchedule () 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< SubSurfacesubSurfaces () 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...
 
ResourceObjectoperator= (const ResourceObject &)=default
 
ResourceObjectoperator= (ResourceObject &&)=default
 
 ResourceObject (const ResourceObject &other)=default
 
 ResourceObject (ResourceObject &&other)=default
 
virtual ~ResourceObject ()=default
 
- 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...
 
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject ()=default
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()=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(). 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< IdfObjectremoveLifeCycleCosts ()
 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< IdfObjectremoveAdditionalProperties ()
 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 (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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 
- Public Member Functions inherited from openstudio::WorkspaceObject
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< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (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)
 
WorkspaceObjectoperator= (WorkspaceObject &&)=default
 
WorkspaceObjectoperator= (const WorkspaceObject &)=default
 
std::vector
< openstudio::IdfObject
remove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
 WorkspaceObject (const WorkspaceObject &other)=default
 
 WorkspaceObject (WorkspaceObject &&other)=default
 
virtual ~WorkspaceObject ()=default
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
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< IdfExtensibleGroupextensibleGroups () 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< intgetInt (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)
 
IdfObjectoperator= (IdfObject &&other) noexcept
 
IdfObjectoperator= (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
 

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 ()
 
- 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 Functions

(Note that these are not member functions.)

using OptionalShadingControl = boost::optional< ShadingControl >
 
using ShadingControlVector = std::vector< ShadingControl >
 

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional
< WorkspaceObject
OptionalWorkspaceObject
 
typedef std::vector
< WorkspaceObject
WorkspaceObjectVector
 
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject,
IdfObject
IdfObjectPair
 
typedef std::vector< IdfObjectIdfObjectVector
 
typedef boost::optional
< IdfObject
OptionalIdfObject
 
- 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::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)
 
- 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

ShadingControl is a ResourceObject that wraps the OpenStudio IDD object 'OS:ShadingControl'.

Constructor & Destructor Documentation

openstudio::model::ShadingControl::ShadingControl ( const Construction construction)
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.

openstudio::model::ShadingControl::ShadingControl ( const ShadingMaterial shadingMaterial)
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.

virtual openstudio::model::ShadingControl::~ShadingControl ( )
virtualdefault
openstudio::model::ShadingControl::ShadingControl ( const ShadingControl other)
default
openstudio::model::ShadingControl::ShadingControl ( ShadingControl &&  other)
default

Member Function Documentation

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 IddObjectType openstudio::model::ShadingControl::iddObjectType ( )
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 std::vector<std::string> openstudio::model::ShadingControl::multipleSurfaceControlTypeValues ( )
static
unsigned int openstudio::model::ShadingControl::numberofSubSurfaces ( ) const
ShadingControl& openstudio::model::ShadingControl::operator= ( const ShadingControl )
default
ShadingControl& openstudio::model::ShadingControl::operator= ( ShadingControl &&  )
default
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 std::vector<std::string> openstudio::model::ShadingControl::shadingControlTypeValues ( )
static
boost::optional<ShadingMaterial> openstudio::model::ShadingControl::shadingMaterial ( ) const
std::string openstudio::model::ShadingControl::shadingType ( ) const
static std::vector<std::string> openstudio::model::ShadingControl::shadingTypeValues ( )
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 std::vector<std::string> openstudio::model::ShadingControl::typeofSlatAngleControlforBlindsValues ( )
static

Friends And Related Function Documentation

using OptionalShadingControl = boost::optional<ShadingControl>
related
using ShadingControlVector = std::vector<ShadingControl>
related