OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Related Functions | List of all members
openstudio::model::SiteGroundTemperatureUndisturbedXing Class Reference

#include <SiteGroundTemperatureUndisturbedXing.hpp>

+ Inheritance diagram for openstudio::model::SiteGroundTemperatureUndisturbedXing:

Public Member Functions

Constructors and Destructors
 SiteGroundTemperatureUndisturbedXing (const Model &model)
 
virtual ~SiteGroundTemperatureUndisturbedXing ()=default
 
 SiteGroundTemperatureUndisturbedXing (const SiteGroundTemperatureUndisturbedXing &other)=default
 
 SiteGroundTemperatureUndisturbedXing (SiteGroundTemperatureUndisturbedXing &&other)=default
 
SiteGroundTemperatureUndisturbedXingoperator= (const SiteGroundTemperatureUndisturbedXing &)=default
 
SiteGroundTemperatureUndisturbedXingoperator= (SiteGroundTemperatureUndisturbedXing &&)=default
 
Getters
double soilThermalConductivity () const
 
double soilDensity () const
 
double soilSpecificHeat () const
 
double averageSoilSurfaceTemperature () const
 
double soilSurfaceTemperatureAmplitude1 () const
 
double soilSurfaceTemperatureAmplitude2 () const
 
double phaseShiftofTemperatureAmplitude1 () const
 
double phaseShiftofTemperatureAmplitude2 () const
 
Setters
bool setSoilThermalConductivity (double soilThermalConductivity)
 
bool setSoilDensity (double soilDensity)
 
bool setSoilSpecificHeat (double soilSpecificHeat)
 
bool setAverageSoilSurfaceTemperature (double averageSoilSurfaceTemperature)
 
bool setSoilSurfaceTemperatureAmplitude1 (double soilSurfaceTemperatureAmplitude1)
 
bool setSoilSurfaceTemperatureAmplitude2 (double soilSurfaceTemperatureAmplitude2)
 
bool setPhaseShiftofTemperatureAmplitude1 (double phaseShiftofTemperatureAmplitude1)
 
bool setPhaseShiftofTemperatureAmplitude2 (double phaseShiftofTemperatureAmplitude2)
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (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< 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< 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< ScheduleTypeKeygetScheduleTypeKeys (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< ModelObjectconnectedObject (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 OptionalSiteGroundTemperatureUndisturbedXing = boost::optional< SiteGroundTemperatureUndisturbedXing >
 
using SiteGroundTemperatureUndisturbedXingVector = std::vector< SiteGroundTemperatureUndisturbedXing >
 

Additional Inherited Members

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

SiteGroundTemperatureUndisturbedXing is a ModelObject that wraps the OpenStudio IDD object 'OS_Site_GroundTemperature_UndisturbedXing'.

Constructor & Destructor Documentation

openstudio::model::SiteGroundTemperatureUndisturbedXing::SiteGroundTemperatureUndisturbedXing ( const Model model)
explicit
virtual openstudio::model::SiteGroundTemperatureUndisturbedXing::~SiteGroundTemperatureUndisturbedXing ( )
virtualdefault
openstudio::model::SiteGroundTemperatureUndisturbedXing::SiteGroundTemperatureUndisturbedXing ( const SiteGroundTemperatureUndisturbedXing other)
default
openstudio::model::SiteGroundTemperatureUndisturbedXing::SiteGroundTemperatureUndisturbedXing ( SiteGroundTemperatureUndisturbedXing &&  other)
default

Member Function Documentation

double openstudio::model::SiteGroundTemperatureUndisturbedXing::averageSoilSurfaceTemperature ( ) const
static IddObjectType openstudio::model::SiteGroundTemperatureUndisturbedXing::iddObjectType ( )
static
SiteGroundTemperatureUndisturbedXing& openstudio::model::SiteGroundTemperatureUndisturbedXing::operator= ( const SiteGroundTemperatureUndisturbedXing )
default
SiteGroundTemperatureUndisturbedXing& openstudio::model::SiteGroundTemperatureUndisturbedXing::operator= ( SiteGroundTemperatureUndisturbedXing &&  )
default
double openstudio::model::SiteGroundTemperatureUndisturbedXing::phaseShiftofTemperatureAmplitude1 ( ) const
double openstudio::model::SiteGroundTemperatureUndisturbedXing::phaseShiftofTemperatureAmplitude2 ( ) const
bool openstudio::model::SiteGroundTemperatureUndisturbedXing::setAverageSoilSurfaceTemperature ( double  averageSoilSurfaceTemperature)
bool openstudio::model::SiteGroundTemperatureUndisturbedXing::setPhaseShiftofTemperatureAmplitude1 ( double  phaseShiftofTemperatureAmplitude1)
bool openstudio::model::SiteGroundTemperatureUndisturbedXing::setPhaseShiftofTemperatureAmplitude2 ( double  phaseShiftofTemperatureAmplitude2)
bool openstudio::model::SiteGroundTemperatureUndisturbedXing::setSoilDensity ( double  soilDensity)
bool openstudio::model::SiteGroundTemperatureUndisturbedXing::setSoilSpecificHeat ( double  soilSpecificHeat)
bool openstudio::model::SiteGroundTemperatureUndisturbedXing::setSoilSurfaceTemperatureAmplitude1 ( double  soilSurfaceTemperatureAmplitude1)
bool openstudio::model::SiteGroundTemperatureUndisturbedXing::setSoilSurfaceTemperatureAmplitude2 ( double  soilSurfaceTemperatureAmplitude2)
bool openstudio::model::SiteGroundTemperatureUndisturbedXing::setSoilThermalConductivity ( double  soilThermalConductivity)
double openstudio::model::SiteGroundTemperatureUndisturbedXing::soilDensity ( ) const
double openstudio::model::SiteGroundTemperatureUndisturbedXing::soilSpecificHeat ( ) const
double openstudio::model::SiteGroundTemperatureUndisturbedXing::soilSurfaceTemperatureAmplitude1 ( ) const
double openstudio::model::SiteGroundTemperatureUndisturbedXing::soilSurfaceTemperatureAmplitude2 ( ) const
double openstudio::model::SiteGroundTemperatureUndisturbedXing::soilThermalConductivity ( ) const

Friends And Related Function Documentation