afl::Derivator Class Reference

#include <derivator.h>

Inheritance diagram for afl::Derivator:

List of all members.

Public Member Functions
virtual	~Derivator ()
virtual Derivative	derivative (const Point &x) const =0
virtual void	toXML (std::ostream &doc) const =0
virtual Derivator *	clone ()=0
const Point &	getDeltas () const
virtual const std::string &	getMethod () const =0
void	setParentField (const Field *parent)
Protected Member Functions
	Derivator (const Field *field, const Parameters &params)
Protected Attributes
const Field *	_field
Point	_deltas
const ddf::PropertySet *	_pset

---

Detailed Description

class Derivator Approximates the derivative of a field

---

Constructor & Destructor Documentation

virtual afl::Derivator::~Derivator (   )  [virtual]

Destructor

afl::Derivator::Derivator (  const Field *  field, const Parameters &  params )  [protected]

constructor Parameters: field  the field to act approximate derivatives on params  how far to sample in each direction: delta-x, delta-y delta-z and delta-t Exceptions: ddf::InvalidArgumentException  if delta is 0 along a required axis

---

Member Function Documentation

virtual Derivator* afl::Derivator::clone (   )  [pure virtual]

Returns: a true copy of the object. The object becomes the responsibility of the calling function Implemented in afl::Derivator_1, afl::Derivator_2, afl::Derivator_3, and afl::Derivator_4.

virtual Derivative afl::Derivator::derivative (  const Point &  x  )  const [pure virtual]

Parameters: x  the location to approximate a derivative at Returns: the derivative at x Implemented in afl::Derivator_1, afl::Derivator_2, afl::Derivator_3, and afl::Derivator_4.

const Point& afl::Derivator::getDeltas (   )  const [inline]

Returns: a reference to the deltas it uses

virtual const std::string& afl::Derivator::getMethod (   )  const [pure virtual]

Returns: the name of the method this derivator implements Implemented in afl::Derivator_1, afl::Derivator_2, afl::Derivator_3, and afl::Derivator_4.

void afl::Derivator::setParentField (  const Field *  parent  )

sets the parent field of this interpolation Parameters: parent  the field that this derivator should operator on

virtual void afl::Derivator::toXML (  std::ostream &  doc  )  const [pure virtual]

represents the derivator for an FRL document Parameters: doc  the output stream that the xml will be appended to Implemented in afl::Derivator_1, afl::Derivator_2, afl::Derivator_3, and afl::Derivator_4.

---

Member Data Documentation

Point afl::Derivator::_deltas [protected]

how far to sample in each direction

const Field* afl::Derivator::_field [protected]

the field this derivator acts on.

const ddf::PropertySet* afl::Derivator::_pset [protected]

the properties of the field if it exists

---

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

• derivator.h

---