DtSignatureModifier Class Reference

The base class for all signature modifier descriptions. More...

Inheritance diagram for DtSignatureModifier:

Public Member Functions
	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 *	clone (DtReaderWriterRegistry *const parentRegistry=NULL) const =0
	Returns a copy of this class.
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 void	setFactory (DtSignatureModifierFactory *factory)
	Sets the static factory member.
static DtSignatureModifier *	createSignatureModifier (const DtString &type)
	Uses the static factory assigned in setFactory to create the requested signature modifier type.
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 void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static DtReaderWriterFactory *	factory ()

Static Protected Attributes
static DtSignatureModifierFactory *	theFactory
	Static pointer to the factory for signature modifiers.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

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.
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.

Detailed Description

The base class for all signature modifier descriptions.

Signature Modifiers define a modification to the sensor signature value of an object based on some condition. Subclasses of this class will define the condition. These classes are the description of the modifier only. The evaluation of the modifier is handled by a sibling set of classes derived from DtSignatureModifierEvaluator.

Constructor & Destructor Documentation

DtSignatureModifier::DtSignatureModifier

(

)

default constructor

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

real constructor

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

DtSignatureModifier::DtSignatureModifier	(	const DtSignatureModifier &	orig,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

copy constructor

virtual DtSignatureModifier::~DtSignatureModifier ( )

virtual

Member Function Documentation

DtSignatureModifier& DtSignatureModifier::operator=

(

const DtSignatureModifier &

orig

)

virtual DtSignatureModifier* DtSignatureModifier::clone ( DtReaderWriterRegistry *const  parentRegistry = NULL ) const

pure virtual

Returns a copy of this class.

Implemented in DtFileSignatureModifier, DtCoefficientsSignatureModifier, DtMultiplierSignatureModifier, DtUnderwaterAcousticsSignatureModifier, DtSubsurfaceExtensibleArtPartSignatureModifier, DtDepthSignatureModifier, and DtSpeedSignatureModifier.

virtual DtString DtSignatureModifier::type ( ) const

virtual

Returns

The string type identifier for this type. VR-Forces default types are defined in signatureModifierTypes.h. The default implementation returns the RW name of the class.

static void DtSignatureModifier::setFactory ( DtSignatureModifierFactory *  factory )

static

Sets the static factory member.

static DtSignatureModifier* DtSignatureModifier::createSignatureModifier ( const DtString &  type )

static

Uses the static factory assigned in setFactory to create the requested signature modifier type.

Member Data Documentation

DtSignatureModifierFactory* DtSignatureModifier::theFactory

staticprotected

Static pointer to the factory for signature modifiers.

---

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

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