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

#include <AvailabilityManagerOptimumStart.hpp>

+ Inheritance diagram for openstudio::model::AvailabilityManagerOptimumStart:

Public Member Functions

Constructors and Destructors
 AvailabilityManagerOptimumStart (const Model &model)
 
virtual ~AvailabilityManagerOptimumStart ()=default
 
 AvailabilityManagerOptimumStart (const AvailabilityManagerOptimumStart &other)=default
 
 AvailabilityManagerOptimumStart (AvailabilityManagerOptimumStart &&other)=default
 
AvailabilityManagerOptimumStartoperator= (const AvailabilityManagerOptimumStart &)=default
 
AvailabilityManagerOptimumStartoperator= (AvailabilityManagerOptimumStart &&)=default
 
Getters
Schedule applicabilitySchedule () const
 
std::string controlType () const
 
boost::optional< ThermalZonecontrolZone () const
 
double maximumValueforOptimumStartTime () const
 
std::string controlAlgorithm () const
 
double constantTemperatureGradientduringCooling () const
 
double constantTemperatureGradientduringHeating () const
 
double initialTemperatureGradientduringCooling () const
 
double initialTemperatureGradientduringHeating () const
 
double constantStartTime () const
 
int numberofPreviousDays () const
 
Setters
bool setApplicabilitySchedule (Schedule &schedule)
 
bool setControlType (const std::string &controlType)
 
bool setControlZone (const ThermalZone &thermalZone)
 
void resetControlZone ()
 
bool setMaximumValueforOptimumStartTime (double maximumValueforOptimumStartTime)
 
bool setControlAlgorithm (const std::string &controlAlgorithm)
 
bool setConstantTemperatureGradientduringCooling (double constantTemperatureGradientduringCooling)
 
bool setConstantTemperatureGradientduringHeating (double constantTemperatureGradientduringHeating)
 
bool setInitialTemperatureGradientduringCooling (double initialTemperatureGradientduringCooling)
 
bool setInitialTemperatureGradientduringHeating (double initialTemperatureGradientduringHeating)
 
bool setConstantStartTime (double constantStartTime)
 
bool setNumberofPreviousDays (int numberofPreviousDays)
 
- Public Member Functions inherited from openstudio::model::AvailabilityManager
 AvailabilityManager (IddObjectType type, const Model &model)
 
 AvailabilityManager (const AvailabilityManager &other)=default
 
 AvailabilityManager (AvailabilityManager &&other)=default
 
boost::optional< Looploop () const
 
AvailabilityManageroperator= (const AvailabilityManager &)=default
 
AvailabilityManageroperator= (AvailabilityManager &&)=default
 
virtual ~AvailabilityManager ()=default
 
- 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 std::vector< std::string > controlAlgorithmValues ()
 
static std::vector< std::string > controlTypeValues ()
 
static IddObjectType iddObjectType ()
 

Related Functions

(Note that these are not member functions.)

using AvailabilityManagerOptimumStartVector = std::vector< AvailabilityManagerOptimumStart >
 
using OptionalAvailabilityManagerOptimumStart = boost::optional< AvailabilityManagerOptimumStart >
 

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

AvailabilityManagerOptimumStart is a AvailabilityManager that wraps the OpenStudio IDD object 'OS:AvailabilityManager:OptimumStart'.

Constructor & Destructor Documentation

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

Member Function Documentation

Schedule openstudio::model::AvailabilityManagerOptimumStart::applicabilitySchedule ( ) const
double openstudio::model::AvailabilityManagerOptimumStart::constantStartTime ( ) const
double openstudio::model::AvailabilityManagerOptimumStart::constantTemperatureGradientduringCooling ( ) const
double openstudio::model::AvailabilityManagerOptimumStart::constantTemperatureGradientduringHeating ( ) const
std::string openstudio::model::AvailabilityManagerOptimumStart::controlAlgorithm ( ) const
static std::vector<std::string> openstudio::model::AvailabilityManagerOptimumStart::controlAlgorithmValues ( )
static
std::string openstudio::model::AvailabilityManagerOptimumStart::controlType ( ) const
static std::vector<std::string> openstudio::model::AvailabilityManagerOptimumStart::controlTypeValues ( )
static
boost::optional<ThermalZone> openstudio::model::AvailabilityManagerOptimumStart::controlZone ( ) const
static IddObjectType openstudio::model::AvailabilityManagerOptimumStart::iddObjectType ( )
static
double openstudio::model::AvailabilityManagerOptimumStart::initialTemperatureGradientduringCooling ( ) const
double openstudio::model::AvailabilityManagerOptimumStart::initialTemperatureGradientduringHeating ( ) const
double openstudio::model::AvailabilityManagerOptimumStart::maximumValueforOptimumStartTime ( ) const
int openstudio::model::AvailabilityManagerOptimumStart::numberofPreviousDays ( ) const
AvailabilityManagerOptimumStart& openstudio::model::AvailabilityManagerOptimumStart::operator= ( const AvailabilityManagerOptimumStart )
default
AvailabilityManagerOptimumStart& openstudio::model::AvailabilityManagerOptimumStart::operator= ( AvailabilityManagerOptimumStart &&  )
default
void openstudio::model::AvailabilityManagerOptimumStart::resetControlZone ( )
bool openstudio::model::AvailabilityManagerOptimumStart::setApplicabilitySchedule ( Schedule schedule)
bool openstudio::model::AvailabilityManagerOptimumStart::setConstantStartTime ( double  constantStartTime)
bool openstudio::model::AvailabilityManagerOptimumStart::setConstantTemperatureGradientduringCooling ( double  constantTemperatureGradientduringCooling)
bool openstudio::model::AvailabilityManagerOptimumStart::setConstantTemperatureGradientduringHeating ( double  constantTemperatureGradientduringHeating)
bool openstudio::model::AvailabilityManagerOptimumStart::setControlAlgorithm ( const std::string &  controlAlgorithm)
bool openstudio::model::AvailabilityManagerOptimumStart::setControlType ( const std::string &  controlType)
bool openstudio::model::AvailabilityManagerOptimumStart::setControlZone ( const ThermalZone thermalZone)
bool openstudio::model::AvailabilityManagerOptimumStart::setInitialTemperatureGradientduringCooling ( double  initialTemperatureGradientduringCooling)
bool openstudio::model::AvailabilityManagerOptimumStart::setInitialTemperatureGradientduringHeating ( double  initialTemperatureGradientduringHeating)
bool openstudio::model::AvailabilityManagerOptimumStart::setMaximumValueforOptimumStartTime ( double  maximumValueforOptimumStartTime)
bool openstudio::model::AvailabilityManagerOptimumStart::setNumberofPreviousDays ( int  numberofPreviousDays)

Friends And Related Function Documentation