DtSignaturePropagatorDescriptor Class Reference

Instances of DtSignaturePropagatorDescriptor are used to specify the parameters for a DtSignaturePropagator object. More...

Inheritance diagram for DtSignaturePropagatorDescriptor:

Public Member Functions
	DtSignaturePropagatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtSignaturePropagatorDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSignaturePropagatorDescriptor (const DtSignaturePropagatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtSignaturePropagatorDescriptor &	operator= (const DtSignaturePropagatorDescriptor &orig)
	assignment
virtual	~DtSignaturePropagatorDescriptor ()
virtual DtString	type () const
	Returns the type of this descriptor.
virtual DtSignaturePropagatorDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	putData (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual bool	init ()
	Base class init does nothing, but will be called by createSignaturePropagatorDescriptor(), allowing derived classes to do memory allocation if necessary.
virtual void	setPropagatorType (const DtString &componentType)
	Accessor/mutator for myPropagatorType.
virtual DtString	propagatorType () const
	Accessor/mutator for myPropagatorType.
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 DtSignaturePropagatorDescriptorFactory *	factory ()
	Factory used to generate new instances of DtSignaturePropagatorDescriptor objects, based on the types defined in signaturePropagatorDescTypes.h.
static void	setFactory (DtSignaturePropagatorDescriptorFactory *factory)
static DtSignaturePropagatorDescriptor *	createSignaturePropagatorDescriptor (DtlObjPtr mtlStream, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
static DtSignaturePropagatorDescriptor *	createSignaturePropagatorDescriptor (const char *pName)
static DtSignaturePropagatorDescriptor *	creator ()
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 ()

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwString	myPropagatorType
	Parameter Name: propagator-type Parameter Description: String identifying type of signature propagator object.
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.

Static Protected Attributes
static DtSignaturePropagatorDescriptorFactory *	theFactory
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

Private Member Functions
	DtSignaturePropagatorDescriptor ()
	default constructor; not implemented

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 DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Detailed Description

Instances of DtSignaturePropagatorDescriptor are used to specify the parameters for a DtSignaturePropagator object.

Constructor & Destructor Documentation

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

real constructor

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

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

copy constructor

virtual DtSignaturePropagatorDescriptor::~DtSignaturePropagatorDescriptor ( )

virtual

DtSignaturePropagatorDescriptor::DtSignaturePropagatorDescriptor ( )

private

default constructor; not implemented

Member Function Documentation

DtSignaturePropagatorDescriptor& DtSignaturePropagatorDescriptor::operator=

(

const DtSignaturePropagatorDescriptor &

orig

)

assignment

virtual DtString DtSignaturePropagatorDescriptor::type ( ) const

virtual

Returns the type of this descriptor.

Used to create the descriptor on read from an mtl file. Signature propagator descriptor type strings are defined in signaturePropagatorDescTypes.h.

Reimplemented in DtVisualSignaturePropagatorDescriptor, and DtStandardPropagatorDescriptor.

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

virtual

Reimplemented in DtVisualSignaturePropagatorDescriptor, and DtStandardPropagatorDescriptor.

virtual void DtSignaturePropagatorDescriptor::setPropagatorType ( const DtString &  componentType )

virtual

Accessor/mutator for myPropagatorType.

virtual DtString DtSignaturePropagatorDescriptor::propagatorType ( ) const

virtual

Accessor/mutator for myPropagatorType.

virtual void DtSignaturePropagatorDescriptor::putData ( FILE *  fp, int  indentLevel = 0  )

virtual

Overrides base class putData to output our type.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtSignaturePropagatorDescriptor::getData ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

virtual

getData is just used to get us past the type in the data stream, since it's not actually stored.

virtual bool DtSignaturePropagatorDescriptor::init ( )

virtual

Base class init does nothing, but will be called by createSignaturePropagatorDescriptor(), allowing derived classes to do memory allocation if necessary.

static DtSignaturePropagatorDescriptorFactory* DtSignaturePropagatorDescriptor::factory ( )

static

Factory used to generate new instances of DtSignaturePropagatorDescriptor objects, based on the types defined in signaturePropagatorDescTypes.h.

Reimplemented from DtReaderWriter.

static void DtSignaturePropagatorDescriptor::setFactory ( DtSignaturePropagatorDescriptorFactory *  factory )

static

static DtSignaturePropagatorDescriptor* DtSignaturePropagatorDescriptor::createSignaturePropagatorDescriptor ( DtlObjPtr  mtlStream, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

static

static DtSignaturePropagatorDescriptor* DtSignaturePropagatorDescriptor::createSignaturePropagatorDescriptor ( const char *  pName )

static

static DtSignaturePropagatorDescriptor* DtSignaturePropagatorDescriptor::creator ( )

static

Returns

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented in DtVisualSignaturePropagatorDescriptor, and DtStandardPropagatorDescriptor.

Member Data Documentation

DtRwString DtSignaturePropagatorDescriptor::myPropagatorType

protected

Parameter Name: propagator-type
Parameter Description: String identifying type of signature propagator object.

Parameter Default Value:

DtSignaturePropagatorDescriptorFactory* DtSignaturePropagatorDescriptor::theFactory

staticprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/signaturePropagatorDesc.h