Dt1DTableFn Class Reference

class Dt1DTableFn: More...

Inheritance diagram for Dt1DTableFn:

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)
Dt1DTableFn &	operator= (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)
	Deriving class overrides these to get/put class specific data.
Public Member Functions inherited from DtBaseTableFunction
	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 DtU32	dim () const
	Get dimension.
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	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 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
Protected Attributes inherited from DtBaseTableFunction
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 ()
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 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

Dt1DTableFn::Dt1DTableFn

(

)

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

Dt1DTableFn::Dt1DTableFn

(

const Dt1DTableFn &

orig

)

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

Reimplemented from DtReaderWriter.

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

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

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

DtNLengthRealVector Dt1DTableFn::myData

protected

DtNLengthRealVector Dt1DTableFn::myDomain

protected

DtNLengthRealVector Dt1DTableFn::myCollimatedData

protected

DtReal* Dt1DTableFn::mySlope

protected

---

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

• include/vrfutil/tableFn1D.h