casa::FunctionOrder< T > Class Template Reference

Container of function description details. More...

#include <FunctionOrder.h>

Inheritance diagram for casa::FunctionOrder< T >:

List of all members.

Public Member Functions
	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)
	Get and set the various parameters (no check for index range).
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)
	Create a FunctionOrder from a record Error messages are postfixed to error.
virtual Bool	fromString (String &error, const String &in)
	Initialise the class from a String representation.
virtual Bool	toRecord (String &error, RecordInterface &out) const
	Create a record from a FunctionOrder.
virtual const String &	ident () const
	Get identification of record.
ostream &	print (ostream &os) const
	Output the parameters.
Private Attributes
Vector< Int >	int_p
	All data vectors can be empty.
Vector< T >	double_p
	Double parameters.
String	string_p
	String parameters.
PtrBlock< Function< T > * >	function_p
	List of functions (say for Combi and Compound)
Vector< T >	scale_p
	Scale of y (length 1)
Vector< T >	center_p
	Centers of x (length ndim)
Vector< T >	width_p
	Width of x (ndim)

---

Detailed Description

template<class T>
class casa::FunctionOrder< T >

Container of function description details.

Intended use:

Public interface

Review Status

Reviewed By:

UNKNOWN

Date Reviewed:

before2004/08/25"tFunctionOrder

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)

• T must have a default constructor, assignment operator, and copy constructor (for the Vector interface).
• Complex/DComplex or Float/Double supported

To Do

• Nothing I know of

Definition at line 81 of file FunctionOrder.h.

---

Constructor & Destructor Documentation

template<class T>

casa::FunctionOrder< T >::FunctionOrder

(

)

Construct a default FunctionOrder with 0 parameters.

template<class T>

casa::FunctionOrder< T >::FunctionOrder

(

const FunctionOrder< T > &

other

)

Copy constructor (deep copy)

template<class T>

virtual casa::FunctionOrder< T >::~FunctionOrder

(

)

[virtual]

Destructor.

---

Member Function Documentation

template<class T>

virtual Bool casa::FunctionOrder< T >::fromRecord	(	String &	error,
		const RecordInterface &	in
	)		[virtual]

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

Implements casa::RecordTransformable.

template<class T>

virtual Bool casa::FunctionOrder< T >::fromString	(	String &	error,
		const String &	inString
	)		[virtual]

Initialise the class from a String representation.

A string cannot contain enough information for many objects. Hence the default implementation of this class returns False, indicating that the class could not be initialised and an error message is appended to the supplied string. If the class can be initialised from a string then this function should be overridden.

Reimplemented from casa::RecordTransformable.

template<class T>

T& casa::FunctionOrder< T >::getCenter

(

const uInt

n

)

template<class T>

const T& casa::FunctionOrder< T >::getCenter

(

const uInt

n

)

const

template<class T>

const Function<T>& casa::FunctionOrder< T >::getFunction

(

const uInt

n

)

const

template<class T>

Int& casa::FunctionOrder< T >::getInt

(

const uInt

n

)

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

Automatic extension for write.

template<class T>

const Int& casa::FunctionOrder< T >::getInt

(

const uInt

n

)

const

template<class T>

T& casa::FunctionOrder< T >::getPar

(

const uInt

n

)

template<class T>

const T& casa::FunctionOrder< T >::getPar

(

const uInt

n

)

const

template<class T>

T& casa::FunctionOrder< T >::getScale

(

const uInt

n

)

template<class T>

const T& casa::FunctionOrder< T >::getScale

(

const uInt

n

)

const

template<class T>

String& casa::FunctionOrder< T >::getString

(

)

template<class T>

const String& casa::FunctionOrder< T >::getString

(

)

const

template<class T>

T& casa::FunctionOrder< T >::getWidth

(

const uInt

n

)

template<class T>

const T& casa::FunctionOrder< T >::getWidth

(

const uInt

n

)

const

template<class T>

virtual const String& casa::FunctionOrder< T >::ident

(

)

const [virtual]

Get identification of record.

Reimplemented from casa::RecordTransformable.

template<class T>

FunctionOrder& casa::FunctionOrder< T >::operator=

(

const FunctionOrder< T > &

other

)

Copy assignment (deep copy)

template<class T>

ostream& casa::FunctionOrder< T >::print

(

ostream &

os

)

const

Output the parameters.

template<class T>

void casa::FunctionOrder< T >::setFunction	(	const uInt	n,
		Function< T > &	other
	)

template<class T>

virtual Bool casa::FunctionOrder< T >::toRecord	(	String &	error,
		RecordInterface &	out
	)		const [virtual]

Create a record from a FunctionOrder.

Error messages are postfixed to error.

Implements casa::RecordTransformable.

---

Member Data Documentation

template<class T>

Vector<T> casa::FunctionOrder< T >::center_p [private]

Centers of x (length ndim)

Definition at line 145 of file FunctionOrder.h.

template<class T>

Vector<T> casa::FunctionOrder< T >::double_p [private]

Double parameters.

Definition at line 137 of file FunctionOrder.h.

template<class T>

PtrBlock<Function<T> *> casa::FunctionOrder< T >::function_p [private]

List of functions (say for Combi and Compound)

Definition at line 141 of file FunctionOrder.h.

template<class T>

Vector<Int> casa::FunctionOrder< T >::int_p [private]

All data vectors can be empty.

Integer details (order etc)

Definition at line 135 of file FunctionOrder.h.

template<class T>

Vector<T> casa::FunctionOrder< T >::scale_p [private]

Scale of y (length 1)

Definition at line 143 of file FunctionOrder.h.

template<class T>

String casa::FunctionOrder< T >::string_p [private]

String parameters.

Definition at line 139 of file FunctionOrder.h.

template<class T>

Vector<T> casa::FunctionOrder< T >::width_p [private]

Width of x (ndim)

Definition at line 147 of file FunctionOrder.h.

---

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

• casacore/scimath/Functionals/FunctionOrder.h