Wizt::VInputCreator< InputType, VInputCreatorClass > Class Template Reference

Template class for convenient definition of creators of objects providing a multiple input types. More...

#include <ocean/plankton/VInputCreator.hpp>

Inheritance diagram for Wizt::VInputCreator< InputType, VInputCreatorClass >:

Public Member Functions
	VInputCreator (const string &name, int ObjectQuality, const RefPtr< VCreationPreferences > &prop=NullPtr(), const char *const InputCreatorReleaseIdentifier=VISH_INPUT_CREATOR_RELEASE_IDENTIFIER)
	Constructor.
Public Member Functions inherited from Wizt::VInputCreatorBase
RefPtr< VCreationPreferences >	CreationPreferences (const RefPtr< VCreationPreferences > &AdditionalPreferences=nullptr) const
	Associated creation preferences.
	VInputCreatorBase (const string &name, int prior, const RefPtr< VCreationPreferences > &prop, const char *vish_creator_release_identifier)
	Constructor.
Public Member Functions inherited from Wizt::VManagedDomainObject< VInputCreatorBase >
const type_info &	getDomainType () const override
	Get the associated domain type.
void	remove ()
	Remove the current object from the pool of objects.
	VManagedDomainObject (const string &name, int priority=DEFAULT_PRIORITY)
	Constructor, inserts the new object into the object pool of the respective domain under the given name with the assigned priority.
Public Member Functions inherited from Wizt::VManagedObject
string	getLoadModule () const
	Get the name of the module that was active when loading/creating this object.
void	insert (const string &s, int priority=DEFAULT_PRIORITY)
	Insert new objects into the object data base.
void	remove ()
	Remove this object from the database.
void	setPriority (int priority)
	Set the priority level in the database list.
	VManagedObject (const string &name, int priority=DEFAULT_PRIORITY)
	Constructor.
virtual	~VManagedObject ()
	Virtual destructor.
Public Member Functions inherited from Wizt::VManagedObjectBase
	VManagedObjectBase ()
	Constructor.
	~VManagedObjectBase ()
	Destructor.
Public Member Functions inherited from MemCore::ReferenceBase< VManagedObjectBase >
auto	getObjectCountID () const noexcept
	Get a unique ID for this object in the given domain.
bool	isIdentical (const WeakPtr< VManagedObjectBase, VManagedObjectBase > &PossibleSelf) const noexcept
	Check if this object is identical to the one used by the given pointer.
void	mkAutoDestructive ()
	Marks this object as being automatically destructed, e.g.
refcount_t	refcount () const noexcept
	The strong reference count.
	ReferenceBase (VManagedObjectBase *that) noexcept
	Constructor, initializes reference counter to zero.
const auto &	self () const
	Return weak pointer to the object self.
refcount_t	wrefcount () const noexcept
	The weak reference count.
Public Member Functions inherited from MemCore::Intercube
void	addInterface (const RefPtr< InterfaceBase > &I) const
	Add an interface class object.
template<class Data >
void	addInterfaceData (const Data &D)
	Add data via an interface class object.
template<class Data , typename TypeSelector >
void	addInterfaceData (const Data &D)
	Add data via an interface class object.
void	clearInterfaces ()
	Remove all interfaces.
bool	const_iterateInterfaces (const RefPtr< InterfaceIterationParameter > &IIP) const
	Constant iterator.
virtual RefPtr< InterfaceBase >	createInterface (const type_info &) const
	Virtual function which allows derived objects to create Interface objects on demand.
RefPtr< InterfaceBase >	findInterface (const type_info &t) const
	Find a certain interface of specified type.
RefPtr< InterfaceBase >	getInterface (const type_info &t)
	Retrieve an interface object from a certain type.
std::string	getInterfaceNames (const char delim=';') const
	Debug function retrieving all interfaces as human-readable string.
template<class Data >
bool	gotNewInterfaceData (const Data &D)
	Check whether data on the given interface have changed, and if so, set new data as interface.
template<class Data >
bool	gotNewInterfaceData (mutex &M, const Data &D)
	Check whether interface data have changed, if so, then set new interface data and return true.
template<class Data , typename Selector >
bool	gotNewInterfaceData (mutex &M, const Data &D)
	Check whether interface data have changed, if so, then set new interface data and return true.
template<class Data , typename Selector >
bool	gotNewInterfaceData (mutex &M, const Data &D, const Selector &S)
	Check whether interface data have changed, if so, then set new interface data and return true.
template<class Data , typename Selector >
bool	gotNewInterfaceData (mutex &M, const Data &D, const Selector *S)
	Check whether interface data have changed, if so, then set new interface data and return true.
template<class Data >
bool	hasChangedInterfaceData (const Data &D) const
	Check whether interface data have changed.
template<class Data , typename Selector >
bool	hasChangedInterfaceData (const Data &D) const
	Check whether interface data have changed.
template<class Data , typename Selector >
bool	hasChangedInterfaceData (const Data &D, const Selector &) const
	Check whether interface data have changed.
template<class Data , typename Selector >
bool	hasChangedInterfaceData (const Data &D, const Selector *) const
	Check whether interface data have changed.
bool	hasInterface (const type_info &t) const
	Check if some Interface might exist.
	Intercube ()
	Constructor.
bool	iterateInterfaces (const RefPtr< InterfaceIterationParameter > &IIP)
	Modifyable iterator.
void	printInterfaces () const
	Debug function that prints the names of all interfaces.
void	registerInterface (const type_info &t)
	Register an interface type; when the interface is actually required, the virtual createInterface() function will be called.
template<class InterfaceType >
void	removeInterface ()
	Remove an interface.
void	removeInterfaceBase (const type_info &InterfaceBaseID)
	Remove an interface.
virtual	~Intercube ()
	Destructor.
Public Member Functions inherited from MemCore::MutableName
void	addNameChangeNotifier (const WeakPtr< Notifier > &)
	Add a new listener.
std::string	BaseName (const char Separator) const
	return the name of this item cropped anything after the Separator
const std::string &	getName () const
	The name of the object.
	MutableName (const std::string &theName)
	Construct from text.
const std::string &	Name () const
	The name of the object.
void	rename (const std::string &newName)
	rename, same as setName()
void	setName (const std::string &newName)
	Set a new name.

Protected Member Functions
	~VInputCreator ()
	Destructor, calls unregisterVInput().
Protected Member Functions inherited from Wizt::VInputCreatorBase
	~VInputCreatorBase ()
	Destructor.
Protected Member Functions inherited from MemCore::ReferenceBase< VManagedObjectBase >
virtual void	extremeUnction ()
	A virtual function that will be called just before the object is destroyed.
ReferenceBase &	operator= (const ReferenceBase &R)
	Protected assignment operator (should not be called).
void	suicide ()
	Delete this.
virtual	~ReferenceBase ()
	Virtual destructor.

Additional Inherited Members
Public Types inherited from Wizt::VManagedDomainObject< VInputCreatorBase >
typedef VInputCreatorBase	Domain_t
	The domain type of this managed object.
Public Types inherited from MemCore::ReferenceBase< VManagedObjectBase >
using	reference_domain_t = VManagedObjectBase
	The type of the base class.
using	SelfPtr_t = WeakPtr< VManagedObjectBase, VManagedObjectBase >
	Type for a pointer to this object itself.
Static Public Member Functions inherited from Wizt::VManagedDomainObject< VInputCreatorBase >
static RefPtr< VManagedObject >	find (const string &s)
	Find an object with a certain name.
static int	iterate (VManagedObjectIterator_t VIt, int p_start=INT_MIN, int p_end=INT_MAX)
	Iterate through all objects within a given priority range.
static bool	remove (const std::string &s)
	Remove an compatible object given its name.
static int	size ()
	Tell us how many object of this domain exist.
static int	traverse (VManagedObjectIterator &VIt, int p_start=INT_MIN, int p_end=INT_MAX)
	Iterate through all objects within a given priority range.
Static Public Member Functions inherited from Wizt::VManagedObject
static int	count ()
	How many objects reside in the domain database at all?
static VManagedObjectPtr	find (const type_info &, const std::string &s)
	Find a certain managed object by its name.
static bool	InitDomain (const type_info &)
	An initialization function.
static int	iterateModules (ModuleIterator &VIM)
	Iterate over all modules which have put objects into the object database so far.
static int	size (const type_info &)
	How many objects reside in the domain database for a certain type?
static int	traverse (const type_info &, VManagedObjectIterator &VIt, int p_start, int p_end)
	Iterate through a domain for certain levels.
static void	UnloadVModule (const string &what, VRemoveItem &RI)
	Unload a certain module.
Static Public Member Functions inherited from MemCore::MutableName
static std::string	BaseName (const std::string &theName, const char Separator)
	return the name of this item cropped anything after the Separator
Static Public Attributes inherited from Wizt::VManagedObject
static string	CurrentLoadModule
	The name of the current shared library/DLL/plugin which provides the code of the currently loaded objects.

Detailed Description

template<class InputType, class VInputCreatorClass = VInputCreatorBase>
class Wizt::VInputCreator< InputType, VInputCreatorClass >

Template class for convenient definition of creators of objects providing a multiple input types.

For a certain type, it calls registerVInput() at construction and unregisterVInput() for the respective VCreator object.

Parameters

InputType	The type for which this creator is registered as a possible provider;
VInputCreatorClass	A creator class for VManagedObjects, e.g. VCreator<>s or other VInputCreator<>s.

For instance, the following code manages creation of objects that may provide an "int" type input as well as an "double" input (any arbitrary user-defined type may be used as well):

class   MyObjectCreator : public VInputCreatorBase
{
        ... // class members
}
 
static VInputCreator <double, VInputCreator<int, MyObjectCreator>, double>  myIntDoubleCreator("IntDouble Provider");

The base class VInputCreatorClass is responsible on its own to actually provide the functionality of object creation. The constructor of creator classes must accept the same arguments as the constructor of VInputCreator<> itself.

Constructor & Destructor Documentation

VInputCreator()

template<class InputType , class VInputCreatorClass = VInputCreatorBase>

Wizt::VInputCreator< InputType, VInputCreatorClass >::VInputCreator ( const string &  name, int  ObjectQuality, const RefPtr< VCreationPreferences > &  prop = NullPtr(), const char *const  InputCreatorReleaseIdentifier = VISH_INPUT_CREATOR_RELEASE_IDENTIFIER  )

inline

Constructor.

All arguments are forwarded to the VInputCreatorClass.

References Wizt::registerVInput(), and Wizt::VActionNotifier::Warning().