openstudio::model::TableMultiVariableLookup Class Reference

#include <TableMultiVariableLookup.hpp>

Inheritance diagram for openstudio::model::TableMultiVariableLookup:

Public Member Functions
Getters
std::string	interpolationMethod () const
bool	isInterpolationMethodDefaulted () const
int	numberofInterpolationPoints () const
bool	isNumberofInterpolationPointsDefaulted () const
boost::optional< std::string >	curveType () const
std::string	tableDataFormat () const
bool	isTableDataFormatDefaulted () const
boost::optional< double >	normalizationReference () const
boost::optional< double >	minimumValueofX1 () const
boost::optional< double >	maximumValueofX1 () const
boost::optional< double >	minimumValueofX2 () const
boost::optional< double >	maximumValueofX2 () const
boost::optional< double >	minimumValueofX3 () const
boost::optional< double >	maximumValueofX3 () const
boost::optional< double >	minimumValueofX4 () const
boost::optional< double >	maximumValueofX4 () const
boost::optional< double >	minimumValueofX5 () const
boost::optional< double >	maximumValueofX5 () const
boost::optional< double >	minimumTableOutput () const
boost::optional< double >	maximumTableOutput () const
std::string	inputUnitTypeforX1 () const
bool	isInputUnitTypeforX1Defaulted () const
std::string	inputUnitTypeforX2 () const
bool	isInputUnitTypeforX2Defaulted () const
std::string	inputUnitTypeforX3 () const
bool	isInputUnitTypeforX3Defaulted () const
std::string	inputUnitTypeforX4 () const
bool	isInputUnitTypeforX4Defaulted () const
std::string	inputUnitTypeforX5 () const
bool	isInputUnitTypeforX5Defaulted () const
std::string	outputUnitType () const
bool	isOutputUnitTypeDefaulted () const
int	numberofIndependentVariables () const
std::string	printTable (unsigned int precision=3) const
	Print a fixed-width table of the points, precision is the number of decimals.
Setters
bool	setInterpolationMethod (const std::string &interpolationMethod)
void	resetInterpolationMethod ()
bool	setNumberofInterpolationPoints (int numberofInterpolationPoints)
void	resetNumberofInterpolationPoints ()
bool	setCurveType (const std::string &curveType)
void	resetCurveType ()
bool	setTableDataFormat (const std::string &tableDataFormat)
void	resetTableDataFormat ()
bool	setNormalizationReference (double normalizationReference)
void	resetNormalizationReference ()
bool	setMinimumValueofX1 (double minimumValueofX1)
void	resetMinimumValueofX1 ()
bool	setMaximumValueofX1 (double maximumValueofX1)
void	resetMaximumValueofX1 ()
bool	setMinimumValueofX2 (double minimumValueofX2)
void	resetMinimumValueofX2 ()
bool	setMaximumValueofX2 (double maximumValueofX2)
void	resetMaximumValueofX2 ()
bool	setMinimumValueofX3 (double minimumValueofX3)
void	resetMinimumValueofX3 ()
bool	setMaximumValueofX3 (double maximumValueofX3)
void	resetMaximumValueofX3 ()
bool	setMinimumValueofX4 (double minimumValueofX4)
void	resetMinimumValueofX4 ()
bool	setMaximumValueofX4 (double maximumValueofX4)
void	resetMaximumValueofX4 ()
bool	setMinimumValueofX5 (double minimumValueofX5)
void	resetMinimumValueofX5 ()
bool	setMaximumValueofX5 (double maximumValueofX5)
void	resetMaximumValueofX5 ()
bool	setMinimumTableOutput (double minimumTableOutput)
void	resetMinimumTableOutput ()
bool	setMaximumTableOutput (double maximumTableOutput)
void	resetMaximumTableOutput ()
bool	setInputUnitTypeforX1 (const std::string &inputUnitTypeforX1)
void	resetInputUnitTypeforX1 ()
bool	setInputUnitTypeforX2 (const std::string &inputUnitTypeforX2)
void	resetInputUnitTypeforX2 ()
bool	setInputUnitTypeforX3 (const std::string &inputUnitTypeforX3)
void	resetInputUnitTypeforX3 ()
bool	setInputUnitTypeforX4 (const std::string &inputUnitTypeforX4)
void	resetInputUnitTypeforX4 ()
bool	setInputUnitTypeforX5 (const std::string &inputUnitTypeforX5)
void	resetInputUnitTypeforX5 ()
bool	setOutputUnitType (const std::string &outputUnitType)
void	resetOutputUnitType ()
Public Member Functions inherited from openstudio::model::Curve
virtual	~Curve () override=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.
double	evaluate (const std::vector< double > &x) const
	Returns the value of this Curve at x.
double	evaluate (double x) const
	Convenience overload that throws if numVariables() != 1.
double	evaluate (double x, double y) const
	Convenience overload that throws if numVariables() != 2.
double	evaluate (double x, double y, double z) const
	Convenience overload that throws if numVariables() != 3.
double	evaluate (double w, double x, double y, double z) const
	Convenience overload that throws if numVariables() != 4.
double	evaluate (double v, double w, double x, double y, double z) const
	Convenience overload that throws if numVariables() != 5.
Public Member Functions inherited from openstudio::model::ResourceObject
unsigned	directUseCount (bool excludeChildren=false) const
	Returns the number of objects that use this resource directly.
unsigned	nonResourceObjectUseCount (bool excludeChildren=false) const
	Returns the number of non-ResourceObjects that use this resource either directly or indirectly.
ResourceObject &	operator= (const ResourceObject &)=default
ResourceObject &	operator= (ResourceObject &&)=default
	ResourceObject (const ResourceObject &other)=default
	ResourceObject (ResourceObject &&other)=default
virtual	~ResourceObject () override=default
Public Member Functions inherited from openstudio::model::ParentObject
ParentObject &	operator= (const ParentObject &)=default
ParentObject &	operator= (ParentObject &&)=default
	ParentObject (const ParentObject &other)=default
	ParentObject (ParentObject &&other)=default
virtual	~ParentObject () override=default
std::vector< ModelObject >	children () const
	Return direct child objects in the Model.
std::vector< IddObjectType >	allowableChildTypes () const
	Returns a vector of allowable children types.
Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject () override=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().
ModelObject	clone (Model model) const
	Creates a deep copy of this object, placing it in model.
Component	createComponent () const
	Method for creating sharable Model snippets.
Model	model () const
	Returns the Model that contains this object.
boost::optional< ParentObject >	parent () const
	Return this object's parent in the hierarchy, if it has one.
std::vector< ResourceObject >	resources () const
	Get the resources directly used by this ModelObject.
template<typename T >
std::vector< T >	getModelObjectSources () const
	Get all objects of type T that point to this object.
template<typename T >
std::vector< T >	getModelObjectSources (IddObjectType iddObjectType) const
	Get all objects of type T that point to this object.
template<typename T >
boost::optional< T >	getModelObjectTarget (unsigned index) const
	Get the object of type T pointed to by this object from field index.
template<typename T >
std::vector< T >	getModelObjectTargets () const
	Get all objects of type T to which this object points.
const std::vector< std::string > &	outputVariableNames () const
	Get all output variables names that could be associated with this object.
std::vector< OutputVariable >	outputVariables () const
	Get all output variables associated with this object, must run simulation to generate data.
boost::optional< openstudio::TimeSeries >	getData (const OutputVariable &variable, const std::string &envPeriod) const
	Get data associated with this output variable and this object.
std::vector< LifeCycleCost >	lifeCycleCosts () const
	Returns the list of all LifeCycleCosts that refer to this object.
std::vector< IdfObject >	removeLifeCycleCosts ()
	Removes all LifeCycleCosts that refer to this object.
IddObjectType	iddObjectType () const
	This is a virtual function that will tell you the type of iddObject you are dealing with.
AdditionalProperties	additionalProperties () const
	Returns this object's additional properties, constructing a new object if necessary.
bool	hasAdditionalProperties () const
	Returns true if this object has additional properties.
std::vector< IdfObject >	removeAdditionalProperties ()
	Removes all additional properties that refer to this object.
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
bool	operator< (const ModelObject &right) const
bool	operator== (const ModelObject &other) const
	equality test
bool	operator!= (const ModelObject &other) const
	inequality test
std::vector< ScheduleTypeKey >	getScheduleTypeKeys (const Schedule &schedule) const
	Return the ScheduleTypeKeys indicating how schedule is used in this object.
boost::optional< double >	getAutosizedValue (const std::string &valueName, const std::string &units) const
	Gets the autosized component value from the sql file.
virtual std::vector< EMSActuatorNames >	emsActuatorNames () const
	Return the names of the available ems actuators.
virtual std::vector< std::string >	emsInternalVariableNames () const
	Return the names of the available ems internal variables.
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 () const
bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
std::vector< std::string >	canBeTarget () const
std::vector< std::string >	canBeTarget () const
std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const
std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const
std::vector< WorkspaceObject >	getSources (IddObjectType type) const
std::vector< WorkspaceObject >	getSources (IddObjectType type) const
boost::optional< WorkspaceObject >	getTarget (unsigned index) const
boost::optional< WorkspaceObject >	getTarget (unsigned index) const
IdfObject	idfObject ()
IdfObject	idfObject () const
bool	initialized () const
bool	initialized () const
bool	isSource () const
bool	isSource () const
bool	isTarget () const
bool	isTarget () const
unsigned	numSources () const
unsigned	numSources () const
bool	objectListFieldsEqual (const WorkspaceObject &other) const
bool	objectListFieldsEqual (const WorkspaceObject &other) const
bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const
bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const
bool	operator< (const WorkspaceObject &right) const
bool	operator< (const WorkspaceObject &right) const
std::ostream &	operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
WorkspaceObject &	operator= (const WorkspaceObject &)=default
WorkspaceObject &	operator= (const WorkspaceObject &)=default
WorkspaceObject &	operator= (WorkspaceObject &&)=default
WorkspaceObject &	operator= (WorkspaceObject &&)=default
std::vector< openstudio::IdfObject >	remove ()
std::vector< openstudio::IdfObject >	remove ()
bool	setPointer (unsigned index, const Handle &targetHandle)
bool	setPointer (unsigned index, const Handle &targetHandle)
std::vector< WorkspaceObject >	sources () const
std::vector< WorkspaceObject >	sources () const
std::vector< WorkspaceObject >	targets () const
std::vector< WorkspaceObject >	targets () const
Workspace	workspace () const
Workspace	workspace () const
	WorkspaceObject (const WorkspaceObject &other)=default
	WorkspaceObject (const WorkspaceObject &other)=default
	WorkspaceObject (WorkspaceObject &&other)=default
	WorkspaceObject (WorkspaceObject &&other)=default
virtual	~WorkspaceObject () override=default
virtual	~WorkspaceObject () override=default
Public Member Functions inherited from openstudio::IdfObject
std::string	briefDescription () const
std::string	briefDescription () const
T	cast () const
std::vector< T >	castVector (const std::vector< U > &objects)
std::vector< std::vector< std::string > >	clearExtensibleGroups ()
std::vector< std::vector< std::string > >	clearExtensibleGroups ()
IdfObject	clone (bool keepHandle=false) const
IdfObject	clone (bool keepHandle=false) const
std::string	comment () const
std::string	comment () const
boost::optional< std::string >	createName (bool overwrite=true)
boost::optional< std::string >	createName (bool overwrite=true)
std::vector< unsigned >	dataFields () const
std::vector< unsigned >	dataFields () const
bool	dataFieldsEqual (const IdfObject &other) const
bool	dataFieldsEqual (const IdfObject &other) const
std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)
std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)
std::vector< IdfExtensibleGroup >	extensibleGroups () const
std::vector< IdfExtensibleGroup >	extensibleGroups () const
boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const
boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const
boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const
boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const
IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const
IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const
boost::optional< std::string >	getField (unsigned index, bool returnDefault=false) const
boost::optional< std::string >	getField (unsigned index, bool returnDefault=false) const
std::vector< Handle >	getHandles (const std::vector< T > &objects)
boost::optional< int >	getInt (unsigned index, bool returnDefault=false) const
boost::optional< int >	getInt (unsigned index, bool returnDefault=false) const
OSOptionalQuantity	getQuantity (unsigned index, bool returnDefault=false, bool returnIP=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< std::string >	getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
boost::optional< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const
boost::optional< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const
Handle	handle () const
Handle	handle () const
IddObject	iddObject () const
IddObject	iddObject () const
	IdfObject (const IddObject &, bool fastName=false)
	IdfObject (const IddObject &, bool fastName=false)
	IdfObject (const IdfObject &other)
	IdfObject (const IdfObject &other)
	IdfObject (IddObjectType type, bool fastName=false)
	IdfObject (IddObjectType type, bool fastName=false)
	IdfObject (IdfObject &&other) noexcept
	IdfObject (IdfObject &&other) noexcept
void	initializeFields (bool fill_default=false)
void	initializeFields (bool fill_default=false)
IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)
IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)
IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
bool	isDataField (unsigned index) const
bool	isDataField (unsigned index) const
bool	isEmpty (unsigned index) const
bool	isEmpty (unsigned index) const
bool	isObjectListField (unsigned index) const
bool	isObjectListField (unsigned index) const
bool	isValid (StrictnessLevel level, bool checkNames=false) const
bool	isValid (StrictnessLevel level, bool checkNames=false) const
boost::optional< unsigned >	maxExtensibleGroups () const
boost::optional< unsigned >	maxExtensibleGroups () const
boost::optional< unsigned >	maxFields () const
boost::optional< unsigned >	maxFields () const
unsigned	minExtensibleGroups () const
unsigned	minExtensibleGroups () const
unsigned	minFields () const
unsigned	minFields () const
boost::optional< std::string >	name (bool returnDefault=false) const
boost::optional< std::string >	name (bool returnDefault=false) const
std::string	nameString (bool returnDefault=false) const
std::string	nameString (bool returnDefault=false) const
unsigned	numExtensibleGroups () const
unsigned	numExtensibleGroups () const
unsigned	numFields () const
unsigned	numFields () const
unsigned	numNonextensibleFields () const
unsigned	numNonextensibleFields () const
std::vector< unsigned >	objectListFields () const
std::vector< unsigned >	objectListFields () const
bool	objectListFieldsEqual (const IdfObject &other) const
bool	objectListFieldsEqual (const IdfObject &other) const
bool	objectListFieldsNonConflicting (const IdfObject &other) const
bool	objectListFieldsNonConflicting (const IdfObject &other) const
bool	operator!= (const IdfObject &other) const
bool	operator!= (const IdfObject &other) const
std::ostream &	operator<< (std::ostream &os, const IdfObject &IdfObject)
IdfObject &	operator= (const IdfObject &other)
IdfObject &	operator= (const IdfObject &other)
IdfObject &	operator= (IdfObject &&other) noexcept
IdfObject &	operator= (IdfObject &&other) noexcept
bool	operator== (const IdfObject &other) const
bool	operator== (const IdfObject &other) const
boost::optional< T >	optionalCast () const
std::vector< std::string >	popExtensibleGroup ()
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 ()
IdfExtensibleGroup	pushExtensibleGroup (const std::vector< std::string > &values)
IdfExtensibleGroup	pushExtensibleGroup (const std::vector< std::string > &values)
std::vector< unsigned >	requiredFields () const
std::vector< unsigned >	requiredFields () const
void	setComment (const std::string &msg)
void	setComment (const std::string &msg)
bool	setDouble (unsigned index, double value)
bool	setDouble (unsigned index, double value)
bool	setFieldComment (unsigned index, const std::string &cmnt)
bool	setFieldComment (unsigned index, const std::string &cmnt)
bool	setInt (unsigned index, int value)
bool	setInt (unsigned index, int value)
boost::optional< std::string >	setName (const std::string &newName)
boost::optional< std::string >	setName (const std::string &newName)
bool	setQuantity (unsigned index, const Quantity &q)
bool	setQuantity (unsigned index, const Quantity &q)
bool	setString (unsigned index, const std::string &value)
bool	setString (unsigned index, const std::string &value)
bool	setUnsigned (unsigned index, unsigned value)
bool	setUnsigned (unsigned index, unsigned value)
std::vector< T >	subsetCastVector (const std::vector< U > &original)
ValidityReport	validityReport (StrictnessLevel level, bool checkNames=false) const
ValidityReport	validityReport (StrictnessLevel level, bool checkNames=false) const
virtual	~IdfObject ()=default
virtual	~IdfObject ()=default

Related Symbols
(Note that these are not member symbols.)
using	OptionalTableMultiVariableLookup = boost::optional<TableMultiVariableLookup>
using	TableMultiVariableLookupVector = std::vector<TableMultiVariableLookup>
Related Symbols inherited from openstudio::model::Curve
using	CurveVector = std::vector<Curve>
using	OptionalCurve = boost::optional<Curve>
Related Symbols inherited from openstudio::model::ResourceObject
using	OptionalResourceObject = boost::optional<ResourceObject>
using	ResourceObjectVector = std::vector<ResourceObject>
Related Symbols 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 .
std::vector< ModelObject >	getRecursiveChildrenAndResources (const ModelObject &object)
	Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects .
Related Symbols inherited from openstudio::model::ModelObject
std::vector< ResourceObject >	getRecursiveResources (const ModelObject &object)
	Returns all ResourceObjects accessible by recursively calling .resources() starting from object.

Constructors and Destructors
	TableMultiVariableLookup (const Model &model, int numberofIndependentVariables)
	Create a TableMultiVariableLookup object with the specified number of independent variables.
virtual	~TableMultiVariableLookup () override=default
	TableMultiVariableLookup (const TableMultiVariableLookup &other)=default
	TableMultiVariableLookup (TableMultiVariableLookup &&other)=default
TableMultiVariableLookup &	operator= (const TableMultiVariableLookup &)=default
TableMultiVariableLookup &	operator= (TableMultiVariableLookup &&)=default
static IddObjectType	iddObjectType ()
static std::vector< std::string >	interpolationMethodValues ()
static std::vector< std::string >	curveTypeValues ()
static std::vector< std::string >	tableDataFormatValues ()
static std::vector< std::string >	x1SortOrderValues ()
static std::vector< std::string >	x2SortOrderValues ()
static std::vector< std::string >	inputUnitTypeforX1Values ()
static std::vector< std::string >	inputUnitTypeforX2Values ()
static std::vector< std::string >	inputUnitTypeforX3Values ()
static std::vector< std::string >	inputUnitTypeforX4Values ()
static std::vector< std::string >	inputUnitTypeforX5Values ()
static std::vector< std::string >	outputUnitTypeValues ()

Other
bool	addPoint (const TableMultiVariableLookupPoint &point)
bool	addPoint (const std::vector< double > &xValues, double yValue)
	Add a y value corresponding to xValues.
bool	addPoint (double x1, double yValue)
bool	addPoint (double x1, double x2, double yValue)
bool	addPoint (double x1, double x2, double x3, double yValue)
bool	addPoint (double x1, double x2, double x3, double x4, double yValue)
bool	addPoint (double x1, double x2, double x3, double x4, double x5, double yValue)
std::vector< TableMultiVariableLookupPoint >	points () const
bool	setPoints (const std::vector< TableMultiVariableLookupPoint > &points)
boost::optional< double >	yValue (const std::vector< double > &xValues) const
std::vector< double >	xValues (int i) const
	Return all of the x values for independent variable i in ascending order.
int	numVariables () const
	Synonym for numberofIndependentVariables.
double	evaluate (const std::vector< double > &x) const
	Not supported.

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
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 ()
Protected Types inherited from openstudio::model::ModelObject
using	ImplType = detail::ModelObject_Impl
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::ResourceObject
	ResourceObject (IddObjectType type, const Model &model)
	Constructs a new PlanarSurface object in the model.
Protected Member Functions inherited from openstudio::model::ParentObject
	ParentObject (IddObjectType type, const Model &model)
	Constructs a new ParentObject object in the model.
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

TableMultiVariableLookup is a Curve that wraps the OpenStudio IDD object 'OS:Table:MultiVariableLookup'.

Constructor & Destructor Documentation

TableMultiVariableLookup() [1/3]

openstudio::model::TableMultiVariableLookup::TableMultiVariableLookup ( const Model & model, int numberofIndependentVariables )

explicit

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

~TableMultiVariableLookup()

virtual openstudio::model::TableMultiVariableLookup::~TableMultiVariableLookup ( )

overridevirtualdefault

TableMultiVariableLookup() [2/3]

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

default

TableMultiVariableLookup() [3/3]

openstudio::model::TableMultiVariableLookup::TableMultiVariableLookup ( TableMultiVariableLookup && other )

default

Member Function Documentation

addPoint() [1/7]

bool openstudio::model::TableMultiVariableLookup::addPoint	(	const std::vector< double > &	xValues,
		double	yValue )

Add a y value corresponding to xValues.

The size of the XValues vector must be equal to the number of independent variables specified when the table was created. If a y value already exists for a particular coordinate, then the y value will be replaced.

addPoint() [2/7]

bool openstudio::model::TableMultiVariableLookup::addPoint

(

const TableMultiVariableLookupPoint &

point

)

addPoint() [3/7]

bool openstudio::model::TableMultiVariableLookup::addPoint	(	double	x1,
		double	x2,
		double	x3,
		double	x4,
		double	x5,
		double	yValue )

addPoint() [4/7]

bool openstudio::model::TableMultiVariableLookup::addPoint	(	double	x1,
		double	x2,
		double	x3,
		double	x4,
		double	yValue )

addPoint() [5/7]

bool openstudio::model::TableMultiVariableLookup::addPoint	(	double	x1,
		double	x2,
		double	x3,
		double	yValue )

addPoint() [6/7]

bool openstudio::model::TableMultiVariableLookup::addPoint	(	double	x1,
		double	x2,
		double	yValue )

addPoint() [7/7]

bool openstudio::model::TableMultiVariableLookup::addPoint	(	double	x1,
		double	yValue )

curveType()

boost::optional< std::string > openstudio::model::TableMultiVariableLookup::curveType

(

)

const

curveTypeValues()

static std::vector< std::string > openstudio::model::TableMultiVariableLookup::curveTypeValues ( )

static

evaluate()

double openstudio::model::TableMultiVariableLookup::evaluate

(

const std::vector< double > &

x

)

const

Not supported.

This is inherited from the base class.

iddObjectType()

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

static

inputUnitTypeforX1()

std::string openstudio::model::TableMultiVariableLookup::inputUnitTypeforX1

(

)

const

inputUnitTypeforX1Values()

static std::vector< std::string > openstudio::model::TableMultiVariableLookup::inputUnitTypeforX1Values ( )

static

inputUnitTypeforX2()

std::string openstudio::model::TableMultiVariableLookup::inputUnitTypeforX2

(

)

const

inputUnitTypeforX2Values()

static std::vector< std::string > openstudio::model::TableMultiVariableLookup::inputUnitTypeforX2Values ( )

static

inputUnitTypeforX3()

std::string openstudio::model::TableMultiVariableLookup::inputUnitTypeforX3

(

)

const

inputUnitTypeforX3Values()

static std::vector< std::string > openstudio::model::TableMultiVariableLookup::inputUnitTypeforX3Values ( )

static

inputUnitTypeforX4()

std::string openstudio::model::TableMultiVariableLookup::inputUnitTypeforX4

(

)

const

inputUnitTypeforX4Values()

static std::vector< std::string > openstudio::model::TableMultiVariableLookup::inputUnitTypeforX4Values ( )

static

inputUnitTypeforX5()

std::string openstudio::model::TableMultiVariableLookup::inputUnitTypeforX5

(

)

const

inputUnitTypeforX5Values()

static std::vector< std::string > openstudio::model::TableMultiVariableLookup::inputUnitTypeforX5Values ( )

static

interpolationMethod()

std::string openstudio::model::TableMultiVariableLookup::interpolationMethod

(

)

const

interpolationMethodValues()

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

static

isInputUnitTypeforX1Defaulted()

bool openstudio::model::TableMultiVariableLookup::isInputUnitTypeforX1Defaulted

(

)

const

isInputUnitTypeforX2Defaulted()

bool openstudio::model::TableMultiVariableLookup::isInputUnitTypeforX2Defaulted

(

)

const

isInputUnitTypeforX3Defaulted()

bool openstudio::model::TableMultiVariableLookup::isInputUnitTypeforX3Defaulted

(

)

const

isInputUnitTypeforX4Defaulted()

bool openstudio::model::TableMultiVariableLookup::isInputUnitTypeforX4Defaulted

(

)

const

isInputUnitTypeforX5Defaulted()

bool openstudio::model::TableMultiVariableLookup::isInputUnitTypeforX5Defaulted

(

)

const

isInterpolationMethodDefaulted()

bool openstudio::model::TableMultiVariableLookup::isInterpolationMethodDefaulted

(

)

const

isNumberofInterpolationPointsDefaulted()

bool openstudio::model::TableMultiVariableLookup::isNumberofInterpolationPointsDefaulted

(

)

const

isOutputUnitTypeDefaulted()

bool openstudio::model::TableMultiVariableLookup::isOutputUnitTypeDefaulted

(

)

const

isTableDataFormatDefaulted()

bool openstudio::model::TableMultiVariableLookup::isTableDataFormatDefaulted

(

)

const

maximumTableOutput()

boost::optional< double > openstudio::model::TableMultiVariableLookup::maximumTableOutput

(

)

const

maximumValueofX1()

boost::optional< double > openstudio::model::TableMultiVariableLookup::maximumValueofX1

(

)

const

maximumValueofX2()

boost::optional< double > openstudio::model::TableMultiVariableLookup::maximumValueofX2

(

)

const

maximumValueofX3()

boost::optional< double > openstudio::model::TableMultiVariableLookup::maximumValueofX3

(

)

const

maximumValueofX4()

boost::optional< double > openstudio::model::TableMultiVariableLookup::maximumValueofX4

(

)

const

maximumValueofX5()

boost::optional< double > openstudio::model::TableMultiVariableLookup::maximumValueofX5

(

)

const

minimumTableOutput()

boost::optional< double > openstudio::model::TableMultiVariableLookup::minimumTableOutput

(

)

const

minimumValueofX1()

boost::optional< double > openstudio::model::TableMultiVariableLookup::minimumValueofX1

(

)

const

minimumValueofX2()

boost::optional< double > openstudio::model::TableMultiVariableLookup::minimumValueofX2

(

)

const

minimumValueofX3()

boost::optional< double > openstudio::model::TableMultiVariableLookup::minimumValueofX3

(

)

const

minimumValueofX4()

boost::optional< double > openstudio::model::TableMultiVariableLookup::minimumValueofX4

(

)

const

minimumValueofX5()

boost::optional< double > openstudio::model::TableMultiVariableLookup::minimumValueofX5

(

)

const

normalizationReference()

boost::optional< double > openstudio::model::TableMultiVariableLookup::normalizationReference

(

)

const

numberofIndependentVariables()

int openstudio::model::TableMultiVariableLookup::numberofIndependentVariables

(

)

const

numberofInterpolationPoints()

int openstudio::model::TableMultiVariableLookup::numberofInterpolationPoints

(

)

const

numVariables()

int openstudio::model::TableMultiVariableLookup::numVariables

(

)

const

Synonym for numberofIndependentVariables.

This is inherited from the base class.

operator=() [1/2]

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

default

operator=() [2/2]

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

default

outputUnitType()

std::string openstudio::model::TableMultiVariableLookup::outputUnitType

(

)

const

outputUnitTypeValues()

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

static

points()

std::vector< TableMultiVariableLookupPoint > openstudio::model::TableMultiVariableLookup::points

(

)

const

printTable()

std::string openstudio::model::TableMultiVariableLookup::printTable

(

unsigned int

precision = 3

)

const

Print a fixed-width table of the points, precision is the number of decimals.

resetCurveType()

void openstudio::model::TableMultiVariableLookup::resetCurveType

(

)

resetInputUnitTypeforX1()

void openstudio::model::TableMultiVariableLookup::resetInputUnitTypeforX1

(

)

resetInputUnitTypeforX2()

void openstudio::model::TableMultiVariableLookup::resetInputUnitTypeforX2

(

)

resetInputUnitTypeforX3()

void openstudio::model::TableMultiVariableLookup::resetInputUnitTypeforX3

(

)

resetInputUnitTypeforX4()

void openstudio::model::TableMultiVariableLookup::resetInputUnitTypeforX4

(

)

resetInputUnitTypeforX5()

void openstudio::model::TableMultiVariableLookup::resetInputUnitTypeforX5

(

)

resetInterpolationMethod()

void openstudio::model::TableMultiVariableLookup::resetInterpolationMethod

(

)

resetMaximumTableOutput()

void openstudio::model::TableMultiVariableLookup::resetMaximumTableOutput

(

)

resetMaximumValueofX1()

void openstudio::model::TableMultiVariableLookup::resetMaximumValueofX1

(

)

resetMaximumValueofX2()

void openstudio::model::TableMultiVariableLookup::resetMaximumValueofX2

(

)

resetMaximumValueofX3()

void openstudio::model::TableMultiVariableLookup::resetMaximumValueofX3

(

)

resetMaximumValueofX4()

void openstudio::model::TableMultiVariableLookup::resetMaximumValueofX4

(

)

resetMaximumValueofX5()

void openstudio::model::TableMultiVariableLookup::resetMaximumValueofX5

(

)

resetMinimumTableOutput()

void openstudio::model::TableMultiVariableLookup::resetMinimumTableOutput

(

)

resetMinimumValueofX1()

void openstudio::model::TableMultiVariableLookup::resetMinimumValueofX1

(

)

resetMinimumValueofX2()

void openstudio::model::TableMultiVariableLookup::resetMinimumValueofX2

(

)

resetMinimumValueofX3()

void openstudio::model::TableMultiVariableLookup::resetMinimumValueofX3

(

)

resetMinimumValueofX4()

void openstudio::model::TableMultiVariableLookup::resetMinimumValueofX4

(

)

resetMinimumValueofX5()

void openstudio::model::TableMultiVariableLookup::resetMinimumValueofX5

(

)

resetNormalizationReference()

void openstudio::model::TableMultiVariableLookup::resetNormalizationReference

(

)

resetNumberofInterpolationPoints()

void openstudio::model::TableMultiVariableLookup::resetNumberofInterpolationPoints

(

)

resetOutputUnitType()

void openstudio::model::TableMultiVariableLookup::resetOutputUnitType

(

)

resetTableDataFormat()

void openstudio::model::TableMultiVariableLookup::resetTableDataFormat

(

)

setCurveType()

bool openstudio::model::TableMultiVariableLookup::setCurveType

(

const std::string &

curveType

)

setInputUnitTypeforX1()

bool openstudio::model::TableMultiVariableLookup::setInputUnitTypeforX1

(

const std::string &

inputUnitTypeforX1

)

setInputUnitTypeforX2()

bool openstudio::model::TableMultiVariableLookup::setInputUnitTypeforX2

(

const std::string &

inputUnitTypeforX2

)

setInputUnitTypeforX3()

bool openstudio::model::TableMultiVariableLookup::setInputUnitTypeforX3

(

const std::string &

inputUnitTypeforX3

)

setInputUnitTypeforX4()

bool openstudio::model::TableMultiVariableLookup::setInputUnitTypeforX4

(

const std::string &

inputUnitTypeforX4

)

setInputUnitTypeforX5()

bool openstudio::model::TableMultiVariableLookup::setInputUnitTypeforX5

(

const std::string &

inputUnitTypeforX5

)

setInterpolationMethod()

bool openstudio::model::TableMultiVariableLookup::setInterpolationMethod

(

const std::string &

interpolationMethod

)

setMaximumTableOutput()

bool openstudio::model::TableMultiVariableLookup::setMaximumTableOutput

(

double

maximumTableOutput

)

setMaximumValueofX1()

bool openstudio::model::TableMultiVariableLookup::setMaximumValueofX1

(

double

maximumValueofX1

)

setMaximumValueofX2()

bool openstudio::model::TableMultiVariableLookup::setMaximumValueofX2

(

double

maximumValueofX2

)

setMaximumValueofX3()

bool openstudio::model::TableMultiVariableLookup::setMaximumValueofX3

(

double

maximumValueofX3

)

setMaximumValueofX4()

bool openstudio::model::TableMultiVariableLookup::setMaximumValueofX4

(

double

maximumValueofX4

)

setMaximumValueofX5()

bool openstudio::model::TableMultiVariableLookup::setMaximumValueofX5

(

double

maximumValueofX5

)

setMinimumTableOutput()

bool openstudio::model::TableMultiVariableLookup::setMinimumTableOutput

(

double

minimumTableOutput

)

setMinimumValueofX1()

bool openstudio::model::TableMultiVariableLookup::setMinimumValueofX1

(

double

minimumValueofX1

)

setMinimumValueofX2()

bool openstudio::model::TableMultiVariableLookup::setMinimumValueofX2

(

double

minimumValueofX2

)

setMinimumValueofX3()

bool openstudio::model::TableMultiVariableLookup::setMinimumValueofX3

(

double

minimumValueofX3

)

setMinimumValueofX4()

bool openstudio::model::TableMultiVariableLookup::setMinimumValueofX4

(

double

minimumValueofX4

)

setMinimumValueofX5()

bool openstudio::model::TableMultiVariableLookup::setMinimumValueofX5

(

double

minimumValueofX5

)

setNormalizationReference()

bool openstudio::model::TableMultiVariableLookup::setNormalizationReference

(

double

normalizationReference

)

setNumberofInterpolationPoints()

bool openstudio::model::TableMultiVariableLookup::setNumberofInterpolationPoints

(

int

numberofInterpolationPoints

)

setOutputUnitType()

bool openstudio::model::TableMultiVariableLookup::setOutputUnitType

(

const std::string &

outputUnitType

)

setPoints()

bool openstudio::model::TableMultiVariableLookup::setPoints

(

const std::vector< TableMultiVariableLookupPoint > &

points

)

setTableDataFormat()

bool openstudio::model::TableMultiVariableLookup::setTableDataFormat

(

const std::string &

tableDataFormat

)

tableDataFormat()

std::string openstudio::model::TableMultiVariableLookup::tableDataFormat

(

)

const

tableDataFormatValues()

static std::vector< std::string > openstudio::model::TableMultiVariableLookup::tableDataFormatValues ( )

static

x1SortOrderValues()

static std::vector< std::string > openstudio::model::TableMultiVariableLookup::x1SortOrderValues ( )

static

x2SortOrderValues()

static std::vector< std::string > openstudio::model::TableMultiVariableLookup::x2SortOrderValues ( )

static

xValues()

std::vector< double > openstudio::model::TableMultiVariableLookup::xValues

(

int

i

)

const

Return all of the x values for independent variable i in ascending order.

The independent variables are indexed from 0.

yValue()

boost::optional< double > openstudio::model::TableMultiVariableLookup::yValue

(

const std::vector< double > &

xValues

)

const

Friends And Related Symbol Documentation

OptionalTableMultiVariableLookup

using OptionalTableMultiVariableLookup = boost::optional<TableMultiVariableLookup>

related

TableMultiVariableLookupVector

using TableMultiVariableLookupVector = std::vector<TableMultiVariableLookup>

related