VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Attributes
DtBaseTableFunction Class Reference

class DtBaseTableFunction: More...

Inheritance diagram for DtBaseTableFunction:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtBaseTableFunction ()
 default constructor
 DtBaseTableFunction (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 real constructor
 DtBaseTableFunction (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual ~DtBaseTableFunction ()
 destructor
 DtBaseTableFunction (const DtBaseTableFunction &orig)
 basic copy constructor
 DtBaseTableFunction (const DtString &name, const DtBaseTableFunction &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 full copy constructor
 DtBaseTableFunction (const DtSymbolString &name, const DtBaseTableFunction &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtBaseTableFunctionoperator= (const DtBaseTableFunction &orig)
 assignment operator
virtual bool init (DtU32 dim)
 Initialize the function to a dimension.
virtual DtReal lookup (DtReal coordinate1,...) const =0
 Look up data.
virtual DtReal lookup (const DtReal *coordinates) const =0
virtual DtReal integrate (DtReal lower0, DtReal upper0,...) const =0
 Integrate the function over a range.
virtual DtU32 dim () const
 Get dimension.
virtual void putData (FILE *fp, int indentLevel=0)=0
 Write/get data.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)=0
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.

Protected Attributes

DtU32 * myN
DtU32 myDim
 Number of data points along each dimension.

Detailed Description

class DtBaseTableFunction:

DtBaseTableFunction holds a base class for table functions. The domain is an arbitrary number of real values and the range is a single real value. The state includes the dimension of the function domain, and a pointer to an array of the number of data entries along each dimension. It is a virtual class, and the pure virtual functions are lookup functions for a domain point and an integrate function to find the integral over a subset of the domain.


Constructor & Destructor Documentation

default constructor

DtBaseTableFunction::DtBaseTableFunction ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
)

real constructor

DtBaseTableFunction::DtBaseTableFunction ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
)

destructor

basic copy constructor

DtBaseTableFunction::DtBaseTableFunction ( const DtString name,
const DtBaseTableFunction orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

full copy constructor

DtBaseTableFunction::DtBaseTableFunction ( const DtSymbolString name,
const DtBaseTableFunction orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

Member Function Documentation

DtBaseTableFunction& DtBaseTableFunction::operator= ( const DtBaseTableFunction orig)

assignment operator

virtual bool DtBaseTableFunction::init ( DtU32  dim) [virtual]

Initialize the function to a dimension.

virtual DtReal DtBaseTableFunction::lookup ( DtReal  coordinate1,
  ... 
) const [pure virtual]

Look up data.

Implemented in Dt1DRegularTableFn, and Dt1DTableFn.

virtual DtReal DtBaseTableFunction::lookup ( const DtReal *  coordinates) const [pure virtual]

Implemented in Dt1DRegularTableFn, and Dt1DTableFn.

virtual DtReal DtBaseTableFunction::integrate ( DtReal  lower0,
DtReal  upper0,
  ... 
) const [pure virtual]

Integrate the function over a range.

Implemented in Dt1DRegularTableFn, and Dt1DTableFn.

virtual DtU32 DtBaseTableFunction::dim ( ) const [virtual]

Get dimension.

virtual void DtBaseTableFunction::putData ( FILE *  fp,
int  indentLevel = 0 
) [pure virtual]

Write/get data.

Reimplemented from DtReaderWriter.

Implemented in Dt1DRegularTableFn, and Dt1DTableFn.

virtual DtlObjPtr DtBaseTableFunction::getData ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
) [pure virtual]

Implemented in Dt1DRegularTableFn, and Dt1DTableFn.

virtual const char* DtBaseTableFunction::readerWriterType ( ) const [virtual]

Used to supply a string type that this reader writer type is.

This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create

Reimplemented from DtReaderWriter.

Reimplemented in Dt1DRegularTableFn, and Dt1DTableFn.


Member Data Documentation

DtU32* DtBaseTableFunction::myN [protected]
DtU32 DtBaseTableFunction::myDim [protected]

Number of data points along each dimension.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)