DtSignaturePropagatorDescriptor Class Reference

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

Inheritance diagram for DtSignaturePropagatorDescriptor:

List of all members.

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.
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 ()
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.
Static Protected Attributes
static DtSignaturePropagatorDescriptorFactory *	theFactory
Private Member Functions
	DtSignaturePropagatorDescriptor ()
	default constructor; not implemented

---

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 [static, protected]

Reimplemented from DtReaderWriter.

---

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

• include/vrfobjparam/signaturePropagatorDesc.h