OpenStudioCore:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends 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 ()
 
Getters
int accumulatedRaysperRecord () const
 
bool isAccumulatedRaysperRecordDefaulted () const
 
double directThreshold () const
 
Quantity getDirectThreshold (bool returnIP=false) const
 
bool isDirectThresholdDefaulted () const
 
double directCertainty () const
 
Quantity getDirectCertainty (bool returnIP=false) const
 
bool isDirectCertaintyDefaulted () const
 
double directJitter () const
 
Quantity getDirectJitter (bool returnIP=false) const
 
bool isDirectJitterDefaulted () const
 
double directPretest () const
 
Quantity getDirectPretest (bool returnIP=false) 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
 
Quantity getLimitWeightVMX (bool returnIP=false) const
 
bool isLimitWeightVMXDefaulted () const
 
double limitWeightDMX () const
 
Quantity getLimitWeightDMX (bool returnIP=false) const
 
bool isLimitWeightDMXDefaulted () const
 
int klemsSamplingDensity () const
 
bool isKlemsSamplingDensityDefaulted () const
 
std::string skyDiscretizationResolution () const
 
bool isCoarseSettings ()
 
bool isFineSettings ()
 
Setters
bool setAccumulatedRaysperRecord (int accumulatedRaysperRecord)
 
void resetAccumulatedRaysperRecord ()
 
bool setDirectThreshold (double directThreshold)
 
bool setDirectThreshold (const Quantity &directThreshold)
 
void resetDirectThreshold ()
 
bool setDirectCertainty (double directCertainty)
 
bool setDirectCertainty (const Quantity &directCertainty)
 
void resetDirectCertainty ()
 
bool setDirectJitter (double directJitter)
 
bool setDirectJitter (const Quantity &directJitter)
 
void resetDirectJitter ()
 
bool setDirectPretest (double directPretest)
 
bool setDirectPretest (const Quantity &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)
 
bool setLimitWeightVMX (const Quantity &limitWeightVMX)
 
void resetLimitWeightVMX ()
 
void setLimitWeightDMX (double limitWeightDMX)
 
bool setLimitWeightDMX (const Quantity &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...
 
std::vector< std::string > relationshipNames () const
 Return all valid relationship names. More...
 
std::vector< Relationshiprelationships () const
 Return all relationships for this ModelObject. More...
 
boost::optional< RelationshipgetRelationship (const std::string &name) const
 Get the relationship named name, if it exists. More...
 
bool setRelationship (const std::string &name, boost::optional< ModelObject > relatedModelObject)
 Set this ModelObject's relationship name to point to relatedModelObject (or clear the relationship if relatedModelObject == boost::none). More...
 
bool setRelationship (const std::string &name, const Component &component)
 Inserts component into this model and sets this ModelObject's relationship name to point to component.primaryObject(). More...
 
std::vector< std::string > attributeNames () const
 Return all valid attribute names. More...
 
std::vector
< openstudio::Attribute
attributes () const
 Return all Attributes for this ModelObject. More...
 
boost::optional
< openstudio::Attribute
getAttribute (const std::string &name) const
 Get the attribute named name, if it exists. More...
 
bool isSettableAttribute (const std::string &name) const
 Is the named attribute settable. More...
 
bool isOptionalAttribute (const std::string &name) const
 Is the named attribute optional. More...
 
bool setAttribute (const std::string &name, bool value)
 Set the attribute named name, if it exists. More...
 
bool setAttribute (const std::string &name, int value)
 
bool setAttribute (const std::string &name, unsigned value)
 
bool setAttribute (const std::string &name, double value)
 
bool setAttribute (const std::string &name, const Quantity &value)
 
bool setAttribute (const std::string &name, const std::string &value)
 
bool setAttribute (const std::string &name, const char *value)
 
bool resetAttribute (const std::string &name)
 Reset the attribute named name. 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...
 
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< LifeCycleCostlifeCycleCosts () const
 Returns the list of all LifeCycleCosts that refer to this object. More...
 
std::vector< IdfObjectremoveLifeCycleCosts ()
 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...
 
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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 
- Public Member Functions inherited from openstudio::WorkspaceObject
bool canBeSource () const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
std::vector< std::string > canBeTarget () const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
IdfObject idfObject ()
 
IdfObject idfObject () const
 
bool initialized () const
 
bool isSource () const
 
bool isTarget () const
 
unsigned numSources () const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool operator< (const WorkspaceObject &right) const
 
std::ostream & operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
 
std::vector
< openstudio::IdfObject
remove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
virtual ~WorkspaceObject ()
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
cast () const
 
std::vector< T > castVector (const std::vector< U > &objects)
 
std::vector< std::vector
< std::string > > 
clearExtensibleGroups ()
 
IdfObject clone (bool keepHandle=false) const
 
std::string comment () const
 
boost::optional< std::string > createName (bool overwrite=true)
 
std::vector< unsigned > dataFields () const
 
bool dataFieldsEqual (const IdfObject &other) const
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
std::vector< Handle > getHandles (const std::vector< T > &objects)
 
boost::optional< intgetInt (unsigned index, bool returnDefault=false) const
 
OSOptionalQuantity getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
 
boost::optional< std::string > getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
 
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
boost::optional< QUrl > getURL (unsigned index, bool returnDefault=false) const
 
Handle handle () const
 
IddObject iddObject () const
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
bool isDataField (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isValid (StrictnessLevel level) const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxFields () const
 
unsigned minExtensibleGroups () const
 
unsigned minFields () const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
std::string nameString (bool returnDefault=false) const
 
unsigned numExtensibleGroups () const
 
unsigned numFields () const
 
unsigned numNonextensibleFields () const
 
std::vector< unsigned > objectListFields () const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
std::ostream & operator<< (std::ostream &os, const IdfObject &IdfObject)
 
bool operator== (const IdfObject &other) const
 
boost::optional< T > optionalCast () const
 
std::vector< std::string > popExtensibleGroup ()
 
std::ostream & print (std::ostream &os) const
 
std::ostream & printField (std::ostream &os, unsigned index, bool isLastField=false) const
 
std::ostream & printName (std::ostream &os, bool hasFields=true) const
 
IdfExtensibleGroup pushExtensibleGroup ()
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
std::vector< unsigned > requiredFields () const
 
void setComment (const std::string &msg)
 
bool setDouble (unsigned index, double value)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setInt (unsigned index, int value)
 
boost::optional< std::string > setName (const std::string &newName)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setString (unsigned index, const std::string &value)
 
bool setUnsigned (unsigned index, unsigned value)
 
std::vector< T > subsetCastVector (const std::vector< U > &original)
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=true) const
 
virtual ~IdfObject ()
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 
static std::vector< std::string > skyDiscretizationResolutionValues ()
 
- Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObjectload (const std::string &text)
 
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
 
static int printedFieldSpace ()
 

Related Functions

(Note that these are not member functions.)

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

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional
< WorkspaceObject
OptionalWorkspaceObject
 
typedef std::vector
< WorkspaceObject
WorkspaceObjectVector
 
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject,
IdfObject
IdfObjectPair
 
typedef std::vector< IdfObjectIdfObjectVector
 
typedef boost::optional
< IdfObject
OptionalIdfObject
 
- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- Protected Types inherited from openstudio::WorkspaceObject
typedef
detail::WorkspaceObject_Impl 
ImplType
 
- Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_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)
 
- Protected Member Functions inherited from openstudio::WorkspaceObject
 WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)
 
- Protected Member Functions inherited from openstudio::IdfObject
 IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)
 

Detailed Description

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

Constructor & Destructor Documentation

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

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
Quantity openstudio::model::RadianceParameters::getDirectCertainty ( bool  returnIP = false) const
Quantity openstudio::model::RadianceParameters::getDirectJitter ( bool  returnIP = false) const
Quantity openstudio::model::RadianceParameters::getDirectPretest ( bool  returnIP = false) const
Quantity openstudio::model::RadianceParameters::getDirectThreshold ( bool  returnIP = false) const
Quantity openstudio::model::RadianceParameters::getLimitWeightDMX ( bool  returnIP = false) const
Quantity openstudio::model::RadianceParameters::getLimitWeightVMX ( bool  returnIP = false) const
static IddObjectType openstudio::model::RadianceParameters::iddObjectType ( )
static
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::setDirectCertainty ( const Quantity directCertainty)
bool openstudio::model::RadianceParameters::setDirectJitter ( double  directJitter)
bool openstudio::model::RadianceParameters::setDirectJitter ( const Quantity directJitter)
bool openstudio::model::RadianceParameters::setDirectPretest ( double  directPretest)
bool openstudio::model::RadianceParameters::setDirectPretest ( const Quantity directPretest)
bool openstudio::model::RadianceParameters::setDirectThreshold ( double  directThreshold)
bool openstudio::model::RadianceParameters::setDirectThreshold ( const Quantity directThreshold)
bool openstudio::model::RadianceParameters::setKlemsSamplingDensity ( int  klemsSamplingDensity)
void openstudio::model::RadianceParameters::setLimitWeightDMX ( double  limitWeightDMX)
bool openstudio::model::RadianceParameters::setLimitWeightDMX ( const Quantity limitWeightDMX)
bool openstudio::model::RadianceParameters::setLimitWeightVMX ( double  limitWeightVMX)
bool openstudio::model::RadianceParameters::setLimitWeightVMX ( const Quantity 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 ( )
static

Friends And Related Function Documentation

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