DtDepthSignatureModifier Class Reference

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

Inheritance diagram for DtDepthSignatureModifier:

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
DtDepthSignatureModifier &	operator= (const DtDepthSignatureModifier &orig)
virtual	~DtDepthSignatureModifier ()
virtual DtSignatureModifier *	clone (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)
	Accessor/mutator for myZeroSignatureDepth.
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
DtCoefficientsSignatureModifier &	operator= (const DtCoefficientsSignatureModifier &orig)
virtual	~DtCoefficientsSignatureModifier ()
virtual const DtNLengthRealVector &	coefficientsList () const
	Accessor/mutator for #myModifierCoefficients.
virtual void	setCoefficientsList (const DtNLengthRealVector &coefficientsList)
	Accessor/mutator for #myModifierCoefficients.
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
DtSignatureModifier &	operator= (const DtSignatureModifier &orig)
virtual	~DtSignatureModifier ()
virtual DtString	type () 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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
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 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)
	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.

Static Public Member Functions
static DtSignatureModifier *	create ()

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::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.
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.
Static Protected Attributes inherited from DtSignatureModifier
static DtSignatureModifierFactory *	theFactory
	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

Accessor/mutator for myZeroSignatureDepth.

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/depthSignatureModifier.h