openstudio::model::TableIndependentVariable Class Reference

#include <TableIndependentVariable.hpp>

Inheritance diagram for openstudio::model::TableIndependentVariable:

Public Member Functions
Constructors and Destructors
	TableIndependentVariable (const Model &model)
virtual	~TableIndependentVariable ()=default
	TableIndependentVariable (const TableIndependentVariable &other)=default
	TableIndependentVariable (TableIndependentVariable &&other)=default
TableIndependentVariable &	operator= (const TableIndependentVariable &)=default
TableIndependentVariable &	operator= (TableIndependentVariable &&)=default
Getters
std::string	interpolationMethod () const
std::string	extrapolationMethod () const
boost::optional< double >	minimumValue () const
boost::optional< double >	maximumValue () const
boost::optional< double >	normalizationReferenceValue () const
std::string	unitType () const
Setters
bool	setInterpolationMethod (const std::string &interpolationMethod)
bool	setExtrapolationMethod (const std::string &extrapolationMethod)
bool	setMinimumValue (double minimumValue)
void	resetMinimumValue ()
bool	setMaximumValue (double maximumValue)
void	resetMaximumValue ()
bool	setNormalizationReferenceValue (double normalizationReferenceValue)
void	resetNormalizationReferenceValue ()
bool	setUnitType (const std::string &unitType)
Other
std::vector< TableLookup >	tableLookups () const
bool	addValue (double value)
bool	removeValue (unsigned groupIndex)
void	removeAllValues ()
std::vector< double >	values () const
bool	setValues (const std::vector< double > &values)
unsigned	numberofValues () const
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...
ResourceObject &	operator= (const ResourceObject &)=default
ResourceObject &	operator= (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< ModelObject >	children () const
	Return direct child objects in the Model. More...
ParentObject &	operator= (const ParentObject &)=default
ParentObject &	operator= (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
ModelObject &	operator= (const ModelObject &)=default
ModelObject &	operator= (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< 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 (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< ModelObject >	connectedObject (unsigned port) const
boost::optional< unsigned >	connectedObjectPort (unsigned port) const

Static Public Member Functions
static std::vector< std::string >	extrapolationMethodValues ()
static IddObjectType	iddObjectType ()
static std::vector< std::string >	interpolationMethodValues ()
static std::vector< std::string >	unitTypeValues ()
static std::vector< std::string >	validExtrapolationMethodValues ()
static std::vector< std::string >	validInterpolationMethodValues ()
static std::vector< std::string >	validUnitTypeValues ()

Related Functions
(Note that these are not member functions.)
using	OptionalTableIndependentVariable = boost::optional< TableIndependentVariable >
using	TableIndependentVariableVector = std::vector< TableIndependentVariable >
Related Functions inherited from openstudio::model::ResourceObject
using	OptionalResourceObject = boost::optional< ResourceObject >
using	ResourceObjectVector = std::vector< ResourceObject >
Related Functions inherited from openstudio::model::ParentObject
std::vector< ModelObject >	getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true)
	Returns object and all other objects accessible by calling children() on encountered ParentObjects . More...
std::vector< ModelObject >	getRecursiveChildrenAndResources (const ModelObject &object)
	Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More...
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
using	ImplType = detail::ModelObject_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)

Detailed Description

TableIndependentVariable is a ResourceObject that wraps the OpenStudio IDD object 'OS:Table:IndependentVariable'.

Constructor & Destructor Documentation

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

explicit

virtual openstudio::model::TableIndependentVariable::~TableIndependentVariable ( )

virtualdefault

openstudio::model::TableIndependentVariable::TableIndependentVariable ( const TableIndependentVariable &  other )

default

openstudio::model::TableIndependentVariable::TableIndependentVariable ( TableIndependentVariable &&  other )

default

Member Function Documentation

bool openstudio::model::TableIndependentVariable::addValue

(

double

value

)

std::string openstudio::model::TableIndependentVariable::extrapolationMethod

(

)

const

static std::vector<std::string> openstudio::model::TableIndependentVariable::extrapolationMethodValues ( )

static

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

static

std::string openstudio::model::TableIndependentVariable::interpolationMethod

(

)

const

static std::vector<std::string> openstudio::model::TableIndependentVariable::interpolationMethodValues ( )

static

boost::optional<double> openstudio::model::TableIndependentVariable::maximumValue

(

)

const

boost::optional<double> openstudio::model::TableIndependentVariable::minimumValue

(

)

const

boost::optional<double> openstudio::model::TableIndependentVariable::normalizationReferenceValue

(

)

const

unsigned openstudio::model::TableIndependentVariable::numberofValues

(

)

const

TableIndependentVariable& openstudio::model::TableIndependentVariable::operator= ( const TableIndependentVariable &  )

default

TableIndependentVariable& openstudio::model::TableIndependentVariable::operator= ( TableIndependentVariable &&  )

default

void openstudio::model::TableIndependentVariable::removeAllValues

(

)

bool openstudio::model::TableIndependentVariable::removeValue

(

unsigned

groupIndex

)

void openstudio::model::TableIndependentVariable::resetMaximumValue

(

)

void openstudio::model::TableIndependentVariable::resetMinimumValue

(

)

void openstudio::model::TableIndependentVariable::resetNormalizationReferenceValue

(

)

bool openstudio::model::TableIndependentVariable::setExtrapolationMethod

(

const std::string &

extrapolationMethod

)

bool openstudio::model::TableIndependentVariable::setInterpolationMethod

(

const std::string &

interpolationMethod

)

bool openstudio::model::TableIndependentVariable::setMaximumValue

(

double

maximumValue

)

bool openstudio::model::TableIndependentVariable::setMinimumValue

(

double

minimumValue

)

bool openstudio::model::TableIndependentVariable::setNormalizationReferenceValue

(

double

normalizationReferenceValue

)

bool openstudio::model::TableIndependentVariable::setUnitType

(

const std::string &

unitType

)

bool openstudio::model::TableIndependentVariable::setValues

(

const std::vector< double > &

values

)

std::vector<TableLookup> openstudio::model::TableIndependentVariable::tableLookups

(

)

const

std::string openstudio::model::TableIndependentVariable::unitType

(

)

const

static std::vector<std::string> openstudio::model::TableIndependentVariable::unitTypeValues ( )

static

static std::vector<std::string> openstudio::model::TableIndependentVariable::validExtrapolationMethodValues ( )

static

static std::vector<std::string> openstudio::model::TableIndependentVariable::validInterpolationMethodValues ( )

static

static std::vector<std::string> openstudio::model::TableIndependentVariable::validUnitTypeValues ( )

static

std::vector<double> openstudio::model::TableIndependentVariable::values

(

)

const

Friends And Related Function Documentation

using OptionalTableIndependentVariable = boost::optional<TableIndependentVariable>

related

using TableIndependentVariableVector = std::vector<TableIndependentVariable>

related