afl::FieldFn Class Reference

#include <functions.h>

Inheritance diagram for afl::FieldFn:

afl::Function List of all members.

Public Member Functions

 FieldFn (const Field *field, Function *arg)
 FieldFn (const Field *field, Function *arg1, Function *arg2)
 FieldFn (const Field *field, Function *arg1, Function *arg2, Function *arg3)
 FieldFn (const Field *field, Function *arg1, Function *arg2, Function *arg3, Function *arg4)
virtual data_t evaluate (const Point &p, Function::Context *ctxt) const
virtual void serialise (std::ostream &doc) const
virtual Functionclone () const

Detailed Description

a function that represents the value of another field


Constructor & Destructor Documentation

afl::FieldFn::FieldFn const Field field,
Function arg
 

Parameters:
field the field this object represents
arg the argument of a 1D field

afl::FieldFn::FieldFn const Field field,
Function arg1,
Function arg2
 

Parameters:
field the field this object represents
arg1 the X argument of a 2D field
arg2 the Y argument of a 2D field

afl::FieldFn::FieldFn const Field field,
Function arg1,
Function arg2,
Function arg3
 

Parameters:
field the field this object represents
arg1 the X argument of a 3D field
arg2 the Y argument of a 3D field
arg3 the Z argument of a 3D field

afl::FieldFn::FieldFn const Field field,
Function arg1,
Function arg2,
Function arg3,
Function arg4
 

Parameters:
field the field this object represents
arg1 the X argument of a 4D field
arg2 the Y argument of a 4D field
arg3 the Z argument of a 4D field
arg4 the T argument of a 4D field


Member Function Documentation

virtual Function* afl::FieldFn::clone  )  const [virtual]
 

Returns:
an exact copy of this function

Implements afl::Function.

virtual data_t afl::FieldFn::evaluate const Point p,
Function::Context ctxt
const [virtual]
 

evaluates the function

Parameters:
p the location to evaluate the function at
ctxt the context for the evaluation
Returns:
the value of the field at p

Implements afl::Function.

virtual void afl::FieldFn::serialise std::ostream &  doc  )  const [virtual]
 

adds the symbolic value of the function to an output stream

Parameters:
doc the output stream to put the function on

Implements afl::Function.


The documentation for this class was generated from the following file:
Generated on Fri Dec 22 07:17:51 2006 for afl by  doxygen 1.4.6