Dt1DRegularTableFn Class Reference

class Dt1DRegularTableFn: More...

Inheritance diagram for Dt1DRegularTableFn:

List of all members.

Public Member Functions
	Dt1DRegularTableFn ()
	default constructor
	Dt1DRegularTableFn (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	Dt1DRegularTableFn (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Dt1DRegularTableFn (const DtReal bottom, const DtReal top, const DtReal inc, const DtReal *data)
	constructor with data
virtual	~Dt1DRegularTableFn ()
	destructor
	Dt1DRegularTableFn (const Dt1DRegularTableFn &orig)
	copy constructor
	Dt1DRegularTableFn (const DtString &name, const Dt1DRegularTableFn &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	full copy constructor
	Dt1DRegularTableFn (const DtSymbolString &name, const Dt1DRegularTableFn &orig, DtReaderWriterRegistry *parentRegistry=NULL)
Dt1DRegularTableFn &	operator= (const Dt1DRegularTableFn &orig)
	assignment operator
virtual bool	init (const DtReal value)
	init for 0-D table
virtual bool	init (const DtReal bottom, const DtReal top, const DtReal inc, const DtReal *data)
	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.
virtual bool	init (const DtReal bottom, const DtReal top, const DtReal inc, const DtNLengthRealVector &data)
	Vector version.
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 over a range.
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)
void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Override to ensure myDomainTop does not get written to file.
Protected Attributes
DtReal	mySpan
DtRwReal	myDomainTop
DtRwReal	myDomainBottom
DtRwReal	myInc
DtNLengthRealVector	myData
DtReal *	myDomain
DtReal *	mySlope

---

Detailed Description

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.

---

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.

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 DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[virtual]

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

virtual void Dt1DRegularTableFn::putData	(	FILE *	fp,
		int	indentLevel = 0
	)		[virtual]

Write/get data.

Implements DtBaseTableFunction.

virtual DtlObjPtr Dt1DRegularTableFn::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[virtual]

Implements DtBaseTableFunction.

void Dt1DRegularTableFn::putSelf	(	FILE *	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:

• include/vrfutil/tableFn1DReg.h