DtRangeProbEntry Class Reference

DtRangeProbEntry is an abstract class whose deriving classes will have one of the two forms of DtPrbRangeDeterminant. More...

Inheritance diagram for DtRangeProbEntry:

Public Member Functions
virtual	~DtRangeProbEntry ()
	destructor
virtual DtRangeProbEntry *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const =0
virtual DtRangeProbEntry *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const =0
virtual void	getProbabilities (DtReal range, DtPrbRangeTableEntry *entry)=0
	The caller provides a pointer to a DtPrbRangeTableEntry, which is filled in with the appropriate set of probabilities.
virtual void	setEntityType (const DtEntityType &entityType)
	Accessor/mutator for myEntityType We return the DtRwEntityType instead of the normal DtEntityType because DtRwEntityType has relational operators implemented.
virtual const DtRwEntityType &	entityType () const
	Accessor/mutator for myEntityType We return the DtRwEntityType instead of the normal DtEntityType because DtRwEntityType has relational operators implemented.
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	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
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
	DtRangeProbEntry ()
	default constructor
	DtRangeProbEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Constructor with parameters to set up read/writability correctly.
	DtRangeProbEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRangeProbEntry (const DtString &name, const DtRangeProbEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtRangeProbEntry (const DtSymbolString &name, const DtRangeProbEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtRangeProbEntry &	operator= (const DtRangeProbEntry &orig)
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.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwEntityType	myEntityType
	Parameter Name: entity-type Parameter Description: Parameter Default Value: .
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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

DtRangeProbEntry is an abstract class whose deriving classes will have one of the two forms of DtPrbRangeDeterminant.

Constructor & Destructor Documentation

DtRangeProbEntry::DtRangeProbEntry ( )

protected

default constructor

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

protected

Constructor with parameters to set up read/writability correctly.

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

protected

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

protected

copy constructor

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

protected

virtual DtRangeProbEntry::~DtRangeProbEntry ( )

virtual

destructor

Member Function Documentation

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

protected

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

pure virtual

Implemented in DtDetectionPrbRangeCalcEntry, and DtDetectionPrbRangeLookupEntry.

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

pure virtual

Implemented in DtDetectionPrbRangeCalcEntry, and DtDetectionPrbRangeLookupEntry.

virtual void DtRangeProbEntry::getProbabilities ( DtReal  range, DtPrbRangeTableEntry *  entry  )

pure virtual

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

This version just calls through to the DtPrbRangeDeterminant the derived class provides.

Implemented in DtDetectionPrbRangeCalcEntry, and DtDetectionPrbRangeLookupEntry.

virtual void DtRangeProbEntry::setEntityType ( const DtEntityType &  entityType )

virtual

Accessor/mutator for myEntityType We return the DtRwEntityType instead of the normal DtEntityType because DtRwEntityType has relational operators implemented.

virtual const DtRwEntityType& DtRangeProbEntry::entityType ( ) const

virtual

Accessor/mutator for myEntityType We return the DtRwEntityType instead of the normal DtEntityType because DtRwEntityType has relational operators implemented.

Member Data Documentation

DtRwEntityType DtRangeProbEntry::myEntityType

protected

Parameter Name: entity-type
Parameter Description:
Parameter Default Value:
.

---

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

• include/vrfobjparam/rngPrbEnt.h