DtPrbStepFunctionDeterminant provides a list of probabilities based on an input value. These probabilities are looked up in a table that is managed by the DtPrbStepFunction that is a member of this class.

Inheritance diagram for DtPrbStepFunctionDeterminant:

[legend]

Public Member Functions
	DtPrbStepFunctionDeterminant ()

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

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

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

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

const DtPrbStepFunctionDeterminant &	operator= (const DtPrbStepFunctionDeterminant &orig)

virtual	~DtPrbStepFunctionDeterminant ()

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

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

virtual void	addTableEntry (const DtPrbValueList &tableEntry)

virtual void	getProbabilities (DtReal value, DtPrbValueList *entry) const

virtual double	getMaximumInputValue () const

virtual double	getMinimumInputValue () const

virtual const DtPrbStepFunction &	stepFunction () const

bool	operator== (const DtPrbStepFunctionDeterminant &) const

bool	operator!= (const DtPrbStepFunctionDeterminant &rhs) const

virtual double	solveForMaximum () const

virtual bool	isValid () const

virtual bool	removeValue (double)

virtual double	value (int index) const

virtual DtPrbValueList *	changeValue (double oldValue, double newValue, int *newColumn=0)

virtual DtPrbValueList *	changeValueForColumn (int col, double newRange, int *newColumn=0)

virtual int	indexOfValue (double) const

virtual void	setStepFunction (const DtPrbStepFunction &)


virtual void	setRoundDown (bool)

virtual bool	roundDown () 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	wasUpdatedSince (DtTime t) const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

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

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

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
parameters
These parameters are available for setting in the OPD files.
DtPrbStepFunction	myStepFunction

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 DtPrbDeterminant
	DtPrbDeterminant ()

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

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

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

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

const DtPrbDeterminant &	operator= (const DtPrbDeterminant &orig)

virtual	~DtPrbDeterminant ()

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

DtPrbStepFunctionDeterminant::DtPrbStepFunctionDeterminant ( )

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

constructor with parameters to set up read/writability correctly

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

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

copy constructor

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

virtual DtPrbStepFunctionDeterminant::~DtPrbStepFunctionDeterminant ( )

virtual

destructor

Member Function Documentation

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

virtual DtPrbDeterminant* DtPrbStepFunctionDeterminant::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

Implements DtPrbDeterminant.

virtual DtPrbDeterminant* DtPrbStepFunctionDeterminant::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

Implements DtPrbDeterminant.

virtual void DtPrbStepFunctionDeterminant::addTableEntry ( const DtPrbValueList & tableEntry )

virtual

Adds a table entry in sorted (ascending) order.

virtual void DtPrbStepFunctionDeterminant::getProbabilities	(	DtReal	value,
		DtPrbValueList *	entry
	)		const

virtual

The caller provides a pointer to a DtPrbValueList, which is filled in with the appropriate set of probabilities.

Implements DtPrbDeterminant.

virtual double DtPrbStepFunctionDeterminant::getMaximumInputValue ( ) const

virtual

Determines the maximum input value that produces any probability.

Implements DtPrbDeterminant.

virtual double DtPrbStepFunctionDeterminant::getMinimumInputValue ( ) const

virtual

Determines the minimum input value that produces any probability.

Implements DtPrbDeterminant.

virtual const DtPrbStepFunction& DtPrbStepFunctionDeterminant::stepFunction ( ) const

virtual

Accessor for myStepFunction.

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

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

inline

virtual double DtPrbStepFunctionDeterminant::solveForMaximum ( ) const

virtual

Returns the maximum range.

virtual void DtPrbStepFunctionDeterminant::setRoundDown ( bool )

virtual

Accessor/mutator for myStepFunction round down.

virtual bool DtPrbStepFunctionDeterminant::roundDown ( ) const

virtual

Accessor/mutator for myStepFunction round down.

virtual bool DtPrbStepFunctionDeterminant::isValid ( ) const

virtual

Returns true if there is at least one range item that has a hit probability > 0.

virtual bool DtPrbStepFunctionDeterminant::removeValue ( double )

virtual

Removes the given value and returns true if found.

virtual double DtPrbStepFunctionDeterminant::value ( int index ) const

virtual

Returns the value at the given index.

virtual DtPrbValueList* DtPrbStepFunctionDeterminant::changeValue	(	double	oldValue,
		double	newValue,
		int *	newColumn = `0`
	)

virtual

Changes the value from the current value to the new value. If the new range exists then will reset that range to the current ranges values.

virtual DtPrbValueList* DtPrbStepFunctionDeterminant::changeValueForColumn	(	int	col,
		double	newRange,
		int *	newColumn = `0`
	)

virtual

Changes the range from the current range as the current range position to the new range and reorders as necessary.

virtual int DtPrbStepFunctionDeterminant::indexOfValue ( double ) const

virtual

Returns the "column" of this value. Returns -1 if does not exist.

virtual void DtPrbStepFunctionDeterminant::setStepFunction ( const DtPrbStepFunction & )

virtual

Sets the step function into the determinant.

Member Data Documentation

DtPrbStepFunction DtPrbStepFunctionDeterminant::myStepFunction

protected

Parameter Name: step-function
Parameter Description: List of value/probability entries, in order of increasing value. The probability for a given entry applies to a value interval going from the value in the previous entry to the current entry value. For the first item in the list, the probability applies to a value of zero to the value specified in the entry.
Parameter Default Value:
.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation