VR-Forces 4.5 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
DtPrbProbabilityCoefficients Class Reference
Inheritance diagram for DtPrbProbabilityCoefficients:
Inheritance graph
[legend]

Public Member Functions

 DtPrbProbabilityCoefficients ()
 default constructor
 DtPrbProbabilityCoefficients (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 Constructor with parameters to set up read/writability correctly.
 DtPrbProbabilityCoefficients (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 DtPrbProbabilityCoefficients (const DtString &name, const DtPrbProbabilityCoefficients &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtPrbProbabilityCoefficients (const DtSymbolString &name, const DtPrbProbabilityCoefficients &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const
DtPrbProbabilityCoefficients
operator= (const DtPrbProbabilityCoefficients &orig)
virtual ~DtPrbProbabilityCoefficients ()
 destructor
virtual DtReal & operator[] (const int i)
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void putData (std::string &fp, int indentLevel=0)
 Deriving class overrides these to get/put class specific data.
virtual
DtPrbProbabilityCoefficients
clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual
DtPrbProbabilityCoefficients
clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void setNumCoefficients (int num)
 Set numCoefficients will destroy the coefficient list (if it exists) and make a new one of the specified size.
virtual void setCoefficients (int num, double probabilityCoefficients[])
 Destroys existing coefficient list (if it exists), makes a new one of the given size num, and populates it with the values in probabilityCoefficients.
virtual DtReal probability (DtReal value) const
virtual int numCoefficients () const
 Returns the number of polynomial coefficients used in the probability equation.
virtual double solveForMaximum () const
 Solves the polynomial for the maximum solution.
virtual double solveForMinimum () const
 Solves the polynomial for the minimum solution.
virtual const DtReal * coefficients () const
 Returns array of coefficients to be used in an expression of probability versus an input value.
- 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 DtReaderWriteroperator= (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 postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op.
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op.
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 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 aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
bool isReadonly () const
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
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 const charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () const
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 DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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 DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () const
virtual DtString toXml () const
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 &)
 Restires object from given xml file.
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data.
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference.
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 Gets data from the environment value.
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.

Protected Attributes

int myNumCoefficients
DtReal * myCoefficientList
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
DtReaderWriterRegistrymyParentRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
DtReaderWritermyDefaultValue
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::vector< DtFilename > SearchPaths
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
- 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 chartheXmlType ()
 The type that is used when archiving to an XML stream.
static const DtFilename & appPath ()
 Gets the current working directory.
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory.
static void createReaderWriterFactory ()
static void cleanupFactory ()
static DtReaderWriterFactoryfactory ()
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 Gets the named attribute from a DtEnvValueSP.
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
static DtGetSelfCallbackInfo thePostGetSelfCallback
static DtPutSelfCallbackInfo thePrePutSelfCallback
static const DtVariableBindingsList theEmptyVariableBindingsList
static bool theCreatorFcnSet
static DtReaderWriterFactorytheFactory
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
static bool thePutIndent

Constructor & Destructor Documentation

DtPrbProbabilityCoefficients::DtPrbProbabilityCoefficients ( )

default constructor

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

Constructor with parameters to set up read/writability correctly.

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

copy constructor

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

destructor

Member Function Documentation

const DtPrbProbabilityCoefficients& DtPrbProbabilityCoefficients::operator= ( const DtPrbProbabilityCoefficients orig)
virtual DtReal& DtPrbProbabilityCoefficients::operator[] ( const int  i)
virtual
virtual DtlObjPtr DtPrbProbabilityCoefficients::getData ( DtlObjPtr  args,
const DtReaderWriter::SearchPaths searchPaths,
const DtVariableBindingsList variableBindings 
)
virtual
virtual void DtPrbProbabilityCoefficients::putData ( std::string &  fp,
int  indentLevel = 0 
)
virtual

Deriving class overrides these to get/put class specific data.

Reimplemented from DtReaderWriter.

virtual DtPrbProbabilityCoefficients* DtPrbProbabilityCoefficients::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const
virtual
virtual DtPrbProbabilityCoefficients* DtPrbProbabilityCoefficients::clone ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const
virtual
virtual void DtPrbProbabilityCoefficients::setNumCoefficients ( int  num)
virtual

Set numCoefficients will destroy the coefficient list (if it exists) and make a new one of the specified size.

virtual void DtPrbProbabilityCoefficients::setCoefficients ( int  num,
double  probabilityCoefficients[] 
)
virtual

Destroys existing coefficient list (if it exists), makes a new one of the given size num, and populates it with the values in probabilityCoefficients.

probabilityCoefficients must be an array of size num.

virtual DtReal DtPrbProbabilityCoefficients::probability ( DtReal  value) const
virtual
virtual int DtPrbProbabilityCoefficients::numCoefficients ( ) const
virtual

Returns the number of polynomial coefficients used in the probability equation.

virtual double DtPrbProbabilityCoefficients::solveForMaximum ( ) const
virtual

Solves the polynomial for the maximum solution.

Currently only handles 2nd order and below. If you want to solve a cubic, by all means override this and add your own.

virtual double DtPrbProbabilityCoefficients::solveForMinimum ( ) const
virtual

Solves the polynomial for the minimum solution.

Currently only handles 2nd order and below. If you want to solve a cubic, by all means override this and add your own.

virtual const DtReal* DtPrbProbabilityCoefficients::coefficients ( ) const
virtual

Returns array of coefficients to be used in an expression of probability versus an input value.

(Note there are numCoefficients() items in the list.) The coefficients are in descending order. For example, if there are 3 coefficients, and the values returned by this call are -5.0E-008, 0.0, 1.0, then the expression for probability as a function of some input value would be: Probabilty(r) = (-5.0E-008.0 * r^2) + (0.0 * r) + 1.0

Member Data Documentation

int DtPrbProbabilityCoefficients::myNumCoefficients
protected
DtReal* DtPrbProbabilityCoefficients::myCoefficientList
protected

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

Document ID: Generated on Thu Mar 23 18:54:12 EDT 2017 from SVN revision 174804
Copyright © 2005-2017 VT MÄK. All Rights Reserved (www.mak.com)