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

#include <GlareSensor.hpp>

+ Inheritance diagram for openstudio::model::GlareSensor:

Public Member Functions

Constructors and Destructors
 GlareSensor (const Model &model)
 
virtual ~GlareSensor () override=default
 
 GlareSensor (const GlareSensor &other)=default
 
 GlareSensor (GlareSensor &&other)=default
 
GlareSensoroperator= (const GlareSensor &)=default
 
GlareSensoroperator= (GlareSensor &&)=default
 
Getters
double positionXCoordinate () const
 
double positionYCoordinate () const
 
double positionZCoordinate () const
 
double psiRotationAroundXAxis () const
 
bool isPsiRotationAroundXAxisDefaulted () const
 
double thetaRotationAroundYAxis () const
 
bool isThetaRotationAroundYAxisDefaulted () const
 
double phiRotationAroundZAxis () const
 
bool isPhiRotationAroundZAxisDefaulted () const
 
int numberofGlareViewVectors () const
 
boost::optional< double > maximumAllowableDaylightGlareProbability () const
 
- Public Member Functions inherited from openstudio::model::SpaceItem
SpaceItemoperator= (const SpaceItem &)=default
 
SpaceItemoperator= (SpaceItem &&)=default
 
void resetSpace ()
 
bool setSpace (const Space &space)
 Sets the parent Space.
 
boost::optional< Spacespace () const
 Returns the parent Space.
 
 SpaceItem (const SpaceItem &other)=default
 
 SpaceItem (SpaceItem &&other)=default
 
virtual ~SpaceItem () override=default
 
- 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 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 GlareSensorVector = std::vector<GlareSensor>
 
using OptionalGlareSensor = boost::optional<GlareSensor>
 

Setters

bool setPositionXCoordinate (double positionXCoordinate)
 
bool setPositionYCoordinate (double positionYCoordinate)
 
bool setPositionZCoordinate (double positionZCoordinate)
 
bool setPsiRotationAroundXAxis (double psiRotationAroundXAxis)
 
void resetPsiRotationAroundXAxis ()
 
bool setThetaRotationAroundYAxis (double thetaRotationAroundYAxis)
 
void resetThetaRotationAroundYAxis ()
 
bool setPhiRotationAroundZAxis (double phiRotationAroundZAxis)
 
void resetPhiRotationAroundZAxis ()
 
bool setNumberofGlareViewVectors (int numberofGlareViewVectors)
 
void resetNumberofGlareViewVectors ()
 
bool setMaximumAllowableDaylightGlareProbability (double maximumAllowableDaylightGlareProbability)
 
void resetMaximumAllowableDaylightGlareProbability ()
 
openstudio::Point3d position () const
 Returns a Point3d representing position only in meters relative to the Space.
 
bool setPosition (const openstudio::Point3d &position)
 Sets a Point3d representing position only position in meters relative to the Space.
 
openstudio::Transformation transformation () const
 Returns a Transformation representing position and orientation in meters relative to the Space.
 
bool setTransformation (const openstudio::Transformation &transformation)
 Sets a Transformation representing position and orientation in meters relative to the Space.
 
bool aimAt (const Point3d &target)
 Keeps current position and orients the view towards the target, target is in space coordinates.
 

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::SpaceItem
 SpaceItem (IddObjectType type, const Model &model)
 Constructs a new SpaceItem 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

GlareSensor is a SpaceItem that wraps the OpenStudio IDD object 'OS:Glare:Sensor'.

Constructor & Destructor Documentation

◆ GlareSensor() [1/3]

openstudio::model::GlareSensor::GlareSensor ( const Model & model)
explicit

◆ ~GlareSensor()

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

◆ GlareSensor() [2/3]

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

◆ GlareSensor() [3/3]

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

Member Function Documentation

◆ aimAt()

bool openstudio::model::GlareSensor::aimAt ( const Point3d & target)

Keeps current position and orients the view towards the target, target is in space coordinates.

◆ iddObjectType()

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

◆ isPhiRotationAroundZAxisDefaulted()

bool openstudio::model::GlareSensor::isPhiRotationAroundZAxisDefaulted ( ) const

◆ isPsiRotationAroundXAxisDefaulted()

bool openstudio::model::GlareSensor::isPsiRotationAroundXAxisDefaulted ( ) const

◆ isThetaRotationAroundYAxisDefaulted()

bool openstudio::model::GlareSensor::isThetaRotationAroundYAxisDefaulted ( ) const

◆ maximumAllowableDaylightGlareProbability()

boost::optional< double > openstudio::model::GlareSensor::maximumAllowableDaylightGlareProbability ( ) const

◆ numberofGlareViewVectors()

int openstudio::model::GlareSensor::numberofGlareViewVectors ( ) const

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ phiRotationAroundZAxis()

double openstudio::model::GlareSensor::phiRotationAroundZAxis ( ) const

◆ position()

openstudio::Point3d openstudio::model::GlareSensor::position ( ) const

Returns a Point3d representing position only in meters relative to the Space.

◆ positionXCoordinate()

double openstudio::model::GlareSensor::positionXCoordinate ( ) const

◆ positionYCoordinate()

double openstudio::model::GlareSensor::positionYCoordinate ( ) const

◆ positionZCoordinate()

double openstudio::model::GlareSensor::positionZCoordinate ( ) const

◆ psiRotationAroundXAxis()

double openstudio::model::GlareSensor::psiRotationAroundXAxis ( ) const

◆ resetMaximumAllowableDaylightGlareProbability()

void openstudio::model::GlareSensor::resetMaximumAllowableDaylightGlareProbability ( )

◆ resetNumberofGlareViewVectors()

void openstudio::model::GlareSensor::resetNumberofGlareViewVectors ( )

◆ resetPhiRotationAroundZAxis()

void openstudio::model::GlareSensor::resetPhiRotationAroundZAxis ( )

◆ resetPsiRotationAroundXAxis()

void openstudio::model::GlareSensor::resetPsiRotationAroundXAxis ( )

◆ resetThetaRotationAroundYAxis()

void openstudio::model::GlareSensor::resetThetaRotationAroundYAxis ( )

◆ setMaximumAllowableDaylightGlareProbability()

bool openstudio::model::GlareSensor::setMaximumAllowableDaylightGlareProbability ( double maximumAllowableDaylightGlareProbability)

◆ setNumberofGlareViewVectors()

bool openstudio::model::GlareSensor::setNumberofGlareViewVectors ( int numberofGlareViewVectors)

◆ setPhiRotationAroundZAxis()

bool openstudio::model::GlareSensor::setPhiRotationAroundZAxis ( double phiRotationAroundZAxis)

◆ setPosition()

bool openstudio::model::GlareSensor::setPosition ( const openstudio::Point3d & position)

Sets a Point3d representing position only position in meters relative to the Space.

Does not change the orientation of the GlareSensor.

◆ setPositionXCoordinate()

bool openstudio::model::GlareSensor::setPositionXCoordinate ( double positionXCoordinate)

◆ setPositionYCoordinate()

bool openstudio::model::GlareSensor::setPositionYCoordinate ( double positionYCoordinate)

◆ setPositionZCoordinate()

bool openstudio::model::GlareSensor::setPositionZCoordinate ( double positionZCoordinate)

◆ setPsiRotationAroundXAxis()

bool openstudio::model::GlareSensor::setPsiRotationAroundXAxis ( double psiRotationAroundXAxis)

◆ setThetaRotationAroundYAxis()

bool openstudio::model::GlareSensor::setThetaRotationAroundYAxis ( double thetaRotationAroundYAxis)

◆ setTransformation()

bool openstudio::model::GlareSensor::setTransformation ( const openstudio::Transformation & transformation)

Sets a Transformation representing position and orientation in meters relative to the Space.

◆ thetaRotationAroundYAxis()

double openstudio::model::GlareSensor::thetaRotationAroundYAxis ( ) const

◆ transformation()

openstudio::Transformation openstudio::model::GlareSensor::transformation ( ) const

Returns a Transformation representing position and orientation in meters relative to the Space.

Friends And Related Symbol Documentation

◆ GlareSensorVector

using GlareSensorVector = std::vector<GlareSensor>
related

◆ OptionalGlareSensor

using OptionalGlareSensor = boost::optional<GlareSensor>
related