FunctionOrder.h

Classes

FunctionOrder -- Container of function description details (full description)
Global Functions -- Global functions (full description)

template<class T> class FunctionOrder : public RecordTransformable

Interface

Public Members
FunctionOrder()
FunctionOrder(const FunctionOrder<T> &other)
virtual ~FunctionOrder()
FunctionOrder &operator=(const FunctionOrder<T> &other)
Int &getInt(const uInt n)
const Int &getInt(const uInt n) const
T &getPar(const uInt n)
const T &getPar(const uInt n) const
String &getString()
const String &getString() const
T &getScale(const uInt n)
const T &getScale(const uInt n) const
T &getCenter(const uInt n)
const T &getCenter(const uInt n) const
T &getWidth(const uInt n)
const T &getWidth(const uInt n) const
const Function<T> &getFunction(const uInt n) const
void setFunction(const uInt n, Function<T> &other)
virtual Bool fromRecord(String &error, const RecordInterface &in)
virtual Bool fromString(String &error, const String &in)
virtual Bool toRecord(String &error, RecordInterface &out) const
virtual const String &ident() const
ostream &print(ostream &os) const

Description

Synopsis

FunctionOrder is used to provide an interface to an entity which has special fixed parameters (like dimension of Gaussian; oder of Polynomial). This is useful, for example, in implementinggeneric function factories.

Example

See the FunctionHolder class for a usage interface.

Motivation

Generically manipulatable parameters are important for Glish interface

Template Type Argument Requirements (T)

To Do

Member Description

FunctionOrder()

Construct a default FunctionOrder with 0 parameters

FunctionOrder(const FunctionOrder<T> &other)

Copy constructor (deep copy)

virtual ~FunctionOrder()

Destructor

FunctionOrder &operator=(const FunctionOrder<T> &other)

Copy assignment (deep copy)

Int &getInt(const uInt n)
const Int &getInt(const uInt n) const
T &getPar(const uInt n)
const T &getPar(const uInt n) const
String &getString()
const String &getString() const
T &getScale(const uInt n)
const T &getScale(const uInt n) const
T &getCenter(const uInt n)
const T &getCenter(const uInt n) const
T &getWidth(const uInt n)
const T &getWidth(const uInt n) const
const Function<T> &getFunction(const uInt n) const
void setFunction(const uInt n, Function<T> &other)

Get and set the various parameters (no check for index range). Automatic extension for write.

virtual Bool fromRecord(String &error, const RecordInterface &in)
virtual Bool fromString(String &error, const String &in)

Create a FunctionOrder from a record Error messages are postfixed to error.

virtual Bool toRecord(String &error, RecordInterface &out) const

Create a record from a FunctionOrder. Error messages are postfixed to error.

virtual const String &ident() const

Get identification of record

ostream &print(ostream &os) const

Output the parameters


Global functions (source)

Interface

Private Members
ostream &operator<<(ostream &os, const FunctionOrder<T> &par)

Description

Member Description

ostream &operator<<(ostream &os, const FunctionOrder<T> &par)

Output declaration