 |
OpenStudio:model |
#include <GlareSensor.hpp>
Inheritance diagram for openstudio::model::GlareSensor:Public Member Functions | |
| bool | aimAt (const Point3d &target) |
| Keeps current position and orients the view towards the target, target is in space coordinates. More... | |
| openstudio::Point3d | position () const |
| Returns a Point3d representing position only in meters relative to the Space. More... | |
| bool | setPosition (const openstudio::Point3d &position) |
| Sets a Point3d representing position only position in meters relative to the Space. More... | |
| bool | setTransformation (const openstudio::Transformation &transformation) |
| Sets a Transformation representing position and orientation in meters relative to the Space. More... | |
| openstudio::Transformation | transformation () const |
| Returns a Transformation representing position and orientation in meters relative to the Space. More... | |
Constructors and Destructors | |
| GlareSensor (const Model &model) | |
| virtual | ~GlareSensor ()=default |
| GlareSensor (const GlareSensor &other)=default | |
| GlareSensor (GlareSensor &&other)=default | |
| GlareSensor & | operator= (const GlareSensor &)=default |
| GlareSensor & | operator= (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 |
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 () |
| Public Member Functions inherited from openstudio::model::SpaceItem | |
| SpaceItem & | operator= (const SpaceItem &)=default |
| SpaceItem & | operator= (SpaceItem &&)=default |
| void | resetSpace () |
| bool | setSpace (const Space &space) |
| Sets the parent Space. More... | |
| boost::optional< Space > | space () const |
| Returns the parent Space. More... | |
| SpaceItem (const SpaceItem &other)=default | |
| SpaceItem (SpaceItem &&other)=default | |
| virtual | ~SpaceItem ()=default |
| Public Member Functions inherited from openstudio::model::ModelObject | |
| virtual | ~ModelObject ()=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 |
Static Public Member Functions | |
Static Methods | |
| static IddObjectType | iddObjectType () |
Related Functions | |
(Note that these are not member functions.) | |
| using | GlareSensorVector = std::vector< GlareSensor > |
| using | OptionalGlareSensor = boost::optional< GlareSensor > |
| Related Functions inherited from openstudio::model::SpaceItem | |
| using | OptionalSpaceItem = boost::optional< SpaceItem > |
| using | SpaceItemVector = std::vector< SpaceItem > |
| 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 | |
| using | ImplType = detail::ModelObject_Impl |
| Protected Member Functions inherited from openstudio::model::SpaceItem | |
| SpaceItem (IddObjectType type, const Model &model) | |
| Constructs a new SpaceItem 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) | |
GlareSensor is a SpaceItem that wraps the OpenStudio IDD object 'OS:Glare:Sensor'.
|
explicit |
|
virtualdefault |
|
default |
|
default |
| bool openstudio::model::GlareSensor::aimAt | ( | const Point3d & | target | ) |
Keeps current position and orients the view towards the target, target is in space coordinates.
|
static |
| bool openstudio::model::GlareSensor::isPhiRotationAroundZAxisDefaulted | ( | ) | const |
| bool openstudio::model::GlareSensor::isPsiRotationAroundXAxisDefaulted | ( | ) | const |
| bool openstudio::model::GlareSensor::isThetaRotationAroundYAxisDefaulted | ( | ) | const |
| boost::optional<double> openstudio::model::GlareSensor::maximumAllowableDaylightGlareProbability | ( | ) | const |
| int openstudio::model::GlareSensor::numberofGlareViewVectors | ( | ) | const |
|
default |
|
default |
| double openstudio::model::GlareSensor::phiRotationAroundZAxis | ( | ) | const |
| openstudio::Point3d openstudio::model::GlareSensor::position | ( | ) | const |
Returns a Point3d representing position only in meters relative to the Space.
| double openstudio::model::GlareSensor::positionXCoordinate | ( | ) | const |
| double openstudio::model::GlareSensor::positionYCoordinate | ( | ) | const |
| double openstudio::model::GlareSensor::positionZCoordinate | ( | ) | const |
| double openstudio::model::GlareSensor::psiRotationAroundXAxis | ( | ) | const |
| void openstudio::model::GlareSensor::resetMaximumAllowableDaylightGlareProbability | ( | ) |
| void openstudio::model::GlareSensor::resetNumberofGlareViewVectors | ( | ) |
| void openstudio::model::GlareSensor::resetPhiRotationAroundZAxis | ( | ) |
| void openstudio::model::GlareSensor::resetPsiRotationAroundXAxis | ( | ) |
| void openstudio::model::GlareSensor::resetThetaRotationAroundYAxis | ( | ) |
| bool openstudio::model::GlareSensor::setMaximumAllowableDaylightGlareProbability | ( | double | maximumAllowableDaylightGlareProbability | ) |
| bool openstudio::model::GlareSensor::setNumberofGlareViewVectors | ( | int | numberofGlareViewVectors | ) |
| bool openstudio::model::GlareSensor::setPhiRotationAroundZAxis | ( | double | phiRotationAroundZAxis | ) |
| 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.
| bool openstudio::model::GlareSensor::setPositionXCoordinate | ( | double | positionXCoordinate | ) |
| bool openstudio::model::GlareSensor::setPositionYCoordinate | ( | double | positionYCoordinate | ) |
| bool openstudio::model::GlareSensor::setPositionZCoordinate | ( | double | positionZCoordinate | ) |
| bool openstudio::model::GlareSensor::setPsiRotationAroundXAxis | ( | double | psiRotationAroundXAxis | ) |
| bool openstudio::model::GlareSensor::setThetaRotationAroundYAxis | ( | double | thetaRotationAroundYAxis | ) |
| bool openstudio::model::GlareSensor::setTransformation | ( | const openstudio::Transformation & | transformation | ) |
Sets a Transformation representing position and orientation in meters relative to the Space.
| double openstudio::model::GlareSensor::thetaRotationAroundYAxis | ( | ) | const |
| openstudio::Transformation openstudio::model::GlareSensor::transformation | ( | ) | const |
Returns a Transformation representing position and orientation in meters relative to the Space.
|
related |
|
related |