All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Static Public Member Functions | Related Functions | List of all members
openstudio::model::RadianceParameters Class Reference

#include <RadianceParameters.hpp>

+ Inheritance diagram for openstudio::model::RadianceParameters:

Public Member Functions

Constructors and Destructors
virtual ~RadianceParameters ()
int accumulatedRaysperRecord () const
bool isAccumulatedRaysperRecordDefaulted () const
double directThreshold () const
bool isDirectThresholdDefaulted () const
double directCertainty () const
bool isDirectCertaintyDefaulted () const
double directJitter () const
bool isDirectJitterDefaulted () const
double directPretest () const
bool isDirectPretestDefaulted () const
int ambientBouncesVMX () const
bool isAmbientBouncesVMXDefaulted () const
int ambientBouncesDMX () const
bool isAmbientBouncesDMXDefaulted () const
int ambientDivisionsVMX () const
bool isAmbientDivisionsVMXDefaulted () const
int ambientDivisionsDMX () const
bool isAmbientDivisionsDMXDefaulted () const
int ambientSupersamples () const
bool isAmbientSupersamplesDefaulted () const
double limitWeightVMX () const
bool isLimitWeightVMXDefaulted () const
double limitWeightDMX () const
bool isLimitWeightDMXDefaulted () const
int klemsSamplingDensity () const
bool isKlemsSamplingDensityDefaulted () const
std::string skyDiscretizationResolution () const
bool isCoarseSettings ()
bool isFineSettings ()
bool setAccumulatedRaysperRecord (int accumulatedRaysperRecord)
void resetAccumulatedRaysperRecord ()
bool setDirectThreshold (double directThreshold)
void resetDirectThreshold ()
bool setDirectCertainty (double directCertainty)
void resetDirectCertainty ()
bool setDirectJitter (double directJitter)
void resetDirectJitter ()
bool setDirectPretest (double directPretest)
void resetDirectPretest ()
bool setAmbientBouncesVMX (int ambientBouncesVMX)
void resetAmbientBouncesVMX ()
bool setAmbientBouncesDMX (int ambientBouncesDMX)
void resetAmbientBouncesDMX ()
bool setAmbientDivisionsVMX (int ambientDivisionsVMX)
void resetAmbientDivisionsVMX ()
bool setAmbientDivisionsDMX (int ambientDivisionsDMX)
void resetAmbientDivisionsDMX ()
bool setAmbientSupersamples (int ambientSupersamples)
void resetAmbientSupersamples ()
bool setLimitWeightVMX (double limitWeightVMX)
void resetLimitWeightVMX ()
bool setLimitWeightDMX (double limitWeightDMX)
void resetLimitWeightDMX ()
bool setKlemsSamplingDensity (int klemsSamplingDensity)
void resetKlemsSamplingDensity ()
bool setSkyDiscretizationResolution (std::string skyDiscretizationResolution)
void resetSkyDiscretizationResolution ()
void applyCoarseSettings ()
void applyFineSettings ()
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()
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< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
std::vector< ResourceObjectresources () 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< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data. More...
< openstudio::TimeSeries > 
getData (const OutputVariable &variable, const std::string &envPeriod) const
 Get data associated with this output variable and this object. More...
std::vector< LifeCycleCostlifeCycleCosts () 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...
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< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
boost::optional< double > getAutosizedValue (std::string valueName, std::string unitString) 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< ModelObjectconnectedObject (unsigned port) const
boost::optional< unsigned > connectedObjectPort (unsigned port) const

Static Public Member Functions

static IddObjectType iddObjectType ()
static std::vector< std::string > skyDiscretizationResolutionValues ()

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< RadianceParameters
typedef std::vector
< RadianceParameters

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
- 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)

Detailed Description

RadianceParameters is a ModelObject that wraps the OpenStudio IDD object 'OS:RadianceParameters'.

Constructor & Destructor Documentation

virtual openstudio::model::RadianceParameters::~RadianceParameters ( )

Member Function Documentation

int openstudio::model::RadianceParameters::accumulatedRaysperRecord ( ) const
int openstudio::model::RadianceParameters::ambientBouncesDMX ( ) const
int openstudio::model::RadianceParameters::ambientBouncesVMX ( ) const
int openstudio::model::RadianceParameters::ambientDivisionsDMX ( ) const
int openstudio::model::RadianceParameters::ambientDivisionsVMX ( ) const
int openstudio::model::RadianceParameters::ambientSupersamples ( ) const
void openstudio::model::RadianceParameters::applyCoarseSettings ( )
void openstudio::model::RadianceParameters::applyFineSettings ( )
double openstudio::model::RadianceParameters::directCertainty ( ) const
double openstudio::model::RadianceParameters::directJitter ( ) const
double openstudio::model::RadianceParameters::directPretest ( ) const
double openstudio::model::RadianceParameters::directThreshold ( ) const
static IddObjectType openstudio::model::RadianceParameters::iddObjectType ( )
bool openstudio::model::RadianceParameters::isAccumulatedRaysperRecordDefaulted ( ) const
bool openstudio::model::RadianceParameters::isAmbientBouncesDMXDefaulted ( ) const
bool openstudio::model::RadianceParameters::isAmbientBouncesVMXDefaulted ( ) const
bool openstudio::model::RadianceParameters::isAmbientDivisionsDMXDefaulted ( ) const
bool openstudio::model::RadianceParameters::isAmbientDivisionsVMXDefaulted ( ) const
bool openstudio::model::RadianceParameters::isAmbientSupersamplesDefaulted ( ) const
bool openstudio::model::RadianceParameters::isCoarseSettings ( )
bool openstudio::model::RadianceParameters::isDirectCertaintyDefaulted ( ) const
bool openstudio::model::RadianceParameters::isDirectJitterDefaulted ( ) const
bool openstudio::model::RadianceParameters::isDirectPretestDefaulted ( ) const
bool openstudio::model::RadianceParameters::isDirectThresholdDefaulted ( ) const
bool openstudio::model::RadianceParameters::isFineSettings ( )
bool openstudio::model::RadianceParameters::isKlemsSamplingDensityDefaulted ( ) const
bool openstudio::model::RadianceParameters::isLimitWeightDMXDefaulted ( ) const
bool openstudio::model::RadianceParameters::isLimitWeightVMXDefaulted ( ) const
int openstudio::model::RadianceParameters::klemsSamplingDensity ( ) const
double openstudio::model::RadianceParameters::limitWeightDMX ( ) const
double openstudio::model::RadianceParameters::limitWeightVMX ( ) const
void openstudio::model::RadianceParameters::resetAccumulatedRaysperRecord ( )
void openstudio::model::RadianceParameters::resetAmbientBouncesDMX ( )
void openstudio::model::RadianceParameters::resetAmbientBouncesVMX ( )
void openstudio::model::RadianceParameters::resetAmbientDivisionsDMX ( )
void openstudio::model::RadianceParameters::resetAmbientDivisionsVMX ( )
void openstudio::model::RadianceParameters::resetAmbientSupersamples ( )
void openstudio::model::RadianceParameters::resetDirectCertainty ( )
void openstudio::model::RadianceParameters::resetDirectJitter ( )
void openstudio::model::RadianceParameters::resetDirectPretest ( )
void openstudio::model::RadianceParameters::resetDirectThreshold ( )
void openstudio::model::RadianceParameters::resetKlemsSamplingDensity ( )
void openstudio::model::RadianceParameters::resetLimitWeightDMX ( )
void openstudio::model::RadianceParameters::resetLimitWeightVMX ( )
void openstudio::model::RadianceParameters::resetSkyDiscretizationResolution ( )
bool openstudio::model::RadianceParameters::setAccumulatedRaysperRecord ( int  accumulatedRaysperRecord)
bool openstudio::model::RadianceParameters::setAmbientBouncesDMX ( int  ambientBouncesDMX)
bool openstudio::model::RadianceParameters::setAmbientBouncesVMX ( int  ambientBouncesVMX)
bool openstudio::model::RadianceParameters::setAmbientDivisionsDMX ( int  ambientDivisionsDMX)
bool openstudio::model::RadianceParameters::setAmbientDivisionsVMX ( int  ambientDivisionsVMX)
bool openstudio::model::RadianceParameters::setAmbientSupersamples ( int  ambientSupersamples)
bool openstudio::model::RadianceParameters::setDirectCertainty ( double  directCertainty)
bool openstudio::model::RadianceParameters::setDirectJitter ( double  directJitter)
bool openstudio::model::RadianceParameters::setDirectPretest ( double  directPretest)
bool openstudio::model::RadianceParameters::setDirectThreshold ( double  directThreshold)
bool openstudio::model::RadianceParameters::setKlemsSamplingDensity ( int  klemsSamplingDensity)
bool openstudio::model::RadianceParameters::setLimitWeightDMX ( double  limitWeightDMX)
bool openstudio::model::RadianceParameters::setLimitWeightVMX ( double  limitWeightVMX)
bool openstudio::model::RadianceParameters::setSkyDiscretizationResolution ( std::string  skyDiscretizationResolution)
std::string openstudio::model::RadianceParameters::skyDiscretizationResolution ( ) const
static std::vector<std::string> openstudio::model::RadianceParameters::skyDiscretizationResolutionValues ( )

Friends And Related Function Documentation

typedef boost::optional<RadianceParameters> OptionalRadianceParameters
typedef std::vector<RadianceParameters> RadianceParametersVector