Classes

struct IdentifierIterator

Public Member Functions

virtual VAcceptInfoList_t accept (const RefPtr< VObject > &) const =0
Virtual query function to check whether this creator may provide an VObject that uses the given object as input.
virtual RefPtr< VObject > create (const string &name, const Intercube &CreationContext) const =0
The virtual object creation function, it is implemented by VCreator<>.
RefPtr< VObject > create (const string &name="") const
Convenience function to create objects using default parameters.
virtual string createChildname (const string &parent_name) const
Virtual callback function that is called when a new child object is to be created from a parent object's name.
const VCreatorProperties & getProperties () const
Get the properties (various textual descriptions) for this creator.

Static Public Member Functions

static int iterateIdentifiers (const string &Identifier, IdentifierIterator &It)
Iterate over all identifiers across multiple categories.

Protected Member Functions

void setCreator (const RefPtr< VObject > &vobj) const
VCreatorBase (const VCreatorProperties &CreatorProperties, int priority=DEFAULT_PRIORITY, const RefPtr< VCreationPreferences > &prop=NullPtr(), bool isStatic=true)
Construct a VCreator from given creation properties.
VCreatorBase (const string &CreatorKeyName, int priority=DEFAULT_PRIORITY, const RefPtr< VCreationPreferences > &prop=NullPtr(), bool isStatic=true)
Constructor a VCreator from a key name.
~VCreatorBase ()
Destructor.

Detailed Description

Base class for objects that serve to create VObject's.

In general, such creator objects will be statically defined in a plugin library.

All such creator objects are registered in the object pool for the domain `VCreatorBase'. Iteration over the VCreatorBase pool provides all possible creator objects.

If they are created dynamically instead (there is hardly any reason for this, but who know's), then the isStatic constructor argument shall be set to false.

Note:: Currently, VCreator object's are in the same pool as VInputCreatorBase, but not all VInputCreatorBase objects are VCreator's as well, since not every VInput is an VObject.

In contrast to VInputCreators, VCreators possess a virtual create method that only requires a name.

Constructor & Destructor Documentation

Wizt::VCreatorBase::VCreatorBase	(	const string &	CreatorKeyName,
		int	priority = `DEFAULT_PRIORITY`,
		const RefPtr< VCreationPreferences > &	prop = `NullPtr()`,
		bool	isStatic = `true`
	)		`[protected]`

Constructor a VCreator from a key name.

This is not recommended (see base class VCreatorProperties), as it requires parsing the given string based on interpretation of special characters.

Member Function Documentation

virtual RefPtr<VObject> Wizt::VCreatorBase::create	(	const string &	name,
		const Intercube &	CreationContext
	)		const `[pure virtual]`

The virtual object creation function, it is implemented by VCreator<>.

Parameters:

name	An optional name, if none is given then the new object will be named like the creator itself, possibly with an enumeration number appended.
CreationContext	An Intercube that allows specifying additional parameters for the circumstances of creation. It is passed to the VActionNotifier::VObjectCreation() call. If omitted, then the Creator object itself will be used as CreationContext. This is not recommended, however. A CreationContext should rather provide explicit information about the circumstances of the creation.

Returns:: A pointer to the newly created object.

Implemented in Wizt::VCreator.

RefPtr<VObject> Wizt::VCreatorBase::create ( const string & name = "" ) const [inline]

Convenience function to create objects using default parameters.

The actual function called is the virtual create(name,CreationContext) function. The CreationContext will be the Creator object itself, by default.

Parameters:

name	An optional name, if none is given then the new object will be named like the creator itself, possibly with an enumeration number appended.

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

ocean/plankton/VCreatorBase.hpp
ocean/plankton/VCreatorBase.cpp