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
bool	operator== (const Dt1DTableFn &) const
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 DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getSelf just calls the parent then calls the appropriate init().
virtual void	putData (std::string &fp, int indentLevel=0)
	Write/get data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

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
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
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::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 ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
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

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

bool Dt1DTableFn::operator==

(

const Dt1DTableFn &

)

const

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 DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

virtual

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

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

virtual

Write/get data.

Implements DtBaseTableFunction.

virtual DtlObjPtr Dt1DTableFn::getData ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths, 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

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/1DTableFn.h