VR-Forces 4.7 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtDepthSignatureModifier Class Reference

Stores a depth at which an entity's signature becomes 0. More...

Inheritance diagram for DtDepthSignatureModifier:
Inheritance graph
[legend]

Public Member Functions

 DtDepthSignatureModifier ()
 default constructor
 DtDepthSignatureModifier (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 real constructor
 DtDepthSignatureModifier (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 DtDepthSignatureModifier (const DtDepthSignatureModifier &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
 copy constructor
DtDepthSignatureModifieroperator= (const DtDepthSignatureModifier &orig)
virtual ~DtDepthSignatureModifier ()
virtual DtSignatureModifierclone (DtReaderWriterRegistry *const parentRegistry=NULL) const
 Returns a copy of this class.
virtual bool zeroSignatureDepthSpecified () const
virtual const double zeroSignatureDepth () const
 Accessor/mutator for myZeroSignatureDepth.
virtual void setZeroSignatureDepth (double zeroSignatureDepth)
- Public Member Functions inherited from DtCoefficientsSignatureModifier
 DtCoefficientsSignatureModifier ()
 default constructor
 DtCoefficientsSignatureModifier (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 real constructor
 DtCoefficientsSignatureModifier (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 DtCoefficientsSignatureModifier (const DtCoefficientsSignatureModifier &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
 copy constructor
DtCoefficientsSignatureModifieroperator= (const DtCoefficientsSignatureModifier &orig)
virtual ~DtCoefficientsSignatureModifier ()
virtual const DtNLengthRealVectorcoefficientsList () const
 Accessor/mutator for #myModifierCoefficients.
virtual void setCoefficientsList (const DtNLengthRealVector &coefficientsList)
- Public Member Functions inherited from DtSignatureModifier
 DtSignatureModifier ()
 default constructor
 DtSignatureModifier (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 real constructor
 DtSignatureModifier (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 DtSignatureModifier (const DtSignatureModifier &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
 copy constructor
DtSignatureModifieroperator= (const DtSignatureModifier &orig)
virtual ~DtSignatureModifier ()
virtual DtString type () const
virtual bool operator== (const DtSignatureModifier &) const
 Comparrison operator. Override to compare specific subclasses.
bool operator!= (const DtSignatureModifier &rhs) const
- 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 original 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 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 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 DtRwVariableBindingsgenerateVariableBindings () 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 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.

Static Public Member Functions

static DtSignatureModifiercreate ()

Protected Attributes

DtRwReal myZeroSignatureDepth
 Stores the coefficients of the equation to be used to modify the signature.
- Protected Attributes inherited from DtCoefficientsSignatureModifier
DtNLengthRealVector myModiferCoefficients
 Stores the coefficients of the equation to be used to modify the signature.

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 )()
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
- Static Protected Attributes inherited from DtSignatureModifier
static DtSignatureModifierFactorytheFactory
 Static pointer to the factory for signature modifiers.

Detailed Description

Stores a depth at which an entity's signature becomes 0.

Constructor & Destructor Documentation

DtDepthSignatureModifier::DtDepthSignatureModifier ( )

default constructor

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

real constructor

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

copy constructor

virtual DtDepthSignatureModifier::~DtDepthSignatureModifier ( )
virtual

Member Function Documentation

DtDepthSignatureModifier& DtDepthSignatureModifier::operator= ( const DtDepthSignatureModifier orig)
virtual DtSignatureModifier* DtDepthSignatureModifier::clone ( DtReaderWriterRegistry *const  parentRegistry = NULL) const
virtual

Returns a copy of this class.

Reimplemented from DtCoefficientsSignatureModifier.

virtual const double DtDepthSignatureModifier::zeroSignatureDepth ( ) const
virtual

Accessor/mutator for myZeroSignatureDepth.

virtual void DtDepthSignatureModifier::setZeroSignatureDepth ( double  zeroSignatureDepth)
virtual
virtual bool DtDepthSignatureModifier::zeroSignatureDepthSpecified ( ) const
virtual
static DtSignatureModifier* DtDepthSignatureModifier::create ( )
static

Reimplemented from DtCoefficientsSignatureModifier.

Member Data Documentation

DtRwReal DtDepthSignatureModifier::myZeroSignatureDepth
protected

Stores the coefficients of the equation to be used to modify the signature.

This equation is up to the user of this class to define, ie the derived type of signature modifier evaluator that used this descriptor.h


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

Document ID: Generated on Fri Apr 26 21:53:14 EDT 2019 from SVN revision 197883
Copyright © 2005-2019 VT MAK. All Rights Reserved (www.mak.com)