#include <AvailabilityManagerNightCycle.hpp>

Inheritance diagram for openstudio::model::AvailabilityManagerNightCycle:

Public Member Functions
	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

Quantity	getCyclingRunTime (bool returnIP=false) const

Quantity	getThermostatTolerance (bool returnIP=false) const

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 ()

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	setCyclingRunTime (const Quantity &cyclingRunTime)

bool	setCyclingRunTimeControlType (std::string cyclingRunTimeControlType)

bool	setHeatingControlThermalZones (const std::vector< ThermalZone > &thermalZones)

bool	setHeatingZoneFansOnlyThermalZones (const std::vector< ThermalZone > &thermalZones)

bool	setThermostatTolerance (const Quantity &thermostatTolerance)

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...

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< ModelObject >	connectedObject (unsigned port) const

boost::optional< unsigned >	connectedObjectPort (unsigned port) const

Public Member Functions inherited from openstudio::WorkspaceObject
bool	canBeSource () const

bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const

std::vector< std::string >	canBeTarget () const

std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const

std::vector< WorkspaceObject >	getSources (IddObjectType type) const

boost::optional< WorkspaceObject >	getTarget (unsigned index) const

IdfObject	idfObject ()

IdfObject	idfObject () const

bool	initialized () const

bool	isSource () const

bool	isTarget () const

unsigned	numSources () const

bool	objectListFieldsEqual (const WorkspaceObject &other) const

bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const

bool	operator< (const WorkspaceObject &right) const

std::ostream &	operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)

std::vector < openstudio::IdfObject >	remove ()

bool	setPointer (unsigned index, const Handle &targetHandle)

std::vector< WorkspaceObject >	sources () const

std::vector< WorkspaceObject >	targets () const

Workspace	workspace () const

virtual	~WorkspaceObject ()

Public Member Functions inherited from openstudio::IdfObject
std::string	briefDescription () const

T	cast () const

std::vector< T >	castVector (const std::vector< U > &objects)

std::vector< std::vector < std::string > >	clearExtensibleGroups ()

IdfObject	clone (bool keepHandle=false) const

std::string	comment () const

boost::optional< std::string >	createName (bool overwrite=true)

std::vector< unsigned >	dataFields () const

bool	dataFieldsEqual (const IdfObject &other) const

std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)

std::vector< IdfExtensibleGroup >	extensibleGroups () const

boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const

boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const

IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const

std::vector< Handle >	getHandles (const std::vector< T > &objects)

boost::optional< int >	getInt (unsigned index, bool returnDefault=false) const

OSOptionalQuantity	getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const

boost::optional< std::string >	getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const

boost::optional< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const

boost::optional< QUrl >	getURL (unsigned index, bool returnDefault=false) const

Handle	handle () const

IddObject	iddObject () const

	IdfObject (IddObjectType type, bool fastName=false)

	IdfObject (const IddObject &, bool fastName=false)

	IdfObject (const IdfObject &other)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)

bool	isDataField (unsigned index) const

bool	isEmpty (unsigned index) const

bool	isObjectListField (unsigned index) const

bool	isValid (StrictnessLevel level, bool checkNames=false) const

boost::optional< unsigned >	maxExtensibleGroups () const

boost::optional< unsigned >	maxFields () const

unsigned	minExtensibleGroups () const

unsigned	minFields () const

boost::optional< std::string >	name (bool returnDefault=false) const

std::string	nameString (bool returnDefault=false) const

unsigned	numExtensibleGroups () const

unsigned	numFields () const

unsigned	numNonextensibleFields () const

std::vector< unsigned >	objectListFields () const

bool	objectListFieldsEqual (const IdfObject &other) const

bool	objectListFieldsNonConflicting (const IdfObject &other) const

bool	operator!= (const IdfObject &other) const

std::ostream &	operator<< (std::ostream &os, const IdfObject &IdfObject)

bool	operator== (const IdfObject &other) const

boost::optional< T >	optionalCast () const

std::vector< std::string >	popExtensibleGroup ()

std::ostream &	print (std::ostream &os) const

std::ostream &	printField (std::ostream &os, unsigned index, bool isLastField=false) const

std::ostream &	printName (std::ostream &os, bool hasFields=true) const

IdfExtensibleGroup	pushExtensibleGroup ()

IdfExtensibleGroup	pushExtensibleGroup (const std::vector< std::string > &values)

std::vector< unsigned >	requiredFields () const

void	setComment (const std::string &msg)

bool	setDouble (unsigned index, double value)

bool	setFieldComment (unsigned index, const std::string &cmnt)

bool	setInt (unsigned index, int value)

boost::optional< std::string >	setName (const std::string &newName)

bool	setQuantity (unsigned index, const Quantity &q)

bool	setString (unsigned index, const std::string &value)

bool	setUnsigned (unsigned index, unsigned value)

std::vector< T >	subsetCastVector (const std::vector< U > &original)

ValidityReport	validityReport (StrictnessLevel level, bool checkNames=false) const

virtual	~IdfObject ()

Static Public Member Functions
static std::vector< std::string >	controlTypeValues ()

static std::vector< std::string >	cyclingRunTimeControlTypeValues ()

static IddObjectType	iddObjectType ()

Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObject >	load (const std::string &text)

static boost::optional< IdfObject >	load (const std::string &text, const IddObject &iddObject)

static int	printedFieldSpace ()

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...

typedef std::pair< std::string, std::string >	ScheduleTypeKey
	Typedef for ScheduleTypeRegistry key. More...

Additional Inherited Members
Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional < WorkspaceObject >	OptionalWorkspaceObject

typedef std::vector < WorkspaceObject >	WorkspaceObjectVector

Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject, IdfObject >	IdfObjectPair

typedef std::vector< IdfObject >	IdfObjectVector

typedef boost::optional < IdfObject >	OptionalIdfObject

Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl	ImplType

Protected Types inherited from openstudio::WorkspaceObject
typedef detail::WorkspaceObject_Impl	ImplType

Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_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)

Protected Member Functions inherited from openstudio::WorkspaceObject
	WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)

Protected Member Functions inherited from openstudio::IdfObject
	IdfObject (std::shared_ptr< detail::IdfObject_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

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

Quantity openstudio::model::AvailabilityManagerNightCycle::getCyclingRunTime ( bool returnIP = false ) const

Quantity openstudio::model::AvailabilityManagerNightCycle::getThermostatTolerance ( bool returnIP = false ) const

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 ( )

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::setCyclingRunTime ( const Quantity & 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 ( const Quantity & thermostatTolerance )

bool openstudio::model::AvailabilityManagerNightCycle::setThermostatTolerance ( double thermostatTolerance )

double openstudio::model::AvailabilityManagerNightCycle::thermostatTolerance ( ) const

Friends And Related Function Documentation

typedef std::vector<AvailabilityManagerNightCycle> AvailabilityManagerNightCycleVector

Public Member Functions

Static Public Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation