DtPrbStepFunction Class Reference

Inheritance diagram for DtPrbStepFunction:

Public Member Functions
	DtPrbStepFunction ()
	default constructor
	DtPrbStepFunction (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Constructor with parameters to set up read/writability correctly.
	DtPrbStepFunction (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtPrbStepFunction (const DtString &name, const DtPrbStepFunction &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtPrbStepFunction (const DtSymbolString &name, const DtPrbStepFunction &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtPrbStepFunction &	operator= (const DtPrbStepFunction &orig)
virtual	~DtPrbStepFunction ()
	destructor
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)
	Adds a table entry in sorted (ascending) order.
virtual bool	getProbabilities (DtReal value, DtPrbValueList *entry) const
	Fills in the DtPrbValueList with a category/value pair for each item on its list.
virtual double	minInputValue () const
virtual double	maxInputValue () const
virtual double	solveForMaximum () const
	Returns the maximum range.
virtual bool	isValid () const
	Returns true if there is at least one range item that has a hit probability > 0.
bool	operator== (const DtPrbStepFunction &) const
bool	operator!= (const DtPrbStepFunction &rhs) const
virtual bool	removeValue (double)
	Removes the given value and returns true if found.
virtual double	value (int index) const
	Returns the value at the given index.
virtual DtPrbValueList *	changeValue (double oldValue, double newValue, int *newColumn=0)
	Changes the value from the current value to the new value.
virtual DtPrbValueList *	changeValueForColumn (int col, double newRange, int *newColumn=0)
	Changes the range from the current range as the current range position to the new range and reorders as necessary.
virtual DtListItem *	lookupValue (double value) const
	Returns the value item.
virtual int	indexOfValue (double) const
	Returns the "column" of this value. Returns -1 if does not exist.
virtual DtPrbValueList *	changeValue (DtListItem *item, double newValue, int *newColumn=0)
	Changes the value of the given item to the new value.
void	emptyList ()
	Removes all items from the list.
void	copyList (const DtPrbStepFunction &orig)
	Adds all entries from orig to this list.
virtual int	addTableEntry (DtPrbValueList *tableEntry)
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual void	setRoundDown (bool)
	Accessor/mutator for myRoundDown.
bool	roundDown () const
Public Member Functions inherited from DtRwList
	DtRwList ()
	default constructor
	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwList ()
const DtRwList &	operator= (const DtRwList &orig)
	Calls down to DtReaderWriter::operator=(). List elements are not copied.
virtual DtListItem *	add (DtReaderWriter *data)
	Add element to the end of the list.
virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)
	Add element to the end of the list, but use the provided name in place of the object name on the data object.
virtual DtListItem *	addToStart (DtReaderWriter *data)
	Add element to the beginning of the list.
virtual DtListItem *	addToEnd (DtReaderWriter *data)
	Add element to the end of the list.
virtual void *	remove (DtReaderWriter *data, DtListItem *item)
	Remove an element from the list.
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
	Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual DtListItem *	addBefore (DtReaderWriter *data, DtReaderWriter *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtReaderWriter *after)
	Add element to the list just after the indicated item.
virtual void	removeAll ()
	Removes all the items in the list.
virtual void	removeAndDeleteAll ()
	Removes and deletes all items in the list.
virtual void	reset ()
	Calls removeAndDeleteAll.
bool	operator== (const DtRwList &rhs) const
	Iterates over all items and calls the factory to compare.
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)
	Invokes DtReaderWriter copy constructor.
	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)
	Add element to the list just after the indicated item.
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())
	Gets data from the environment value.
virtual std::set< DtString >	supportedXmlTypes () const
	Returns the list of xml types supported by this list. Default is all.
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
Static Public Member Functions inherited from DtRwList

Protected Member Functions
virtual void	prePutSelf ()
	Put in round down if true and remove after.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Creates a DtPrbValueList, reads it, and adds it to the list.
Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter *data, DtListItem *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtListItem *after)
	Add element to the list just after the indicated item.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.

Protected Attributes
bool	myRoundDown
	Determines if step function should round input down or up to closest entry.

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

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.

Reimplemented from DtRwList.

virtual const char* DtPrbStepFunction::xmlType ( ) const

inlinevirtual

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/prbStepFunction.h