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

class Dt1DTableFn: More...

Inheritance diagram for Dt1DTableFn:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 Dt1DTableFn ()
 default constructor
 Dt1DTableFn (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 real constructor
 Dt1DTableFn (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual ~Dt1DTableFn ()
 destructor
 Dt1DTableFn (const Dt1DTableFn &orig)
 copy constructor
 Dt1DTableFn (const DtString &name, const Dt1DTableFn &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 full copy constructor
 Dt1DTableFn (const DtSymbolString &name, const Dt1DTableFn &orig, DtReaderWriterRegistry *parentRegistry=NULL)
Dt1DTableFnoperator= (const Dt1DTableFn &orig)
 assignment operator
virtual bool init (const DtReal value)
 init for 0-D table
virtual bool init (const DtU32 n, const DtReal *domain, const DtReal *data)
 init for regular 1-D table with DtReal pointer n is the number of data points, domain and data are the corresponding domain and range values for the data points.
virtual bool init (const DtU32 n, const DtNLengthRealVector &domain, const DtNLengthRealVector &data)
 init for regular 1-D table with vector data.
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
virtual DtReal lookup (DtReal coordinate1,...) const
 Look up data.
virtual DtReal lookup (const DtReal *coordinates) const
virtual DtReal integrate (DtReal lower, DtReal upper,...) const
 Integrate the function from the lower to the upper bound.
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 getSelf just calls the parent then calls the appropriate init().
virtual void putData (FILE *fp, int indentLevel=0)
 Write/get data.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)

Protected Member Functions

DtU32 findIndex (DtReal num) const
 Find an index for a real value greater than the lowest domain value.

Protected Attributes

DtNLengthRealVector myData
DtNLengthRealVector myDomain
DtNLengthRealVector myCollimatedData
DtReal * mySlope

Detailed Description

class Dt1DTableFn:

Dt1DTableFn holds a 1D table function. The data is represented in arbitrary increments. Methods are provided for looking up linearly interpolated values and integrating over a specified range. The time for a table lookup grows like log(n), where n is the number of data points.


Constructor & Destructor Documentation

default constructor

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

real constructor

Dt1DTableFn::Dt1DTableFn ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
)
virtual Dt1DTableFn::~Dt1DTableFn ( ) [virtual]

destructor

copy constructor

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

full copy constructor

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

Member Function Documentation

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

assignment operator

virtual bool Dt1DTableFn::init ( const DtReal  value) [virtual]

init for 0-D table

virtual bool Dt1DTableFn::init ( const DtU32  n,
const DtReal *  domain,
const DtReal *  data 
) [virtual]

init for regular 1-D table with DtReal pointer n is the number of data points, domain and data are the corresponding domain and range values for the data points.

virtual bool Dt1DTableFn::init ( const DtU32  n,
const DtNLengthRealVector domain,
const DtNLengthRealVector data 
) [virtual]

init for regular 1-D table with vector data.

virtual const char* Dt1DTableFn::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 DtBaseTableFunction.

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

Look up data.

Implements DtBaseTableFunction.

virtual DtReal Dt1DTableFn::lookup ( const DtReal *  coordinates) const [virtual]

Implements DtBaseTableFunction.

virtual DtReal Dt1DTableFn::integrate ( DtReal  lower,
DtReal  upper,
  ... 
) const [virtual]

Integrate the function from the lower to the upper bound.

Implements DtBaseTableFunction.

virtual void Dt1DTableFn::getSelf ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
) [virtual]

getSelf just calls the parent then calls the appropriate init().

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

Write/get data.

Implements DtBaseTableFunction.

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

Implements DtBaseTableFunction.

DtU32 Dt1DTableFn::findIndex ( DtReal  num) const [protected]

Find an index for a real value greater than the lowest domain value.

Uses a binary search to find it. The index is the point with the largest domain that is less than the value.


Member Data Documentation

DtReal* Dt1DTableFn::mySlope [protected]

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)