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

#include "IlluminanceMap.hpp"

Inheritance diagram for openstudio::model::IlluminanceMap:

Public Member Functions

std::vector< Point3dcorners () const
std::vector< Point3dreferencePoints () const
bool setTransformation (const openstudio::Transformation &transformation)
openstudio::Transformation transformation () const
 IlluminanceMap (const Model &model)
virtual ~IlluminanceMap ()
double originXCoordinate () const
double originYCoordinate () const
double originZCoordinate () const
double psiRotationAroundXAxis () const
bool isPsiRotationAroundXAxisDefaulted () const
double thetaRotationAroundYAxis () const
bool isThetaRotationAroundYAxisDefaulted () const
double phiRotationAroundZAxis () const
bool isPhiRotationAroundZAxisDefaulted () const
double xLength () const
bool isXLengthDefaulted () const
int numberofXGridPoints () const
bool isNumberofXGridPointsDefaulted () const
double yLength () const
bool isYLengthDefaulted () const
int numberofYGridPoints () const
bool isNumberofYGridPointsDefaulted () const
void setOriginXCoordinate (double originXCoordinate)
void setOriginYCoordinate (double originYCoordinate)
void setOriginZCoordinate (double originZCoordinate)
bool setPsiRotationAroundXAxis (double psiRotationAroundXAxis)
void resetPsiRotationAroundXAxis ()
bool setThetaRotationAroundYAxis (double thetaRotationAroundYAxis)
void resetThetaRotationAroundYAxis ()
bool setPhiRotationAroundZAxis (double phiRotationAroundZAxis)
void resetPhiRotationAroundZAxis ()
void setXLength (double xLength)
void resetXLength ()
bool setNumberofXGridPoints (int numberofXGridPoints)
void resetNumberofXGridPoints ()
void setYLength (double yLength)
void resetYLength ()
bool setNumberofYGridPoints (int numberofYGridPoints)
void resetNumberofYGridPoints ()

Static Public Member Functions

static IddObjectType iddObjectType ()

Related Functions

typedef std::vector
< IlluminanceMap
IlluminanceMapVector
typedef boost::optional
< IlluminanceMap
OptionalIlluminanceMap

Detailed Description

IlluminanceMap is a SpaceItem and is an interface to the OpenStudio IDD object named "OS:IlluminanceMap".

IlluminanceMap is a child of the Space object and is used to report daylighting illuminance values over a grid. The grid of points to calculate daylight illuminance over is defined by the minimum and maximum corners of a rectangle aligned with the parent Space's coordinate system.

Constructor & Destructor Documentation

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

Member Function Documentation

std::vector<Point3d> openstudio::model::IlluminanceMap::corners ( ) const

Returns a vector of the 4 corner reference points in the calculation grid in illuminance map coordinates.

The points returned are [0, yLength, 0], [0, 0, 0], [xLength, 0, 0], [xLength, yLength, 0] To get the points in space coordinates use transformation * referencePoints

static IddObjectType openstudio::model::IlluminanceMap::iddObjectType ( )
static
bool openstudio::model::IlluminanceMap::isNumberofXGridPointsDefaulted ( ) const
bool openstudio::model::IlluminanceMap::isNumberofYGridPointsDefaulted ( ) const
bool openstudio::model::IlluminanceMap::isPhiRotationAroundZAxisDefaulted ( ) const
bool openstudio::model::IlluminanceMap::isPsiRotationAroundXAxisDefaulted ( ) const
bool openstudio::model::IlluminanceMap::isThetaRotationAroundYAxisDefaulted ( ) const
bool openstudio::model::IlluminanceMap::isXLengthDefaulted ( ) const
bool openstudio::model::IlluminanceMap::isYLengthDefaulted ( ) const
int openstudio::model::IlluminanceMap::numberofXGridPoints ( ) const
int openstudio::model::IlluminanceMap::numberofYGridPoints ( ) const
double openstudio::model::IlluminanceMap::originXCoordinate ( ) const
double openstudio::model::IlluminanceMap::originYCoordinate ( ) const
double openstudio::model::IlluminanceMap::originZCoordinate ( ) const
double openstudio::model::IlluminanceMap::phiRotationAroundZAxis ( ) const
double openstudio::model::IlluminanceMap::psiRotationAroundXAxis ( ) const
std::vector<Point3d> openstudio::model::IlluminanceMap::referencePoints ( ) const

Returns a vector of all the reference points in the calculation grid in illuminance map coordinates.

The points are returned in order such as [0, 0, 0], ..., [xLength, 0, 0], [0, yLength/numberofYGridPoints, 0], ..., [xLength, yLength, 0] To get the points in space coordinates use transformation * referencePoints

void openstudio::model::IlluminanceMap::resetNumberofXGridPoints ( )
void openstudio::model::IlluminanceMap::resetNumberofYGridPoints ( )
void openstudio::model::IlluminanceMap::resetPhiRotationAroundZAxis ( )
void openstudio::model::IlluminanceMap::resetPsiRotationAroundXAxis ( )
void openstudio::model::IlluminanceMap::resetThetaRotationAroundYAxis ( )
void openstudio::model::IlluminanceMap::resetXLength ( )
void openstudio::model::IlluminanceMap::resetYLength ( )
bool openstudio::model::IlluminanceMap::setNumberofXGridPoints ( int  numberofXGridPoints)
bool openstudio::model::IlluminanceMap::setNumberofYGridPoints ( int  numberofYGridPoints)
void openstudio::model::IlluminanceMap::setOriginXCoordinate ( double  originXCoordinate)
void openstudio::model::IlluminanceMap::setOriginYCoordinate ( double  originYCoordinate)
void openstudio::model::IlluminanceMap::setOriginZCoordinate ( double  originZCoordinate)
bool openstudio::model::IlluminanceMap::setPhiRotationAroundZAxis ( double  phiRotationAroundZAxis)
bool openstudio::model::IlluminanceMap::setPsiRotationAroundXAxis ( double  psiRotationAroundXAxis)
bool openstudio::model::IlluminanceMap::setThetaRotationAroundYAxis ( double  thetaRotationAroundYAxis)
bool openstudio::model::IlluminanceMap::setTransformation ( const openstudio::Transformation transformation)

Set the transformation from illuminance map coordinates to space coordinates.

void openstudio::model::IlluminanceMap::setXLength ( double  xLength)
void openstudio::model::IlluminanceMap::setYLength ( double  yLength)
double openstudio::model::IlluminanceMap::thetaRotationAroundYAxis ( ) const
openstudio::Transformation openstudio::model::IlluminanceMap::transformation ( ) const

Get the transformation from illuminance map coordinates to space coordinates.

double openstudio::model::IlluminanceMap::xLength ( ) const
double openstudio::model::IlluminanceMap::yLength ( ) const

Friends And Related Function Documentation

typedef std::vector<IlluminanceMap> IlluminanceMapVector
related
typedef boost::optional<IlluminanceMap> OptionalIlluminanceMap
related