#include <ShadowCalculation.hpp>
Public Member Functions | |
virtual | ~ShadowCalculation () |
Getters | |
std::string | shadingCalculationMethod () const |
std::string | shadingCalculationUpdateFrequencyMethod () const |
bool | isShadingCalculationUpdateFrequencyMethodDefaulted () const |
int | shadingCalculationUpdateFrequency () const |
bool | isShadingCalculationUpdateFrequencyDefaulted () const |
int | maximumFiguresInShadowOverlapCalculations () const |
bool | isMaximumFiguresInShadowOverlapCalculationsDefaulted () const |
std::string | polygonClippingAlgorithm () const |
int | pixelCountingResolution () const |
std::string | skyDiffuseModelingAlgorithm () const |
bool | outputExternalShadingCalculationResults () const |
bool | disableSelfShadingWithinShadingZoneGroups () const |
bool | disableSelfShadingFromShadingZoneGroupstoOtherZones () const |
unsigned int | numberofShadingZoneGroups () const |
std::vector< ThermalZone > | getShadingZoneGroup (unsigned groupIndex) const |
Setters | |
bool | setShadingCalculationMethod (const std::string &shadingCalculationMethod) |
bool | setShadingCalculationUpdateFrequencyMethod (const std::string &shadingCalculationUpdateFrequencyMethod) |
void | resetShadingCalculationUpdateFrequencyMethod () |
bool | setShadingCalculationUpdateFrequency (int shadingCalculationUpdateFrequency) |
void | resetShadingCalculationUpdateFrequency () |
bool | setMaximumFiguresInShadowOverlapCalculations (int maximumFiguresInShadowOverlapCalculations) |
void | resetMaximumFiguresInShadowOverlapCalculations () |
bool | setPolygonClippingAlgorithm (const std::string &polygonClippingAlgorithm) |
void | resetPolygonClippingAlgorithm () |
bool | setPixelCountingResolution (int pixelCountingResolution) |
bool | setSkyDiffuseModelingAlgorithm (const std::string &skyDiffuseModelingAlgorithm) |
void | resetSkyDiffuseModelingAlgorithm () |
bool | setOutputExternalShadingCalculationResults (bool outputExternalShadingCalculationResults) |
bool | setDisableSelfShadingWithinShadingZoneGroups (bool disableSelfShadingWithinShadingZoneGroups) |
bool | setDisableSelfShadingFromShadingZoneGroupstoOtherZones (bool disableSelfShadingFromShadingZoneGroupstoOtherZones) |
bool | addShadingZoneGroup (const std::vector< ThermalZone > &thermalZones) |
bool | removeShadingZoneGroup (unsigned groupIndex) |
void | removeAllShadingZoneGroups () |
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< 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 (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< ModelObject > | connectedObject (unsigned port) const |
boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Static Public Member Functions | |
Static Methods | |
static IddObjectType | iddObjectType () |
static std::vector< std::string > | shadingCalculationMethodValues () |
static std::vector< std::string > | validShadingCalculationMethodValues () |
static std::vector< std::string > | shadingCalculationUpdateFrequencyMethodValues () |
static std::vector< std::string > | validShadingCalculationUpdateFrequencyMethodValues () |
static std::vector< std::string > | polygonClippingAlgorithmValues () |
static std::vector< std::string > | validPolygonClippingAlgorithmValues () |
static std::vector< std::string > | skyDiffuseModelingAlgorithmValues () |
static std::vector< std::string > | validSkyDiffuseModelingAlgorithmValues () |
Protected Member Functions | |
Constructors and Destructors | |
ShadowCalculation (const Model &model) | |
Constructs a new ShadowCalculation 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) | |
Related Functions | |
(Note that these are not member functions.) | |
typedef boost::optional < ShadowCalculation > | OptionalShadowCalculation |
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 | |
typedef detail::ModelObject_Impl | ImplType |
ShadowCalculation derives from ModelObject and is an interface to the OpenStudio IDD object named "ShadowCalculation".
ShadowCalculation defines how often shadowing calculations should be performed in EnergyPlus simulations as well as how many overlapping figures can be considered in a shadow calculation. ShadowCalculation does not have a public constructor because it is a unique ModelObject. To get the ShadowCalculation object for a Model or create one if it does not yet exist use model.getUniqueObject<ShadowCalculation>(). To get the ShadowCalculation object for a Model but not create one if it does not yet exist use model.getOptionalUniqueObject<ShadowCalculation>().
|
inlinevirtual |
|
explicitprotected |
Constructs a new ShadowCalculation object in the model.
bool openstudio::model::ShadowCalculation::addShadingZoneGroup | ( | const std::vector< ThermalZone > & | thermalZones | ) |
bool openstudio::model::ShadowCalculation::disableSelfShadingFromShadingZoneGroupstoOtherZones | ( | ) | const |
bool openstudio::model::ShadowCalculation::disableSelfShadingWithinShadingZoneGroups | ( | ) | const |
std::vector<ThermalZone> openstudio::model::ShadowCalculation::getShadingZoneGroup | ( | unsigned | groupIndex | ) | const |
|
static |
bool openstudio::model::ShadowCalculation::isMaximumFiguresInShadowOverlapCalculationsDefaulted | ( | ) | const |
bool openstudio::model::ShadowCalculation::isShadingCalculationUpdateFrequencyDefaulted | ( | ) | const |
bool openstudio::model::ShadowCalculation::isShadingCalculationUpdateFrequencyMethodDefaulted | ( | ) | const |
int openstudio::model::ShadowCalculation::maximumFiguresInShadowOverlapCalculations | ( | ) | const |
unsigned int openstudio::model::ShadowCalculation::numberofShadingZoneGroups | ( | ) | const |
bool openstudio::model::ShadowCalculation::outputExternalShadingCalculationResults | ( | ) | const |
int openstudio::model::ShadowCalculation::pixelCountingResolution | ( | ) | const |
std::string openstudio::model::ShadowCalculation::polygonClippingAlgorithm | ( | ) | const |
|
static |
void openstudio::model::ShadowCalculation::removeAllShadingZoneGroups | ( | ) |
bool openstudio::model::ShadowCalculation::removeShadingZoneGroup | ( | unsigned | groupIndex | ) |
void openstudio::model::ShadowCalculation::resetMaximumFiguresInShadowOverlapCalculations | ( | ) |
void openstudio::model::ShadowCalculation::resetPolygonClippingAlgorithm | ( | ) |
void openstudio::model::ShadowCalculation::resetShadingCalculationUpdateFrequency | ( | ) |
void openstudio::model::ShadowCalculation::resetShadingCalculationUpdateFrequencyMethod | ( | ) |
void openstudio::model::ShadowCalculation::resetSkyDiffuseModelingAlgorithm | ( | ) |
bool openstudio::model::ShadowCalculation::setDisableSelfShadingFromShadingZoneGroupstoOtherZones | ( | bool | disableSelfShadingFromShadingZoneGroupstoOtherZones | ) |
bool openstudio::model::ShadowCalculation::setDisableSelfShadingWithinShadingZoneGroups | ( | bool | disableSelfShadingWithinShadingZoneGroups | ) |
bool openstudio::model::ShadowCalculation::setMaximumFiguresInShadowOverlapCalculations | ( | int | maximumFiguresInShadowOverlapCalculations | ) |
bool openstudio::model::ShadowCalculation::setOutputExternalShadingCalculationResults | ( | bool | outputExternalShadingCalculationResults | ) |
bool openstudio::model::ShadowCalculation::setPixelCountingResolution | ( | int | pixelCountingResolution | ) |
bool openstudio::model::ShadowCalculation::setPolygonClippingAlgorithm | ( | const std::string & | polygonClippingAlgorithm | ) |
bool openstudio::model::ShadowCalculation::setShadingCalculationMethod | ( | const std::string & | shadingCalculationMethod | ) |
bool openstudio::model::ShadowCalculation::setShadingCalculationUpdateFrequency | ( | int | shadingCalculationUpdateFrequency | ) |
bool openstudio::model::ShadowCalculation::setShadingCalculationUpdateFrequencyMethod | ( | const std::string & | shadingCalculationUpdateFrequencyMethod | ) |
bool openstudio::model::ShadowCalculation::setSkyDiffuseModelingAlgorithm | ( | const std::string & | skyDiffuseModelingAlgorithm | ) |
std::string openstudio::model::ShadowCalculation::shadingCalculationMethod | ( | ) | const |
|
static |
int openstudio::model::ShadowCalculation::shadingCalculationUpdateFrequency | ( | ) | const |
std::string openstudio::model::ShadowCalculation::shadingCalculationUpdateFrequencyMethod | ( | ) | const |
|
static |
std::string openstudio::model::ShadowCalculation::skyDiffuseModelingAlgorithm | ( | ) | const |
|
static |
|
static |
|
static |
|
static |
|
static |
|
related |