DtBaseTableFunction Class Reference

class DtBaseTableFunction: More...

Inheritance diagram for DtBaseTableFunction:

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)
DtBaseTableFunction &	operator= (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
	Deriving class overrides these to get/put class specific data.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Protected Attributes
DtU32 *	myN
DtU32	myDim
	Number of data points along each dimension.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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::pair < DtSymbolString, DtString >	DtVariableNameType
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static DtReaderWriterFactory *	factory ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

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

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 ( 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

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:

• include/vrfutil/baseTableFn.h