DtPrbProbabilityCoefficients Class Reference

Inheritance diagram for DtPrbProbabilityCoefficients:

Public Member Functions
	DtPrbProbabilityCoefficients ()
	default constructor
	DtPrbProbabilityCoefficients (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Constructor with parameters to set up read/writability correctly.
	DtPrbProbabilityCoefficients (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtPrbProbabilityCoefficients (const DtString &name, const DtPrbProbabilityCoefficients &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtPrbProbabilityCoefficients (const DtSymbolString &name, const DtPrbProbabilityCoefficients &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtPrbProbabilityCoefficients &	operator= (const DtPrbProbabilityCoefficients &orig)
virtual	~DtPrbProbabilityCoefficients ()
	destructor
virtual DtReal &	operator[] (const int i)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtPrbProbabilityCoefficients *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtPrbProbabilityCoefficients *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	setNumCoefficients (int num)
	Set numCoefficients will destroy the coefficient list (if it exists) and make a new one of the specified size.
virtual void	setCoefficients (int num, double probabilityCoefficients[])
	Destroys existing coefficient list (if it exists), makes a new one of the given size num, and populates it with the values in probabilityCoefficients.
virtual DtReal	probability (DtReal range)
virtual int	numCoefficients () const
	Returns the number of polynomial coefficients used in the probability as a function range equation.
virtual double	solveForMaximum ()
	Solves the polynomial for the maximum solution.
virtual const DtReal *	coefficients () const
	Returns array of coefficients to be used in an expression of probability versus range.
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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
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
int	myNumCoefficients
DtReal *	myCoefficientList
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

Constructor & Destructor Documentation

DtPrbProbabilityCoefficients::DtPrbProbabilityCoefficients

(

)

default constructor

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

Constructor with parameters to set up read/writability correctly.

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

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

copy constructor

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

virtual DtPrbProbabilityCoefficients::~DtPrbProbabilityCoefficients ( )

virtual

destructor

Member Function Documentation

const DtPrbProbabilityCoefficients& DtPrbProbabilityCoefficients::operator=

(

const DtPrbProbabilityCoefficients &

orig

)

virtual DtReal& DtPrbProbabilityCoefficients::operator[] ( const int  i )

virtual

virtual DtlObjPtr DtPrbProbabilityCoefficients::getData ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

virtual

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

Reimplemented from DtReaderWriter.

virtual void DtPrbProbabilityCoefficients::putData ( FILE *  fp, int  indentLevel = 0  )

virtual

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

Reimplemented from DtReaderWriter.

virtual DtPrbProbabilityCoefficients* DtPrbProbabilityCoefficients::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

virtual

virtual DtPrbProbabilityCoefficients* DtPrbProbabilityCoefficients::clone ( const DtSymbolString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

virtual

virtual void DtPrbProbabilityCoefficients::setNumCoefficients ( int  num )

virtual

Set numCoefficients will destroy the coefficient list (if it exists) and make a new one of the specified size.

virtual void DtPrbProbabilityCoefficients::setCoefficients ( int  num, double  probabilityCoefficients[]  )

virtual

Destroys existing coefficient list (if it exists), makes a new one of the given size num, and populates it with the values in probabilityCoefficients.

probabilityCoefficients must be an array of size num.

virtual DtReal DtPrbProbabilityCoefficients::probability ( DtReal  range )

virtual

virtual int DtPrbProbabilityCoefficients::numCoefficients ( ) const

virtual

Returns the number of polynomial coefficients used in the probability as a function range equation.

virtual double DtPrbProbabilityCoefficients::solveForMaximum ( )

virtual

Solves the polynomial for the maximum solution.

Currently only handels 2nd order and below. If you want to solve a cubic, by all means override this and add your own.

virtual const DtReal* DtPrbProbabilityCoefficients::coefficients ( ) const

virtual

Returns array of coefficients to be used in an expression of probability versus range.

(Note there are numCoefficients() items in the list.) The coefficients are in descending order. For example, if there are 3 coefficients, and the values returned by this call are -5.0E-008, 0.0, 1.0, then the expression for probability as a function of range would be: Probabilty(r) = (-5.0E-008.0 * r^2) + (0.0 * r) + 1.0 where r is range in meters

Member Data Documentation

int DtPrbProbabilityCoefficients::myNumCoefficients

protected

DtReal* DtPrbProbabilityCoefficients::myCoefficientList

protected

---

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

• include/vrfobjparam/probCoeff.h