DtPrbRangeTableEntry Class Reference

DtPrbRangeTableEntry. More...

Inheritance diagram for DtPrbRangeTableEntry:

Public Member Functions
	DtPrbRangeTableEntry ()
	default constructor
	DtPrbRangeTableEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtPrbRangeTableEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtPrbRangeTableEntry ()
	destructor
	DtPrbRangeTableEntry (const DtString &name, const DtPrbRangeTableEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtPrbRangeTableEntry (const DtSymbolString &name, const DtPrbRangeTableEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtPrbRangeTableEntry &	operator= (const DtPrbRangeTableEntry &orig)
	assignment operator
virtual DtPrbRangeTableEntry *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtPrbRangeTableEntry *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	addProbability (const DtString &name, DtReal value)
virtual DtReal	probability (const DtString &name) const
virtual void	setRange (DtReal range)
virtual DtReal	range () 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 *	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 void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Top level to read itself from an input stream.
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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
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)
	Add element to the list just before the indicated item.
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)
	Add element to the list just after the indicated item.
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	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 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 Member Functions
virtual void	putData (FILE *fp, int indentLevel=0)
	Outputs our range.
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
	Gets the range.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Creates a DtRwReal, reads it, and puts it on the list.
virtual void	copyList (const DtPrbRangeTableEntry &orig)
virtual void	emptyList ()
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.
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.

Protected Attributes
DtReal	myRange

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 ()
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

Detailed Description

DtPrbRangeTableEntry.

Instances of DtPrbRangeTableEntry are readable/writeable lists of probability entries, with putData outputting a range for which these probabilities apply. This is primarily a container class.

Constructor & Destructor Documentation

DtPrbRangeTableEntry::DtPrbRangeTableEntry

(

)

default constructor

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

constructor

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

virtual DtPrbRangeTableEntry::~DtPrbRangeTableEntry ( )

virtual

destructor

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

copy constructor

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

Member Function Documentation

DtPrbRangeTableEntry& DtPrbRangeTableEntry::operator=

(

const DtPrbRangeTableEntry &

orig

)

assignment operator

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

virtual

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

virtual

virtual void DtPrbRangeTableEntry::addProbability ( const DtString &  name, DtReal  value  )

virtual

virtual DtReal DtPrbRangeTableEntry::probability ( const DtString &  name ) const

virtual

virtual void DtPrbRangeTableEntry::setRange ( DtReal  range )

virtual

virtual DtReal DtPrbRangeTableEntry::range ( ) const

virtual

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

protectedvirtual

Outputs our range.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtPrbRangeTableEntry::getLocalData ( DtlObjPtr  args )

protectedvirtual

Gets the range.

Reimplemented from DtRwList.

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

protectedvirtual

Creates a DtRwReal, reads it, and puts it on the list.

Implements DtRwList.

virtual void DtPrbRangeTableEntry::copyList ( const DtPrbRangeTableEntry &  orig )

protectedvirtual

virtual void DtPrbRangeTableEntry::emptyList ( )

protectedvirtual

Member Data Documentation

DtReal DtPrbRangeTableEntry::myRange

protected

---

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

• include/vrfobjparam/rngTblEntry.h