 |
OpenStudio:model |
#include <IlluminanceMap.hpp>
Inheritance diagram for openstudio::model::IlluminanceMap:Public Member Functions | |
| std::vector< Point3d > | corners () const |
| Returns a vector of the 4 corner reference points in the calculation grid in illuminance map coordinates. More... | |
| std::vector< Point3d > | referencePoints () const |
| Returns a vector of all the reference points in the calculation grid in illuminance map coordinates. More... | |
| bool | setTransformation (const openstudio::Transformation &transformation) |
| Set the transformation from illuminance map coordinates to space coordinates. More... | |
| openstudio::Transformation | transformation () const |
| Get the transformation from illuminance map coordinates to space coordinates. More... | |
Constructors and Destructors | |
| IlluminanceMap (const Model &model) | |
| virtual | ~IlluminanceMap ()=default |
| IlluminanceMap (const IlluminanceMap &other)=default | |
| IlluminanceMap (IlluminanceMap &&other)=default | |
| IlluminanceMap & | operator= (const IlluminanceMap &)=default |
| IlluminanceMap & | operator= (IlluminanceMap &&)=default |
Getters | |
| 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 |
Setters | |
| bool | setOriginXCoordinate (double originXCoordinate) |
| bool | setOriginYCoordinate (double originYCoordinate) |
| bool | setOriginZCoordinate (double originZCoordinate) |
| bool | setPsiRotationAroundXAxis (double psiRotationAroundXAxis) |
| void | resetPsiRotationAroundXAxis () |
| bool | setThetaRotationAroundYAxis (double thetaRotationAroundYAxis) |
| void | resetThetaRotationAroundYAxis () |
| bool | setPhiRotationAroundZAxis (double phiRotationAroundZAxis) |
| void | resetPhiRotationAroundZAxis () |
| bool | setXLength (double xLength) |
| void | resetXLength () |
| bool | setNumberofXGridPoints (int numberofXGridPoints) |
| void | resetNumberofXGridPoints () |
| bool | setYLength (double yLength) |
| void | resetYLength () |
| bool | setNumberofYGridPoints (int numberofYGridPoints) |
| void | resetNumberofYGridPoints () |
| 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 | IlluminanceMapVector = std::vector< IlluminanceMap > |
| using | OptionalIlluminanceMap = boost::optional< IlluminanceMap > |
| 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) | |
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.
|
explicit |
|
virtualdefault |
|
default |
|
default |
| 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 |
| 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 |
|
default |
|
default |
| 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 | ) |
| bool openstudio::model::IlluminanceMap::setOriginXCoordinate | ( | double | originXCoordinate | ) |
| bool openstudio::model::IlluminanceMap::setOriginYCoordinate | ( | double | originYCoordinate | ) |
| bool 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.
| bool openstudio::model::IlluminanceMap::setXLength | ( | double | xLength | ) |
| bool 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 |
|
related |
|
related |