#include <TableMultiVariableLookup.hpp>
Public Member Functions | |
Constructors and Destructors | |
TableMultiVariableLookup (const Model &model, int numberofIndependentVariables) | |
Create a TableMultiVariableLookup object with the specified number of independent variables. More... | |
virtual | ~TableMultiVariableLookup () |
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. More... | |
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 () |
Other | |
bool | addPoint (const TableMultiVariableLookupPoint &point) |
bool | addPoint (const std::vector< double > &xValues, double yValue) |
Add a y value corresponding to xValues. More... | |
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. More... | |
int | numVariables () const |
Synonym for numberofIndependentVariables. More... | |
double | evaluate (const std::vector< double > &x) const |
Not supported. More... | |
Public Member Functions inherited from openstudio::model::Curve | |
virtual | ~Curve () |
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... | |
virtual | ~ResourceObject () |
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... | |
virtual | ~ParentObject () |
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... | |
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 (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 std::vector< std::string > | curveTypeValues () |
static IddObjectType | iddObjectType () |
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 > | interpolationMethodValues () |
static std::vector< std::string > | outputUnitTypeValues () |
static std::vector< std::string > | tableDataFormatValues () |
static std::vector< std::string > | x1SortOrderValues () |
static std::vector< std::string > | x2SortOrderValues () |
Related Functions | |
(Note that these are not member functions.) | |
typedef boost::optional < TableMultiVariableLookup > | OptionalTableMultiVariableLookup |
typedef std::vector < TableMultiVariableLookup > | TableMultiVariableLookupVector |
Related Functions inherited from openstudio::model::Curve | |
typedef std::vector< Curve > | CurveVector |
typedef boost::optional< Curve > | OptionalCurve |
Related Functions inherited from openstudio::model::ResourceObject | |
typedef boost::optional < ResourceObject > | OptionalResourceObject |
typedef std::vector < ResourceObject > | ResourceObjectVector |
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 | |
typedef detail::ModelObject_Impl | ImplType |
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) | |
TableMultiVariableLookup is a Curve that wraps the OpenStudio IDD object 'OS:Table:MultiVariableLookup'.
|
explicit |
Create a TableMultiVariableLookup object with the specified number of independent variables.
|
inlinevirtual |
bool openstudio::model::TableMultiVariableLookup::addPoint | ( | const TableMultiVariableLookupPoint & | point | ) |
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.
bool openstudio::model::TableMultiVariableLookup::addPoint | ( | double | x1, |
double | yValue | ||
) |
bool openstudio::model::TableMultiVariableLookup::addPoint | ( | double | x1, |
double | x2, | ||
double | yValue | ||
) |
bool openstudio::model::TableMultiVariableLookup::addPoint | ( | double | x1, |
double | x2, | ||
double | x3, | ||
double | yValue | ||
) |
bool openstudio::model::TableMultiVariableLookup::addPoint | ( | double | x1, |
double | x2, | ||
double | x3, | ||
double | x4, | ||
double | yValue | ||
) |
bool openstudio::model::TableMultiVariableLookup::addPoint | ( | double | x1, |
double | x2, | ||
double | x3, | ||
double | x4, | ||
double | x5, | ||
double | yValue | ||
) |
boost::optional<std::string> openstudio::model::TableMultiVariableLookup::curveType | ( | ) | const |
|
static |
double openstudio::model::TableMultiVariableLookup::evaluate | ( | const std::vector< double > & | x | ) | const |
Not supported.
This is inherited from the base class.
|
static |
std::string openstudio::model::TableMultiVariableLookup::inputUnitTypeforX1 | ( | ) | const |
|
static |
std::string openstudio::model::TableMultiVariableLookup::inputUnitTypeforX2 | ( | ) | const |
|
static |
std::string openstudio::model::TableMultiVariableLookup::inputUnitTypeforX3 | ( | ) | const |
|
static |
std::string openstudio::model::TableMultiVariableLookup::inputUnitTypeforX4 | ( | ) | const |
|
static |
std::string openstudio::model::TableMultiVariableLookup::inputUnitTypeforX5 | ( | ) | const |
|
static |
std::string openstudio::model::TableMultiVariableLookup::interpolationMethod | ( | ) | const |
|
static |
bool openstudio::model::TableMultiVariableLookup::isInputUnitTypeforX1Defaulted | ( | ) | const |
bool openstudio::model::TableMultiVariableLookup::isInputUnitTypeforX2Defaulted | ( | ) | const |
bool openstudio::model::TableMultiVariableLookup::isInputUnitTypeforX3Defaulted | ( | ) | const |
bool openstudio::model::TableMultiVariableLookup::isInputUnitTypeforX4Defaulted | ( | ) | const |
bool openstudio::model::TableMultiVariableLookup::isInputUnitTypeforX5Defaulted | ( | ) | const |
bool openstudio::model::TableMultiVariableLookup::isInterpolationMethodDefaulted | ( | ) | const |
bool openstudio::model::TableMultiVariableLookup::isNumberofInterpolationPointsDefaulted | ( | ) | const |
bool openstudio::model::TableMultiVariableLookup::isOutputUnitTypeDefaulted | ( | ) | const |
bool openstudio::model::TableMultiVariableLookup::isTableDataFormatDefaulted | ( | ) | const |
boost::optional<double> openstudio::model::TableMultiVariableLookup::maximumTableOutput | ( | ) | const |
boost::optional<double> openstudio::model::TableMultiVariableLookup::maximumValueofX1 | ( | ) | const |
boost::optional<double> openstudio::model::TableMultiVariableLookup::maximumValueofX2 | ( | ) | const |
boost::optional<double> openstudio::model::TableMultiVariableLookup::maximumValueofX3 | ( | ) | const |
boost::optional<double> openstudio::model::TableMultiVariableLookup::maximumValueofX4 | ( | ) | const |
boost::optional<double> openstudio::model::TableMultiVariableLookup::maximumValueofX5 | ( | ) | const |
boost::optional<double> openstudio::model::TableMultiVariableLookup::minimumTableOutput | ( | ) | const |
boost::optional<double> openstudio::model::TableMultiVariableLookup::minimumValueofX1 | ( | ) | const |
boost::optional<double> openstudio::model::TableMultiVariableLookup::minimumValueofX2 | ( | ) | const |
boost::optional<double> openstudio::model::TableMultiVariableLookup::minimumValueofX3 | ( | ) | const |
boost::optional<double> openstudio::model::TableMultiVariableLookup::minimumValueofX4 | ( | ) | const |
boost::optional<double> openstudio::model::TableMultiVariableLookup::minimumValueofX5 | ( | ) | const |
boost::optional<double> openstudio::model::TableMultiVariableLookup::normalizationReference | ( | ) | const |
int openstudio::model::TableMultiVariableLookup::numberofIndependentVariables | ( | ) | const |
int openstudio::model::TableMultiVariableLookup::numberofInterpolationPoints | ( | ) | const |
int openstudio::model::TableMultiVariableLookup::numVariables | ( | ) | const |
Synonym for numberofIndependentVariables.
This is inherited from the base class.
std::string openstudio::model::TableMultiVariableLookup::outputUnitType | ( | ) | const |
|
static |
std::vector<TableMultiVariableLookupPoint> openstudio::model::TableMultiVariableLookup::points | ( | ) | const |
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.
void openstudio::model::TableMultiVariableLookup::resetCurveType | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetInputUnitTypeforX1 | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetInputUnitTypeforX2 | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetInputUnitTypeforX3 | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetInputUnitTypeforX4 | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetInputUnitTypeforX5 | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetInterpolationMethod | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetMaximumTableOutput | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetMaximumValueofX1 | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetMaximumValueofX2 | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetMaximumValueofX3 | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetMaximumValueofX4 | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetMaximumValueofX5 | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetMinimumTableOutput | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetMinimumValueofX1 | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetMinimumValueofX2 | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetMinimumValueofX3 | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetMinimumValueofX4 | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetMinimumValueofX5 | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetNormalizationReference | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetNumberofInterpolationPoints | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetOutputUnitType | ( | ) |
void openstudio::model::TableMultiVariableLookup::resetTableDataFormat | ( | ) |
bool openstudio::model::TableMultiVariableLookup::setCurveType | ( | const std::string & | curveType | ) |
bool openstudio::model::TableMultiVariableLookup::setInputUnitTypeforX1 | ( | const std::string & | inputUnitTypeforX1 | ) |
bool openstudio::model::TableMultiVariableLookup::setInputUnitTypeforX2 | ( | const std::string & | inputUnitTypeforX2 | ) |
bool openstudio::model::TableMultiVariableLookup::setInputUnitTypeforX3 | ( | const std::string & | inputUnitTypeforX3 | ) |
bool openstudio::model::TableMultiVariableLookup::setInputUnitTypeforX4 | ( | const std::string & | inputUnitTypeforX4 | ) |
bool openstudio::model::TableMultiVariableLookup::setInputUnitTypeforX5 | ( | const std::string & | inputUnitTypeforX5 | ) |
bool openstudio::model::TableMultiVariableLookup::setInterpolationMethod | ( | const std::string & | interpolationMethod | ) |
bool openstudio::model::TableMultiVariableLookup::setMaximumTableOutput | ( | double | maximumTableOutput | ) |
bool openstudio::model::TableMultiVariableLookup::setMaximumValueofX1 | ( | double | maximumValueofX1 | ) |
bool openstudio::model::TableMultiVariableLookup::setMaximumValueofX2 | ( | double | maximumValueofX2 | ) |
bool openstudio::model::TableMultiVariableLookup::setMaximumValueofX3 | ( | double | maximumValueofX3 | ) |
bool openstudio::model::TableMultiVariableLookup::setMaximumValueofX4 | ( | double | maximumValueofX4 | ) |
bool openstudio::model::TableMultiVariableLookup::setMaximumValueofX5 | ( | double | maximumValueofX5 | ) |
bool openstudio::model::TableMultiVariableLookup::setMinimumTableOutput | ( | double | minimumTableOutput | ) |
bool openstudio::model::TableMultiVariableLookup::setMinimumValueofX1 | ( | double | minimumValueofX1 | ) |
bool openstudio::model::TableMultiVariableLookup::setMinimumValueofX2 | ( | double | minimumValueofX2 | ) |
bool openstudio::model::TableMultiVariableLookup::setMinimumValueofX3 | ( | double | minimumValueofX3 | ) |
bool openstudio::model::TableMultiVariableLookup::setMinimumValueofX4 | ( | double | minimumValueofX4 | ) |
bool openstudio::model::TableMultiVariableLookup::setMinimumValueofX5 | ( | double | minimumValueofX5 | ) |
bool openstudio::model::TableMultiVariableLookup::setNormalizationReference | ( | double | normalizationReference | ) |
bool openstudio::model::TableMultiVariableLookup::setNumberofInterpolationPoints | ( | int | numberofInterpolationPoints | ) |
bool openstudio::model::TableMultiVariableLookup::setOutputUnitType | ( | const std::string & | outputUnitType | ) |
bool openstudio::model::TableMultiVariableLookup::setPoints | ( | const std::vector< TableMultiVariableLookupPoint > & | points | ) |
bool openstudio::model::TableMultiVariableLookup::setTableDataFormat | ( | const std::string & | tableDataFormat | ) |
std::string openstudio::model::TableMultiVariableLookup::tableDataFormat | ( | ) | const |
|
static |
|
static |
|
static |
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.
boost::optional<double> openstudio::model::TableMultiVariableLookup::yValue | ( | const std::vector< double > & | xValues | ) | const |
|
related |
|
related |