openstudio::radiance::AnnualIlluminanceMap Class Reference

#include <AnnualIlluminanceMap.hpp>

Public Member Functions
	AnnualIlluminanceMap ()
	default constructor
	AnnualIlluminanceMap (const openstudio::path &path)
	constructor with path
openstudio::DateTimeVector	dateTimes () const
	get the dates and times for which illuminance maps are available
openstudio::Matrix	illuminanceMap (const openstudio::DateTime &dateTime) const
	get the illuminance map in lux corresponding to date and time
openstudio::Vector	xVector () const
	get the x points corresponding to illuminance matrix columns in meters
openstudio::Vector	yVector () const
	get the y points corresponding to illuminance matrix rows in meters
virtual	~AnnualIlluminanceMap ()=default
	virtual destructor

Detailed Description

AnnualIlluminanceMap represents illuminance map for an entire year.

We assume that the output files is from SPOT, with length in meters and illuminance values in footcandles. All illuminance values are converted to lux.

Constructor & Destructor Documentation

AnnualIlluminanceMap() [1/2]

openstudio::radiance::AnnualIlluminanceMap::AnnualIlluminanceMap

(

)

default constructor

AnnualIlluminanceMap() [2/2]

openstudio::radiance::AnnualIlluminanceMap::AnnualIlluminanceMap

(

const openstudio::path &

path

)

constructor with path

~AnnualIlluminanceMap()

virtual openstudio::radiance::AnnualIlluminanceMap::~AnnualIlluminanceMap ( )

virtualdefault

virtual destructor

Member Function Documentation

dateTimes()

openstudio::DateTimeVector openstudio::radiance::AnnualIlluminanceMap::dateTimes ( ) const

inline

get the dates and times for which illuminance maps are available

illuminanceMap()

openstudio::Matrix openstudio::radiance::AnnualIlluminanceMap::illuminanceMap

(

const openstudio::DateTime &

dateTime

)

const

get the illuminance map in lux corresponding to date and time

xVector()

openstudio::Vector openstudio::radiance::AnnualIlluminanceMap::xVector ( ) const

inline

get the x points corresponding to illuminance matrix columns in meters

yVector()

openstudio::Vector openstudio::radiance::AnnualIlluminanceMap::yVector ( ) const

inline

get the y points corresponding to illuminance matrix rows in meters