VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions
DtDetectionPrbRangeCalcEntry Class Reference

DtDetectionPrbRangeCalcEntry is the derived form of DtRangeProbEntry that has a DtPrbCoefficientsRangeDeterminant. More...

Inheritance diagram for DtDetectionPrbRangeCalcEntry:
Inheritance graph
[legend]

Public Member Functions

 DtDetectionPrbRangeCalcEntry ()
 DtDetectionPrbRangeCalcEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 constructor with parameters to set up read/writability correctly
 DtDetectionPrbRangeCalcEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 DtDetectionPrbRangeCalcEntry (const DtString &name, const DtDetectionPrbRangeCalcEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtDetectionPrbRangeCalcEntry (const DtSymbolString &name, const DtDetectionPrbRangeCalcEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const
DtDetectionPrbRangeCalcEntry
operator= (const DtDetectionPrbRangeCalcEntry &orig)
virtual ~DtDetectionPrbRangeCalcEntry ()
 destructor
virtual DtRangeProbEntryclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtRangeProbEntryclone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void getProbabilities (DtReal range, DtPrbRangeTableEntry *entry)
 The caller provides a pointer to a DtPrbRangeTableEntry, which is filled in with the appropriate set of probabilities.
virtual void addProbabilityCoefficients (const DtPrbProbabilityCoefficients &coefficients)
virtual const
DtPrbCoefficientsRangeDeterminant
determinant () const
 Returns the object used to implement probability as a function of range.
- Public Member Functions inherited from DtRangeProbEntry
virtual ~DtRangeProbEntry ()
 destructor
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 DtRwEntityTypeentityType () 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 DtReaderWriteroperator= (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 aliasContaineraliases () 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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Protected Attributes

parameters

These parameters are available for setting in the OPD files.

DtPrbCoefficientsRangeDeterminant myDeterminant
 Parameter Name: range-determinant
Parameter Description: Can be either a list of probability-coefficients with the name "coefficients".
- Protected Attributes inherited from DtRangeProbEntry
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 DtReaderWriterFactoryfactory ()
- Protected Member Functions inherited from DtRangeProbEntry
 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 DtRangeProbEntryoperator= (const DtRangeProbEntry &orig)
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
static DtGetSelfCallbackInfo thePostGetSelfCallback
static DtPutSelfCallbackInfo thePrePutSelfCallback
static const DtVariableBindingsList theEmptyVariableBindingsList
static DtReaderWriterFactory theFactory

Detailed Description

DtDetectionPrbRangeCalcEntry is the derived form of DtRangeProbEntry that has a DtPrbCoefficientsRangeDeterminant.

Constructor & Destructor Documentation

DtDetectionPrbRangeCalcEntry::DtDetectionPrbRangeCalcEntry ( )
DtDetectionPrbRangeCalcEntry::DtDetectionPrbRangeCalcEntry ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
)

constructor with parameters to set up read/writability correctly

DtDetectionPrbRangeCalcEntry::DtDetectionPrbRangeCalcEntry ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
)
DtDetectionPrbRangeCalcEntry::DtDetectionPrbRangeCalcEntry ( const DtString name,
const DtDetectionPrbRangeCalcEntry orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor

DtDetectionPrbRangeCalcEntry::DtDetectionPrbRangeCalcEntry ( const DtSymbolString name,
const DtDetectionPrbRangeCalcEntry orig,
DtReaderWriterRegistry parentRegistry = NULL 
)
virtual DtDetectionPrbRangeCalcEntry::~DtDetectionPrbRangeCalcEntry ( )
virtual

destructor

Member Function Documentation

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

Implements DtRangeProbEntry.

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

Implements DtRangeProbEntry.

virtual void DtDetectionPrbRangeCalcEntry::getProbabilities ( DtReal  range,
DtPrbRangeTableEntry entry 
)
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.

Implements DtRangeProbEntry.

virtual void DtDetectionPrbRangeCalcEntry::addProbabilityCoefficients ( const DtPrbProbabilityCoefficients coefficients)
virtual
virtual const DtPrbCoefficientsRangeDeterminant& DtDetectionPrbRangeCalcEntry::determinant ( ) const
virtual

Returns the object used to implement probability as a function of range.

Accessor for myDeterminant

Member Data Documentation

DtPrbCoefficientsRangeDeterminant DtDetectionPrbRangeCalcEntry::myDeterminant
protected

Parameter Name: range-determinant
Parameter Description: Can be either a list of probability-coefficients with the name "coefficients".


Parameter Default Value:


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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)