class Dt1DRegularTableFn:

Dt1DRegularTableFn holds a 1D table of values. The data is represented in periodic increments. The bottom end of the domain is represented by myBottom, the domain increment by myInc, and the (DtReal) range data by myData. The integrate() function is not yet implemented.

Inheritance diagram for Dt1DRegularTableFn:

[legend]

Public Member Functions
	Dt1DRegularTableFn ()

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

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

	Dt1DRegularTableFn (const DtReal bottom, const DtReal top, const DtReal inc, const DtReal *data)

virtual	~Dt1DRegularTableFn ()

	Dt1DRegularTableFn (const Dt1DRegularTableFn &orig)

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

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

Dt1DRegularTableFn &	operator= (const Dt1DRegularTableFn &orig)

virtual bool	init (const DtReal value)

virtual bool	init (const DtReal bottom, const DtReal top, const DtReal inc, const DtReal *data)

virtual bool	init (const DtReal bottom, const DtReal top, const DtReal inc, const DtNLengthRealVector &data)

virtual const char *	readerWriterType () const

bool	operator== (const Dt1DRegularTableFn &) const

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

virtual DtReal	lookup (const DtReal *coordinates) const

virtual DtReal	integrate (DtReal lower, DtReal upper,...) const

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

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

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

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

Public Member Functions inherited from DtBaseTableFunction
	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 DtU32	dim () 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	postPutSelf ()

virtual void	prePutSelf ()

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
DtReal	mySpan

DtRwReal	myDomainTop

DtRwReal	myDomainBottom

DtRwReal	myInc

DtNLengthRealVector	myData

DtReal *	myDomain

DtReal *	mySlope

Protected Attributes inherited from DtBaseTableFunction
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

Dt1DRegularTableFn::Dt1DRegularTableFn ( )

default constructor

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

real constructor

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

Dt1DRegularTableFn::Dt1DRegularTableFn	(	const DtReal	bottom,
		const DtReal	top,
		const DtReal	inc,
		const DtReal *	data
	)

constructor with data

virtual Dt1DRegularTableFn::~Dt1DRegularTableFn ( )

virtual

destructor

Dt1DRegularTableFn::Dt1DRegularTableFn ( const Dt1DRegularTableFn & orig )

copy constructor

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

full copy constructor

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

Member Function Documentation

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

assignment operator

virtual bool Dt1DRegularTableFn::init ( const DtReal value )

virtual

init for 0-D table

virtual bool Dt1DRegularTableFn::init	(	const DtReal	bottom,
		const DtReal	top,
		const DtReal	inc,
		const DtReal *	data
	)

virtual

init for regular 1-D table with DtReal pointer Variable bottom is the lower limit of the domain, top is the upper limit of the domain, and inc is the domain increment. For example a domain of 1,2,3 would give bottom=1,top=3, inc=1; Variable data gives the range information for each increment.

virtual bool Dt1DRegularTableFn::init	(	const DtReal	bottom,
		const DtReal	top,
		const DtReal	inc,
		const DtNLengthRealVector &	data
	)

virtual

Vector version.

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

bool Dt1DRegularTableFn::operator== ( const Dt1DRegularTableFn & ) const

virtual DtReal Dt1DRegularTableFn::lookup	(	DtReal	coordinate1,
			...
	)		const

virtual

Look up data.

Implements DtBaseTableFunction.

virtual DtReal Dt1DRegularTableFn::lookup ( const DtReal * coordinates ) const

virtual

Implements DtBaseTableFunction.

virtual DtReal Dt1DRegularTableFn::integrate	(	DtReal	lower,
		DtReal	upper,
			...
	)		const

virtual

Integrate the function over a range.

Implements DtBaseTableFunction.

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

virtual

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

Reimplemented from DtReaderWriter.

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

virtual

Write/get data.

Implements DtBaseTableFunction.

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

virtual

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

Implements DtBaseTableFunction.

void Dt1DRegularTableFn::putSelf	(	std::string &	fp,
		int	indentLevel = `0`,
		bool	writeUnspecified = `false`,
		const DtFilename &	path = `DtReaderWriter::appPath()`
	)

virtual

Override to ensure myDomainTop does not get written to file.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtReal Dt1DRegularTableFn::mySpan

protected

DtRwReal Dt1DRegularTableFn::myDomainTop

protected

DtRwReal Dt1DRegularTableFn::myDomainBottom

protected

DtRwReal Dt1DRegularTableFn::myInc

protected

DtNLengthRealVector Dt1DRegularTableFn::myData

protected

DtReal* Dt1DRegularTableFn::myDomain

protected

DtReal* Dt1DRegularTableFn::mySlope

protected

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation