Inheritance diagram for DtPrbProbabilityCoefficients:

Public Member Functions
	DtPrbProbabilityCoefficients ()

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

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

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

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

const DtPrbProbabilityCoefficients &	operator= (const DtPrbProbabilityCoefficients &orig)

virtual	~DtPrbProbabilityCoefficients ()

virtual DtReal &	operator[] (const int i)

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

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

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)

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

virtual DtReal	probability (DtReal value) const

virtual int	numCoefficients () const

virtual double	solveForMaximum () const

virtual double	solveForMinimum () const

virtual const DtReal *	coefficients () const

virtual void	setCoefficient (int col, double val)

bool	operator== (const DtPrbProbabilityCoefficients &) const

bool	operator!= (const DtPrbProbabilityCoefficients &rhs) const

virtual bool	isValid () 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	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

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

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 *	readerWriterType () const

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	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
int	myNumCoefficients

DtReal *	myCoefficientList

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

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

virtual

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

Reimplemented from DtReaderWriter.

virtual void DtPrbProbabilityCoefficients::putData	(	std::string &	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 value ) const

virtual

virtual int DtPrbProbabilityCoefficients::numCoefficients ( ) const

virtual

Returns the number of polynomial coefficients used in the probability equation.

virtual double DtPrbProbabilityCoefficients::solveForMaximum ( ) const

virtual

Solves the polynomial for the maximum solution. Currently only handles 2nd order and below. If you want to solve a cubic, by all means override this and add your own.

virtual double DtPrbProbabilityCoefficients::solveForMinimum ( ) const

virtual

Solves the polynomial for the "minimum" solution. That is, assuming this polynomial describes a physical quantity (e.g. explosive power) or a probability (e.g. P(hit)), the minimum value must be 0. Therefore this function solves for the value of the dependent variable such that the value of the polynomial is 0. Currently only handles 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 an input value. (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 some input value would be: Probabilty(r) = (-5.0E-008.0 * r^2) + (0.0 * r) + 1.0.

virtual void DtPrbProbabilityCoefficients::setCoefficient	(	int	col,
		double	val
	)

virtual

Sets the coefficient value at the position. if the position is not valid will not be set.

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

bool DtPrbProbabilityCoefficients::operator!= ( const DtPrbProbabilityCoefficients & rhs ) const

inline

virtual bool DtPrbProbabilityCoefficients::isValid ( ) const

virtual

Returns true if there is at least one non zero coefficient. If all are 0 this is "invalid".

Member Data Documentation

int DtPrbProbabilityCoefficients::myNumCoefficients

protected

DtReal* DtPrbProbabilityCoefficients::myCoefficientList

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/prbProbabilityCoefficients.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation