openstudio::model::ExternalInterfaceActuator Class Reference

#include <ExternalInterfaceActuator.hpp>

Inheritance diagram for openstudio::model::ExternalInterfaceActuator:

Public Member Functions
Constructors and Destructors
	ExternalInterfaceActuator (const ModelObject &modelObject)
	ExternalInterfaceActuator (const ModelObject &modelObject, const std::string actuatedComponentType, const std::string actuatedComponentControlType)
virtual	~ExternalInterfaceActuator ()
Getters
ModelObject	actuatedComponentUnique () const
std::string	actuatedComponentType () const
std::string	actuatedComponentControlType () const
boost::optional< double >	optionalInitialValue () const
bool	exportToBCVTB () const
bool	isExportToBCVTBDefaulted () const
Setters
bool	setActuatedComponentUnique (const ModelObject &modelObject)
bool	setActuatedComponentType (const std::string &actuatedComponentType)
bool	setActuatedComponentControlType (const std::string &actuatedComponentControlType)
bool	setOptionalInitialValue (double optionalInitialValue)
void	resetOptionalInitialValue ()
bool	setExportToBCVTB (bool exportToBCVTB)
void	resetExportToBCVTB ()
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...
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 IddObjectType	iddObjectType ()

Related Functions
(Note that these are not member functions.)
typedef std::vector < ExternalInterfaceActuator >	ExternalInterfaceActuatorVector
typedef boost::optional < ExternalInterfaceActuator >	OptionalExternalInterfaceActuator
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...
typedef std::pair< std::string, std::string >	ScheduleTypeKey
	Typedef for ScheduleTypeRegistry key. 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

ExternalInterfaceActuator is a ModelObject that wraps the OpenStudio IDD object 'OS:ExternalInterface:Actuator'.

Constructor & Destructor Documentation

openstudio::model::ExternalInterfaceActuator::ExternalInterfaceActuator ( const ModelObject &  modelObject )

explicit

openstudio::model::ExternalInterfaceActuator::ExternalInterfaceActuator ( const ModelObject &  modelObject, const std::string  actuatedComponentType, const std::string  actuatedComponentControlType  )

explicit

virtual openstudio::model::ExternalInterfaceActuator::~ExternalInterfaceActuator ( )

inlinevirtual

Member Function Documentation

std::string openstudio::model::ExternalInterfaceActuator::actuatedComponentControlType

(

)

const

std::string openstudio::model::ExternalInterfaceActuator::actuatedComponentType

(

)

const

ModelObject openstudio::model::ExternalInterfaceActuator::actuatedComponentUnique

(

)

const

bool openstudio::model::ExternalInterfaceActuator::exportToBCVTB

(

)

const

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

static

bool openstudio::model::ExternalInterfaceActuator::isExportToBCVTBDefaulted

(

)

const

boost::optional<double> openstudio::model::ExternalInterfaceActuator::optionalInitialValue

(

)

const

void openstudio::model::ExternalInterfaceActuator::resetExportToBCVTB

(

)

void openstudio::model::ExternalInterfaceActuator::resetOptionalInitialValue

(

)

bool openstudio::model::ExternalInterfaceActuator::setActuatedComponentControlType

(

const std::string &

actuatedComponentControlType

)

bool openstudio::model::ExternalInterfaceActuator::setActuatedComponentType

(

const std::string &

actuatedComponentType

)

bool openstudio::model::ExternalInterfaceActuator::setActuatedComponentUnique

(

const ModelObject &

modelObject

)

bool openstudio::model::ExternalInterfaceActuator::setExportToBCVTB

(

bool

exportToBCVTB

)

bool openstudio::model::ExternalInterfaceActuator::setOptionalInitialValue

(

double

optionalInitialValue

)

Friends And Related Function Documentation

typedef std::vector<ExternalInterfaceActuator> ExternalInterfaceActuatorVector

related

typedef boost::optional<ExternalInterfaceActuator> OptionalExternalInterfaceActuator

related