DtPrbStepFunction Class Reference

Inheritance diagram for DtPrbStepFunction:

Public Member Functions
	DtPrbStepFunction ()
	DtPrbStepFunction (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtPrbStepFunction (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtPrbStepFunction (const DtString &name, const DtPrbStepFunction &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtPrbStepFunction (const DtSymbolString &name, const DtPrbStepFunction &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtPrbStepFunction &	operator= (const DtPrbStepFunction &orig)
virtual	~DtPrbStepFunction ()
virtual DtPrbStepFunction *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtPrbStepFunction *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual int	addTableEntry (const DtPrbValueList &tableEntry)
virtual bool	getProbabilities (DtReal value, DtPrbValueList *entry) const
virtual double	minInputValue () const
virtual double	maxInputValue () const
virtual double	solveForMaximum () const
virtual bool	isValid () const
bool	operator== (const DtPrbStepFunction &) const
bool	operator!= (const DtPrbStepFunction &rhs) 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 DtListItem *	lookupValue (double value) const
virtual int	indexOfValue (double) const
virtual DtPrbValueList *	changeValue (DtListItem *item, double newValue, int *newColumn=0)
void	emptyList ()
void	copyList (const DtPrbStepFunction &orig)
virtual int	addTableEntry (DtPrbValueList *tableEntry)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual void	setRoundDown (bool)
bool	roundDown () const
Public Member Functions inherited from DtRwList
	DtRwList ()
	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwList ()
const DtRwList &	operator= (const DtRwList &orig)
virtual DtListItem *	add (DtReaderWriter *data)
virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)
virtual DtListItem *	addToStart (DtReaderWriter *data)
virtual DtListItem *	addToEnd (DtReaderWriter *data)
virtual void *	remove (DtReaderWriter *data, DtListItem *item)
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual DtListItem *	addBefore (DtReaderWriter *data, DtReaderWriter *before)
virtual DtListItem *	addAfter (DtReaderWriter *data, DtReaderWriter *after)
virtual void	removeAll ()
virtual void	removeAndDeleteAll ()
virtual void	reset ()
bool	operator== (const DtRwList &rhs) const
bool	operator!= (const DtRwList &rhs) const
virtual void	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
virtual void	populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)
virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual std::set< DtString >	supportedXmlTypes () 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	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 int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
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 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	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static const char *	theXmlType ()
Static Public Member Functions inherited from DtRwList
static const char *	theXmlType ()
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
virtual void	prePutSelf ()
virtual void	postPutSelf ()
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter *data, DtListItem *before)
virtual DtListItem *	addAfter (DtReaderWriter *data, DtListItem *after)
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
bool	myRoundDown
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 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

DtPrbStepFunction::DtPrbStepFunction

(

)

default constructor

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

Constructor with parameters to set up read/writability correctly.

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

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

copy constructor

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

virtual DtPrbStepFunction::~DtPrbStepFunction ( )

virtual

destructor

Member Function Documentation

const DtPrbStepFunction& DtPrbStepFunction::operator=

(

const DtPrbStepFunction &

orig

)

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

virtual

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

virtual

virtual int DtPrbStepFunction::addTableEntry ( const DtPrbValueList &  tableEntry )

virtual

Adds a table entry in sorted (ascending) order.

virtual bool DtPrbStepFunction::getProbabilities ( DtReal  value, DtPrbValueList *  entry  ) const

virtual

Fills in the DtPrbValueList with a category/value pair for each item on its list. Returns true if an entry was found for the specified value. If no entry was found, returns false, and returns a pointer to an entry with all 0 values.

virtual double DtPrbStepFunction::minInputValue ( ) const

virtual

Returns

The minimum value specified in the list.

0 if no entries exist.

virtual double DtPrbStepFunction::maxInputValue ( ) const

virtual

Returns

The maximum value specified in the list.

0 if no entries exist.

virtual double DtPrbStepFunction::solveForMaximum ( ) const

virtual

Returns the maximum range.

virtual bool DtPrbStepFunction::isValid ( ) const

virtual

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

bool DtPrbStepFunction::operator==

(

const DtPrbStepFunction &

)

const

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

inline

virtual bool DtPrbStepFunction::removeValue ( double  )

virtual

Removes the given value and returns true if found.

virtual double DtPrbStepFunction::value ( int  index ) const

virtual

Returns the value at the given index.

virtual DtPrbValueList* DtPrbStepFunction::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* DtPrbStepFunction::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 DtListItem* DtPrbStepFunction::lookupValue ( double  value ) const

virtual

Returns the value item.

virtual int DtPrbStepFunction::indexOfValue ( double  ) const

virtual

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

virtual void DtPrbStepFunction::setRoundDown ( bool  )

virtual

Accessor/mutator for myRoundDown.

bool DtPrbStepFunction::roundDown ( ) const

inline

Accessor/mutator for myRoundDown.

virtual DtPrbValueList* DtPrbStepFunction::changeValue ( DtListItem *  item, double  newValue, int *  newColumn = 0  )

virtual

Changes the value of the given item to the new value.

void DtPrbStepFunction::emptyList

(

)

Removes all items from the list. Non-virtual because it is called by constructors/destructors.

void DtPrbStepFunction::copyList

(

const DtPrbStepFunction &

orig

)

Adds all entries from orig to this list. Does not clear local list first. Non-virtual because it is called by constructors/destructors.

virtual int DtPrbStepFunction::addTableEntry ( DtPrbValueList *  tableEntry )

virtual

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

static const char* DtPrbStepFunction::theXmlType ( )

static

The type that is used when archiving to an XML stream.

virtual const char* DtPrbStepFunction::xmlType ( ) const

inlinevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtRwList.

References DtRwList::theXmlType().

virtual void DtPrbStepFunction::prePutSelf ( )

protectedvirtual

Put in round down if true and remove after.

Reimplemented from DtReaderWriter.

virtual void DtPrbStepFunction::postPutSelf ( )

protectedvirtual

Called after either version of put self (file or environment). Default is no-op.

Reimplemented from DtReaderWriter.

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

protectedvirtual

Creates a DtPrbValueList, reads it, and adds it to the list.

Implements DtRwList.

Member Data Documentation

bool DtPrbStepFunction::myRoundDown

protected

Determines if step function should round input down or up to closest entry.

---

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

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