USGS

Isis 3.0 Developer's Reference (API)

 Home

Isis::CalculatorVariablePool Class Reference

This is a simple class to model a Calculator Variable Pool. More...

#include <InlineCalculator.h>

List of all members.

Public Member Functions

 CalculatorVariablePool ()
 Constructs a CalculatorVariablePool object.
 ~CalculatorVariablePool ()
 Destroys the CalculatorVariablePool object.
virtual bool exists (const QString &variable) const
 Returns true so the real error can be reported.
virtual QVector< double > value (const QString &variable, const int &index=0) const
 Return vector of doubles for Calculator functions.
virtual void add (const QString &key, QVector< double > &values)
 Add a parameter to the variable pool.

Detailed Description

This is a simple class to model a Calculator Variable Pool.

Author:
2012-07-15 Kris Becker

Constructor & Destructor Documentation

Isis::CalculatorVariablePool::CalculatorVariablePool (  ) 

Constructs a CalculatorVariablePool object.

Isis::CalculatorVariablePool::~CalculatorVariablePool (  ) 

Destroys the CalculatorVariablePool object.

Member Function Documentation

void Isis::CalculatorVariablePool::add ( const QString &  key,
QVector< double > &  values 
) [virtual]

Add a parameter to the variable pool.

Some implementations can take advantage of this if desired but it is not standard.

Parameters:
key A string containing the name of the parameter to be added.
values A vector of double precision values to be added to the variable pool.
Exceptions:
IException::Programmer "No implementation in Calculator variable pool to add value for variable."

References _FILEINFO_, and Isis::IException::Programmer.

bool Isis::CalculatorVariablePool::exists ( const QString &  variable  )  const [virtual]

Returns true so the real error can be reported.

Parameters:
variable A string containing the variable we are looking for.
Returns:
bool True

Referenced by Isis::InlineCalculator::variable().

QVector< double > Isis::CalculatorVariablePool::value ( const QString &  variable,
const int &  index = 0 
) const [virtual]

Return vector of doubles for Calculator functions.

Parameters:
variable A string containing the variable.
index The location in the pool.
Returns:
QVector < double > A vector of calculator functions.
Exceptions:
IException::Programmer "No implementation in Calculator variable pool to provide value for variable."

References _FILEINFO_, and Isis::IException::Programmer.

Referenced by Isis::InlineCalculator::variable().

The documentation for this class was generated from the following files: