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.

Inheritance diagram for DtBaseTableFunction:

[legend]

Public Member Functions
	DtBaseTableFunction ()

	DtBaseTableFunction (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

	DtBaseTableFunction (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)

virtual	~DtBaseTableFunction ()

	DtBaseTableFunction (const DtBaseTableFunction &orig)

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

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

DtBaseTableFunction &	operator= (const DtBaseTableFunction &orig)

virtual bool	init (DtU32 dim)

virtual DtReal	lookup (DtReal coordinate1,...) const =0

virtual DtReal	lookup (const DtReal *coordinates) const =0

virtual DtReal	integrate (DtReal lower0, DtReal upper0,...) const =0

virtual DtU32	dim () const

virtual void	putData (std::string &fp, int indentLevel=0)=0

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)=0

virtual const char *	readerWriterType () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	wasUpdatedSince (DtTime t) const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Attributes
DtU32 *	myN

DtU32	myDim

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer

typedef std::vector < DtSymbolString >::iterator	aliasIter

typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter

typedef std::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtBaseTableFunction::DtBaseTableFunction ( )

default constructor

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

real constructor

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

virtual DtBaseTableFunction::~DtBaseTableFunction ( )

virtual

destructor

DtBaseTableFunction::DtBaseTableFunction ( const DtBaseTableFunction & orig )

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	(	std::string &	fp,
		int	indentLevel = `0`
	)

pure virtual

Write/get data.

Reimplemented from DtReaderWriter.

Implemented in Dt1DRegularTableFn, and Dt1DTableFn.

virtual DtlObjPtr DtBaseTableFunction::getData	(	DtlObjPtr	args,
		const DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	variableBindings
	)

pure virtual

Deriving class overrides these to get/put class specific data.

Reimplemented from DtReaderWriter.

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfutil/baseTableFunction.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation