OpenStudio:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages

#include "GlareSensor.hpp"

Inheritance diagram for openstudio::model::GlareSensor:

Public Member Functions

bool aimAt (const Point3d &target)
openstudio::Point3d position () const
bool setPosition (const openstudio::Point3d &position)
bool setTransformation (const openstudio::Transformation &transformation)
openstudio::Transformation transformation () const
 GlareSensor (const Model &model)
virtual ~GlareSensor ()
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
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 ()

Static Public Member Functions

static IddObjectType iddObjectType ()

Related Functions

typedef std::vector< GlareSensorGlareSensorVector
typedef boost::optional
< GlareSensor
OptionalGlareSensor

Detailed Description

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

Constructor & Destructor Documentation

openstudio::model::GlareSensor::GlareSensor ( const Model model)
explicit
virtual openstudio::model::GlareSensor::~GlareSensor ( )
inlinevirtual

Member Function Documentation

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

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

static IddObjectType openstudio::model::GlareSensor::iddObjectType ( )
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
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.

Friends And Related Function Documentation

typedef std::vector<GlareSensor> GlareSensorVector
related
typedef boost::optional<GlareSensor> OptionalGlareSensor
related