#include <FunctionOrder.h>

Public Member Functions
	FunctionOrder ()
	Construct a default FunctionOrder with 0 parameters. More...

	FunctionOrder (const FunctionOrder< T > &other)
	Copy constructor (deep copy) More...

virtual	~FunctionOrder ()
	Destructor. More...

FunctionOrder &	operator= (const FunctionOrder< T > &other)
	Copy assignment (deep copy) More...

Int &	getInt (const uInt n)
	Get and set the various parameters (no check for index range). More...

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. More...

virtual Bool	fromString (String &error, const String &in)
	Initialise the class from a String representation. More...

virtual Bool	toRecord (String &error, RecordInterface &out) const
	Create a record from a FunctionOrder. More...

virtual const String &	ident () const
	Get identification of record. More...

ostream &	print (ostream &os) const
	Output the parameters. More...

Public Member Functions inherited from casacore::RecordTransformable
virtual	~RecordTransformable ()
	The destructor must be virtual so that the destructor of derived classes is actually used. More...

Private Attributes
Vector< Int >	int_p
	All data vectors can be empty. More...

Vector< T >	double_p
	Double parameters. More...

String	string_p
	String parameters. More...

PtrBlock< Function< T > * >	function_p
	List of functions (say for Combi and Compound) More...

Vector< T >	scale_p
	Scale of y (length 1) More...

Vector< T >	center_p
	Centers of x (length ndim) More...

Vector< T >	width_p
	Width of x (ndim) More...

Detailed Description

template<class T>
class casacore::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

◆ FunctionOrder() [1/2]

template<class T >

casacore::FunctionOrder< T >::FunctionOrder ( )

Construct a default FunctionOrder with 0 parameters.

◆ FunctionOrder() [2/2]

template<class T >

casacore::FunctionOrder< T >::FunctionOrder ( const FunctionOrder< T > & other )

Copy constructor (deep copy)

◆ ~FunctionOrder()

template<class T >

virtual casacore::FunctionOrder< T >::~FunctionOrder ( )

virtual

Destructor.

Member Function Documentation

◆ fromRecord()

template<class T >

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

virtual

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

Implements casacore::RecordTransformable.

◆ fromString()

template<class T >

virtual Bool casacore::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 casacore::RecordTransformable.

◆ getCenter() [1/2]

template<class T >

T& casacore::FunctionOrder< T >::getCenter ( const uInt n )

◆ getCenter() [2/2]

template<class T >

const T& casacore::FunctionOrder< T >::getCenter ( const uInt n ) const

◆ getFunction()

template<class T >

const Function<T>& casacore::FunctionOrder< T >::getFunction ( const uInt n ) const

◆ getInt() [1/2]

template<class T >

Int& casacore::FunctionOrder< T >::getInt ( const uInt n )

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

Automatic extension for write.

◆ getInt() [2/2]

template<class T >

const Int& casacore::FunctionOrder< T >::getInt ( const uInt n ) const

◆ getPar() [1/2]

template<class T >

T& casacore::FunctionOrder< T >::getPar ( const uInt n )

◆ getPar() [2/2]

template<class T >

const T& casacore::FunctionOrder< T >::getPar ( const uInt n ) const

◆ getScale() [1/2]

template<class T >

T& casacore::FunctionOrder< T >::getScale ( const uInt n )

◆ getScale() [2/2]

template<class T >

const T& casacore::FunctionOrder< T >::getScale ( const uInt n ) const

◆ getString() [1/2]

template<class T >

String& casacore::FunctionOrder< T >::getString ( )

◆ getString() [2/2]

template<class T >

const String& casacore::FunctionOrder< T >::getString ( ) const

◆ getWidth() [1/2]

template<class T >

T& casacore::FunctionOrder< T >::getWidth ( const uInt n )

◆ getWidth() [2/2]

template<class T >

const T& casacore::FunctionOrder< T >::getWidth ( const uInt n ) const

◆ ident()

template<class T >

virtual const String& casacore::FunctionOrder< T >::ident ( ) const

virtual

Get identification of record.

Reimplemented from casacore::RecordTransformable.

◆ operator=()

template<class T >

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

Copy assignment (deep copy)

◆ print()

template<class T >

ostream& casacore::FunctionOrder< T >::print ( ostream & os ) const

Output the parameters.

Referenced by casacore::operator<<().

◆ setFunction()

template<class T >

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

◆ toRecord()

template<class T >

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

virtual

Create a record from a FunctionOrder.

Error messages are postfixed to error.

Implements casacore::RecordTransformable.

Member Data Documentation

◆ center_p

template<class T >

Vector<T> casacore::FunctionOrder< T >::center_p

private

Centers of x (length ndim)

Definition at line 145 of file FunctionOrder.h.

◆ double_p

template<class T >

Vector<T> casacore::FunctionOrder< T >::double_p

private

Double parameters.

Definition at line 137 of file FunctionOrder.h.

◆ function_p

template<class T >

PtrBlock<Function<T> *> casacore::FunctionOrder< T >::function_p

private

List of functions (say for Combi and Compound)

Definition at line 141 of file FunctionOrder.h.

◆ int_p

template<class T >

Vector<Int> casacore::FunctionOrder< T >::int_p

private

All data vectors can be empty.

Integer details (order etc)

Definition at line 135 of file FunctionOrder.h.

◆ scale_p

template<class T >

Vector<T> casacore::FunctionOrder< T >::scale_p

private

Scale of y (length 1)

Definition at line 143 of file FunctionOrder.h.

◆ string_p

template<class T >

String casacore::FunctionOrder< T >::string_p

private

String parameters.

Definition at line 139 of file FunctionOrder.h.

◆ width_p

template<class T >

Vector<T> casacore::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:

scimath/Functionals/FunctionOrder.h

Public Member Functions

Private Attributes

Detailed Description

template<class T> class casacore::FunctionOrder< T >

Intended use:

Review Status

Synopsis

Example

Motivation

Template Type Argument Requirements (T)

To Do

Constructor & Destructor Documentation

◆ FunctionOrder() [1/2]

◆ FunctionOrder() [2/2]

◆ ~FunctionOrder()

Member Function Documentation

◆ fromRecord()

◆ fromString()

◆ getCenter() [1/2]

◆ getCenter() [2/2]

◆ getFunction()

◆ getInt() [1/2]

◆ getInt() [2/2]

◆ getPar() [1/2]

◆ getPar() [2/2]

◆ getScale() [1/2]

◆ getScale() [2/2]

◆ getString() [1/2]

◆ getString() [2/2]

◆ getWidth() [1/2]

◆ getWidth() [2/2]

◆ ident()

◆ operator=()

◆ print()

◆ setFunction()

◆ toRecord()

Member Data Documentation

◆ center_p

◆ double_p

◆ function_p

◆ int_p

◆ scale_p

◆ string_p

◆ width_p

template<class T>
class casacore::FunctionOrder< T >