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

#include <ScheduleCompact.hpp>

+ Inheritance diagram for openstudio::model::ScheduleCompact:

Public Member Functions

Constructors and Destructors
 ScheduleCompact (const Model &model)
 Creates an empty (no values set for any days) ScheduleCompact. More...
 
 ScheduleCompact (const Model &model, double constantValue)
 Creates a ScheduleCompact with constantValue applied to the entire year. More...
 
virtual ~ScheduleCompact ()=default
 Creates a ScheduleCompact with constantValue applied to the entire year, if scheduleTypeLimits() and the units are compatible. More...
 
 ScheduleCompact (const ScheduleCompact &other)=default
 
 ScheduleCompact (ScheduleCompact &&other)=default
 
ScheduleCompactoperator= (const ScheduleCompact &)=default
 
ScheduleCompactoperator= (ScheduleCompact &&)=default
 
Setters
bool setToConstantValue (double value)
 Clears all existing data and sets the data so that value will be applied to the entire year. More...
 
Queries

If value can be converted to scheduleTypeLimit()'s units, then all existing data is cleared and value is set (after unit conversion, if necessary).

bool isConstantValue () const
 Returns true if this ScheduleCompact has a single value applied to the entire year. More...
 
boost::optional< double > constantValue () const
 Returns this ScheduleCompact's constant value, if this ScheduleCompact conforms to that pattern. More...
 
- Public Member Functions inherited from openstudio::model::Schedule
virtual ~Schedule ()=default
 
 Schedule (const Schedule &other)=default
 
 Schedule (Schedule &&other)=default
 
Scheduleoperator= (const Schedule &)=default
 
Scheduleoperator= (Schedule &&)=default
 
- Public Member Functions inherited from openstudio::model::ScheduleBase
virtual ~ScheduleBase ()=default
 
 ScheduleBase (const ScheduleBase &other)=default
 
 ScheduleBase (ScheduleBase &&other)=default
 
ScheduleBaseoperator= (const ScheduleBase &)=default
 
ScheduleBaseoperator= (ScheduleBase &&)=default
 
boost::optional
< ScheduleTypeLimits
scheduleTypeLimits () const
 Returns the ScheduleTypeLimits of this object, if set. More...
 
bool setScheduleTypeLimits (const ScheduleTypeLimits &scheduleTypeLimits)
 Returns true if scheduleTypeLimits is compatible with this object and is actually set. More...
 
bool resetScheduleTypeLimits ()
 Returns true if the scheduleTypeLimits() of this object is successfully cleared. More...
 
void ensureNoLeapDays ()
 
- Public Member Functions inherited from openstudio::model::ResourceObject
unsigned directUseCount (bool excludeChildren=false) const
 Returns the number of objects that use this resource directly. More...
 
unsigned nonResourceObjectUseCount (bool excludeChildren=false) const
 Returns the number of non-ResourceObjects that use this resource either directly or indirectly. More...
 
ResourceObjectoperator= (const ResourceObject &)=default
 
ResourceObjectoperator= (ResourceObject &&)=default
 
 ResourceObject (const ResourceObject &other)=default
 
 ResourceObject (ResourceObject &&other)=default
 
virtual ~ResourceObject ()=default
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject ()=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 IddObjectType iddObjectType ()
 

Protected Types

using ImplType = detail::ScheduleCompact_Impl
 
- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 

Protected Member Functions

 ScheduleCompact (std::shared_ptr< detail::ScheduleCompact_Impl > impl)
 
- Protected Member Functions inherited from openstudio::model::ResourceObject
 ResourceObject (IddObjectType type, const Model &model)
 Constructs a new PlanarSurface object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::ParentObject
 ParentObject (IddObjectType type, const Model &model)
 Constructs a new ParentObject 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.)

using OptionalScheduleCompact = boost::optional< ScheduleCompact >
 
using ScheduleCompactVector = std::vector< ScheduleCompact >
 

Detailed Description

ScheduleCompact is a Schedule that wraps the OpenStudio IDD object 'OS:Schedule:Compact'.

Member Typedef Documentation

using openstudio::model::ScheduleCompact::ImplType = detail::ScheduleCompact_Impl
protected

Constructor & Destructor Documentation

openstudio::model::ScheduleCompact::ScheduleCompact ( const Model model)
explicit

Creates an empty (no values set for any days) ScheduleCompact.

openstudio::model::ScheduleCompact::ScheduleCompact ( const Model model,
double  constantValue 
)

Creates a ScheduleCompact with constantValue applied to the entire year.

virtual openstudio::model::ScheduleCompact::~ScheduleCompact ( )
virtualdefault

Creates a ScheduleCompact with constantValue applied to the entire year, if scheduleTypeLimits() and the units are compatible.

Otherwise creates an empty ScheduleCompact.

openstudio::model::ScheduleCompact::ScheduleCompact ( const ScheduleCompact other)
default
openstudio::model::ScheduleCompact::ScheduleCompact ( ScheduleCompact &&  other)
default
openstudio::model::ScheduleCompact::ScheduleCompact ( std::shared_ptr< detail::ScheduleCompact_Impl >  impl)
explicitprotected

Member Function Documentation

boost::optional<double> openstudio::model::ScheduleCompact::constantValue ( ) const

Returns this ScheduleCompact's constant value, if this ScheduleCompact conforms to that pattern.

Otherwise returns boost::none (evaluates to false).

static IddObjectType openstudio::model::ScheduleCompact::iddObjectType ( )
static
bool openstudio::model::ScheduleCompact::isConstantValue ( ) const

Returns true if this ScheduleCompact has a single value applied to the entire year.

(Roughly–the text fields are not checked.)

ScheduleCompact& openstudio::model::ScheduleCompact::operator= ( const ScheduleCompact )
default
ScheduleCompact& openstudio::model::ScheduleCompact::operator= ( ScheduleCompact &&  )
default
bool openstudio::model::ScheduleCompact::setToConstantValue ( double  value)

Clears all existing data and sets the data so that value will be applied to the entire year.

Friends And Related Function Documentation

using OptionalScheduleCompact = boost::optional<ScheduleCompact>
related
using ScheduleCompactVector = std::vector<ScheduleCompact>
related