openstudio::model::TableLookup Class Reference

#include <TableLookup.hpp>

Inheritance diagram for openstudio::model::TableLookup:

Public Member Functions
Constructors and Destructors
	TableLookup (const Model &model)
	Create a TableLookup object with the specified number of independent variables. More...
virtual	~TableLookup ()=default
	TableLookup (const TableLookup &other)=default
	TableLookup (TableLookup &&other)=default
TableLookup &	operator= (const TableLookup &)=default
TableLookup &	operator= (TableLookup &&)=default
Getters
std::string	normalizationMethod () const
double	normalizationDivisor () const
boost::optional< double >	minimumOutput () const
boost::optional< double >	maximumOutput () const
std::string	outputUnitType () const
Setters
bool	setNormalizationMethod (const std::string &normalizationMethod)
bool	setNormalizationDivisor (double normalizationDivisior)
bool	setMinimumOutput (double minimumOutput)
void	resetMinimumOutput ()
bool	setMaximumOutput (double maximumOutput)
void	resetMaximumOutput ()
bool	setOutputUnitType (const std::string &outputUnitType)
Other
bool	addOutputValue (double outputValue)
bool	removeOutputValue (unsigned groupIndex)
void	removeAllOutputValues ()
std::vector< double >	outputValues () const
unsigned	numberofOutputValues () const
bool	setOutputValues (const std::vector< double > &outputValues)
bool	addIndependentVariable (const TableIndependentVariable &tableIndependentVariable)
bool	removeIndependentVariable (const TableIndependentVariable &tableIndependentVariable)
void	removeAllIndependentVariables ()
std::vector < TableIndependentVariable >	independentVariables () const
Public Member Functions inherited from openstudio::model::Curve
virtual	~Curve ()=default
	Curve (const Curve &other)=default
	Curve (Curve &&other)=default
Curve &	operator= (const Curve &)=default
Curve &	operator= (Curve &&)=default
int	numVariables () const
	Returns the number of independent variable values required to evaluate this Curve. More...
double	evaluate (const std::vector< double > &x) const
	Returns the value of this Curve at x. More...
double	evaluate (double x) const
	Convenience overload that throws if numVariables() != 1. More...
double	evaluate (double x, double y) const
	Convenience overload that throws if numVariables() != 2. More...
double	evaluate (double x, double y, double z) const
	Convenience overload that throws if numVariables() != 3. More...
double	evaluate (double w, double x, double y, double z) const
	Convenience overload that throws if numVariables() != 4. More...
double	evaluate (double v, double w, double x, double y, double z) const
	Convenience overload that throws if numVariables() != 5. More...
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 IddObjectType	iddObjectType ()
static std::vector< std::string >	normalizationMethodValues ()
static std::vector< std::string >	outputUnitTypeValues ()
static std::vector< std::string >	validNormalizationMethodValues ()
static std::vector< std::string >	validOutputUnitTypeValues ()

Related Functions
(Note that these are not member functions.)
using	OptionalTableLookup = boost::optional< TableLookup >
using	TableLookupVector = std::vector< TableLookup >
Related Functions inherited from openstudio::model::Curve
using	CurveVector = std::vector< Curve >
using	OptionalCurve = boost::optional< Curve >
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

TableLookup is a Curve that wraps the OpenStudio IDD object 'OS:Table:Lookup'.

Constructor & Destructor Documentation

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

explicit

Create a TableLookup object with the specified number of independent variables.

virtual openstudio::model::TableLookup::~TableLookup ( )

virtualdefault

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

default

openstudio::model::TableLookup::TableLookup ( TableLookup &&  other )

default

Member Function Documentation

bool openstudio::model::TableLookup::addIndependentVariable

(

const TableIndependentVariable &

tableIndependentVariable

)

bool openstudio::model::TableLookup::addOutputValue

(

double

outputValue

)

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

static

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

(

)

const

boost::optional<double> openstudio::model::TableLookup::maximumOutput

(

)

const

boost::optional<double> openstudio::model::TableLookup::minimumOutput

(

)

const

double openstudio::model::TableLookup::normalizationDivisor

(

)

const

std::string openstudio::model::TableLookup::normalizationMethod

(

)

const

static std::vector<std::string> openstudio::model::TableLookup::normalizationMethodValues ( )

static

unsigned openstudio::model::TableLookup::numberofOutputValues

(

)

const

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

default

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

default

std::string openstudio::model::TableLookup::outputUnitType

(

)

const

static std::vector<std::string> openstudio::model::TableLookup::outputUnitTypeValues ( )

static

std::vector<double> openstudio::model::TableLookup::outputValues

(

)

const

void openstudio::model::TableLookup::removeAllIndependentVariables

(

)

void openstudio::model::TableLookup::removeAllOutputValues

(

)

bool openstudio::model::TableLookup::removeIndependentVariable

(

const TableIndependentVariable &

tableIndependentVariable

)

bool openstudio::model::TableLookup::removeOutputValue

(

unsigned

groupIndex

)

void openstudio::model::TableLookup::resetMaximumOutput

(

)

void openstudio::model::TableLookup::resetMinimumOutput

(

)

bool openstudio::model::TableLookup::setMaximumOutput

(

double

maximumOutput

)

bool openstudio::model::TableLookup::setMinimumOutput

(

double

minimumOutput

)

bool openstudio::model::TableLookup::setNormalizationDivisor

(

double

normalizationDivisior

)

bool openstudio::model::TableLookup::setNormalizationMethod

(

const std::string &

normalizationMethod

)

bool openstudio::model::TableLookup::setOutputUnitType

(

const std::string &

outputUnitType

)

bool openstudio::model::TableLookup::setOutputValues

(

const std::vector< double > &

outputValues

)

static std::vector<std::string> openstudio::model::TableLookup::validNormalizationMethodValues ( )

static

static std::vector<std::string> openstudio::model::TableLookup::validOutputUnitTypeValues ( )

static

Friends And Related Function Documentation

using OptionalTableLookup = boost::optional<TableLookup>

related

using TableLookupVector = std::vector<TableLookup>

related