openstudio::model::AvailabilityManagerNightCycle Class Reference

#include <AvailabilityManagerNightCycle.hpp>

Inheritance diagram for openstudio::model::AvailabilityManagerNightCycle:

Public Member Functions
boost::optional< AirLoopHVAC >	airLoopHVAC () const
Schedule	applicabilitySchedule () const
	AvailabilityManagerNightCycle (const Model &model)
OS_DEPRECATED boost::optional < ThermalZone >	controlThermalZone () const
std::vector< ThermalZone >	controlThermalZones () const
std::string	controlType () const
std::vector< ThermalZone >	coolingControlThermalZones () const
double	cyclingRunTime () const
std::string	cyclingRunTimeControlType () const
boost::optional< Schedule >	fanSchedule () const
	Helper getter which will fetch the AirLoopHVAC::AvailabilitySchedule. More...
std::vector< ThermalZone >	heatingControlThermalZones () const
std::vector< ThermalZone >	heatingZoneFansOnlyThermalZones () const
bool	isControlTypeDefaulted () const
bool	isCyclingRunTimeControlTypeDefaulted () const
bool	isCyclingRunTimeDefaulted () const
bool	isThermostatToleranceDefaulted () const
OS_DEPRECATED void	resetControlThermalZone ()
void	resetControlThermalZones ()
void	resetControlType ()
void	resetCoolingControlThermalZones ()
void	resetCyclingRunTime ()
void	resetCyclingRunTimeControlType ()
void	resetHeatingControlThermalZones ()
void	resetHeatingZoneFansOnlyThermalZones ()
void	resetThermostatTolerance ()
bool	setApplicabilitySchedule (Schedule &schedule)
OS_DEPRECATED bool	setControlThermalZone (const ThermalZone &thermalZone)
bool	setControlThermalZones (const std::vector< ThermalZone > &thermalZones)
bool	setControlType (std::string controlType)
bool	setCoolingControlThermalZones (const std::vector< ThermalZone > &thermalZones)
bool	setCyclingRunTime (double cyclingRunTime)
bool	setCyclingRunTimeControlType (std::string cyclingRunTimeControlType)
bool	setHeatingControlThermalZones (const std::vector< ThermalZone > &thermalZones)
bool	setHeatingZoneFansOnlyThermalZones (const std::vector< ThermalZone > &thermalZones)
bool	setThermostatTolerance (double thermostatTolerance)
double	thermostatTolerance () const
virtual	~AvailabilityManagerNightCycle ()
Public Member Functions inherited from openstudio::model::AvailabilityManager
	AvailabilityManager (IddObjectType type, const Model &model)
boost::optional< Loop >	loop () const
virtual	~AvailabilityManager ()
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 std::vector< std::string >	controlTypeValues ()
static std::vector< std::string >	cyclingRunTimeControlTypeValues ()
static IddObjectType	iddObjectType ()

Related Functions
(Note that these are not member functions.)
typedef std::vector < AvailabilityManagerNightCycle >	AvailabilityManagerNightCycleVector
typedef boost::optional < AvailabilityManagerNightCycle >	OptionalAvailabilityManagerNightCycle
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
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

AvailabilityManagerNightCycle is a ModelObject that wraps the OpenStudio IDD object 'OS:AvailabilityManager:NightCycle'.

Constructor & Destructor Documentation

openstudio::model::AvailabilityManagerNightCycle::AvailabilityManagerNightCycle ( const Model &  model )

explicit

virtual openstudio::model::AvailabilityManagerNightCycle::~AvailabilityManagerNightCycle ( )

inlinevirtual

Member Function Documentation

boost::optional<AirLoopHVAC> openstudio::model::AvailabilityManagerNightCycle::airLoopHVAC

(

)

const

Schedule openstudio::model::AvailabilityManagerNightCycle::applicabilitySchedule

(

)

const

OS_DEPRECATED boost::optional<ThermalZone> openstudio::model::AvailabilityManagerNightCycle::controlThermalZone

(

)

const

Deprecated:

AvailabilityManagerNightCycle::controlThermalZone has been deprecated and will be removed in a future release, please use AvailabilityManagerNightCycle::controlThermalZones
Get the controlThermalZone if it's unique, otherwise returns the first one found and issues a warning.

std::vector<ThermalZone> openstudio::model::AvailabilityManagerNightCycle::controlThermalZones

(

)

const

std::string openstudio::model::AvailabilityManagerNightCycle::controlType

(

)

const

static std::vector<std::string> openstudio::model::AvailabilityManagerNightCycle::controlTypeValues ( )

static

std::vector<ThermalZone> openstudio::model::AvailabilityManagerNightCycle::coolingControlThermalZones

(

)

const

double openstudio::model::AvailabilityManagerNightCycle::cyclingRunTime

(

)

const

std::string openstudio::model::AvailabilityManagerNightCycle::cyclingRunTimeControlType

(

)

const

static std::vector<std::string> openstudio::model::AvailabilityManagerNightCycle::cyclingRunTimeControlTypeValues ( )

static

boost::optional<Schedule> openstudio::model::AvailabilityManagerNightCycle::fanSchedule

(

)

const

Helper getter which will fetch the AirLoopHVAC::AvailabilitySchedule.

std::vector<ThermalZone> openstudio::model::AvailabilityManagerNightCycle::heatingControlThermalZones

(

)

const

std::vector<ThermalZone> openstudio::model::AvailabilityManagerNightCycle::heatingZoneFansOnlyThermalZones

(

)

const

static IddObjectType openstudio::model::AvailabilityManagerNightCycle::iddObjectType ( )

static

bool openstudio::model::AvailabilityManagerNightCycle::isControlTypeDefaulted

(

)

const

bool openstudio::model::AvailabilityManagerNightCycle::isCyclingRunTimeControlTypeDefaulted

(

)

const

bool openstudio::model::AvailabilityManagerNightCycle::isCyclingRunTimeDefaulted

(

)

const

bool openstudio::model::AvailabilityManagerNightCycle::isThermostatToleranceDefaulted

(

)

const

OS_DEPRECATED void openstudio::model::AvailabilityManagerNightCycle::resetControlThermalZone

(

)

Deprecated:

AvailabilityManagerNightCycle::resetControlThermalZone has been deprecated and will be removed in a future release, please use AvailabilityManagerNightCycle::resetControlThermalZones
Resets the list of controlThermalZones

void openstudio::model::AvailabilityManagerNightCycle::resetControlThermalZones

(

)

void openstudio::model::AvailabilityManagerNightCycle::resetControlType

(

)

void openstudio::model::AvailabilityManagerNightCycle::resetCoolingControlThermalZones

(

)

void openstudio::model::AvailabilityManagerNightCycle::resetCyclingRunTime

(

)

void openstudio::model::AvailabilityManagerNightCycle::resetCyclingRunTimeControlType

(

)

void openstudio::model::AvailabilityManagerNightCycle::resetHeatingControlThermalZones

(

)

void openstudio::model::AvailabilityManagerNightCycle::resetHeatingZoneFansOnlyThermalZones

(

)

void openstudio::model::AvailabilityManagerNightCycle::resetThermostatTolerance

(

)

bool openstudio::model::AvailabilityManagerNightCycle::setApplicabilitySchedule

(

Schedule &

schedule

)

OS_DEPRECATED bool openstudio::model::AvailabilityManagerNightCycle::setControlThermalZone

(

const ThermalZone &

thermalZone

)

Deprecated:

AvailabilityManagerNightCycle::setControlThermalZone has been deprecated and will be removed in a future release, please use AvailabilityManagerNightCycle::setControlThermalZones
sets the list of controlThermalZones by calling setControlThermalZones([thermalZone])

bool openstudio::model::AvailabilityManagerNightCycle::setControlThermalZones

(

const std::vector< ThermalZone > &

thermalZones

)

bool openstudio::model::AvailabilityManagerNightCycle::setControlType

(

std::string

controlType

)

bool openstudio::model::AvailabilityManagerNightCycle::setCoolingControlThermalZones

(

const std::vector< ThermalZone > &

thermalZones

)

bool openstudio::model::AvailabilityManagerNightCycle::setCyclingRunTime

(

double

cyclingRunTime

)

bool openstudio::model::AvailabilityManagerNightCycle::setCyclingRunTimeControlType

(

std::string

cyclingRunTimeControlType

)

bool openstudio::model::AvailabilityManagerNightCycle::setHeatingControlThermalZones

(

const std::vector< ThermalZone > &

thermalZones

)

bool openstudio::model::AvailabilityManagerNightCycle::setHeatingZoneFansOnlyThermalZones

(

const std::vector< ThermalZone > &

thermalZones

)

bool openstudio::model::AvailabilityManagerNightCycle::setThermostatTolerance

(

double

thermostatTolerance

)

double openstudio::model::AvailabilityManagerNightCycle::thermostatTolerance

(

)

const

Friends And Related Function Documentation

typedef std::vector<AvailabilityManagerNightCycle> AvailabilityManagerNightCycleVector

related

typedef boost::optional<AvailabilityManagerNightCycle> OptionalAvailabilityManagerNightCycle

related