PLCore::ClassDummy Class Reference

Dummy 'Class' implementation. More...

#include <ClassDummy.h>

Inheritance diagram for PLCore::ClassDummy:

List of all members.

Protected Member Functions
virtual bool	IsDummy () const override
	Return whether or not the class implementation is a dummy used for delayed shared library loading.
virtual void	InitClass () const override
	Initialize class and class members.
virtual void	DeInitClass () const override
	De-Initialize class and class members.
virtual const List< VarDesc * > &	GetAttributes () const override
	Get attributes.
virtual const VarDesc *	GetAttribute (const String &sName) const override
	Get attribute.
virtual const List< FuncDesc * > &	GetMethods () const override
	Get methods.
virtual const FuncDesc *	GetMethod (const String &sName) const override
	Get method.
virtual const List< EventDesc * > &	GetSignals () const override
	Get signals.
virtual const EventDesc *	GetSignal (const String &sName) const override
	Get signal.
virtual const List < EventHandlerDesc * > &	GetSlots () const override
	Get slot.
virtual const EventHandlerDesc *	GetSlot (const String &sName) const override
	Get slot.
virtual bool	HasConstructor () const override
	Check if class has any constructors.
virtual bool	HasDefaultConstructor () const override
	Check if class has a default constructor.
virtual const List < ConstructorDesc * > &	GetConstructors () const override
	Get constructors.
virtual const ConstructorDesc *	GetConstructor (const String &sName) const override
	Get constructor.
virtual Object *	Create () const override
	Create object by using the default constructor.
virtual Object *	Create (const DynParams &cParams) const override
	Create object by using typed constructor parameters in order to identity the constructor automatically.
virtual Object *	Create (const String &sName, const DynParams &cParams) const override
	Create object by using a given constructor name and typed constructor parameters.
virtual Object *	Create (const String &sName, const String &sParams) const override
	Create object by using a given constructor name and typeless constructor parameters.

---

Detailed Description

Dummy 'Class' implementation.

---

Member Function Documentation

virtual bool PLCore::ClassDummy::IsDummy

(

)

const [override, protected, virtual]

Return whether or not the class implementation is a dummy used for delayed shared library loading.

Returns:

'true' if the class implementation is a dummy used for delayed shared library loading, else 'false'

Implements PLCore::ClassImpl.

virtual void PLCore::ClassDummy::InitClass

(

)

const [override, protected, virtual]

Initialize class and class members.

Remarks:

This function is called automatically when it is necessary, e.g. the first time any members are being accessed. It will search for the base class of the class and initialize all members. If later a class is changed (e.g. a new member is registered at one of the base classes), that class and all derived classes will destroy their information and must be initialized again.

Implements PLCore::ClassImpl.

virtual void PLCore::ClassDummy::DeInitClass

(

)

const [override, protected, virtual]

De-Initialize class and class members.

Remarks:

This function destroys all data about the class and it's members. See InitClass() for more information about why this is necessary and when.

Implements PLCore::ClassImpl.

virtual const List<VarDesc*>& PLCore::ClassDummy::GetAttributes

(

)

const [override, protected, virtual]

Get attributes.

Returns:

List of attribute descriptors

Implements PLCore::ClassImpl.

virtual const VarDesc* PLCore::ClassDummy::GetAttribute

(

const String &

sName

)

const [override, protected, virtual]

Get attribute.

Parameters:

[in]

sName

Attribute name

Returns:

Attribute descriptor (can be a null pointer, if no member with that name could be found)

Implements PLCore::ClassImpl.

virtual const List<FuncDesc*>& PLCore::ClassDummy::GetMethods

(

)

const [override, protected, virtual]

Get methods.

Returns:

List of method descriptors

Implements PLCore::ClassImpl.

virtual const FuncDesc* PLCore::ClassDummy::GetMethod

(

const String &

sName

)

const [override, protected, virtual]

Get method.

Parameters:

[in]

sName

Method name

Returns:

Method descriptor (can be a null pointer, if no member with that name could be found)

Implements PLCore::ClassImpl.

virtual const List<EventDesc*>& PLCore::ClassDummy::GetSignals

(

)

const [override, protected, virtual]

Get signals.

Returns:

List of signal descriptors

Implements PLCore::ClassImpl.

virtual const EventDesc* PLCore::ClassDummy::GetSignal

(

const String &

sName

)

const [override, protected, virtual]

Get signal.

Parameters:

[in]

sName

Signal name

Returns:

Signal descriptor (can be a null pointer, if no member with that name could be found)

Implements PLCore::ClassImpl.

virtual const List<EventHandlerDesc*>& PLCore::ClassDummy::GetSlots

(

)

const [override, protected, virtual]

Get slot.

Returns:

List of slot descriptors

Implements PLCore::ClassImpl.

virtual const EventHandlerDesc* PLCore::ClassDummy::GetSlot

(

const String &

sName

)

const [override, protected, virtual]

Get slot.

Parameters:

[in]

sName

Slot name

Returns:

Slot descriptor (can be a null pointer, if no member with that name could be found)

Implements PLCore::ClassImpl.

virtual bool PLCore::ClassDummy::HasConstructor

(

)

const [override, protected, virtual]

Check if class has any constructors.

Returns:

'true' if class has at least one constructor, else 'false'

Implements PLCore::ClassImpl.

virtual bool PLCore::ClassDummy::HasDefaultConstructor

(

)

const [override, protected, virtual]

Check if class has a default constructor.

Returns:

'true' if class has a default constructor, else 'false'

Implements PLCore::ClassImpl.

virtual const List<ConstructorDesc*>& PLCore::ClassDummy::GetConstructors

(

)

const [override, protected, virtual]

Get constructors.

Returns:

List of constructor descriptors

Implements PLCore::ClassImpl.

virtual const ConstructorDesc* PLCore::ClassDummy::GetConstructor

(

const String &

sName

)

const [override, protected, virtual]

Get constructor.

Parameters:

[in]

sName

Constructor name

Returns:

Constructor descriptor (can be a null pointer, if no member with that name could be found)

Implements PLCore::ClassImpl.

virtual Object* PLCore::ClassDummy::Create

(

)

const [override, protected, virtual]

Create object by using the default constructor.

Returns:

Pointer to created object (can be a null pointer)

Remarks:

This function will call the default constructor of the class. If the class has no default constructor, the function will fail and return a null pointer.

Implements PLCore::ClassImpl.

virtual Object* PLCore::ClassDummy::Create

(

const DynParams &

cParams

)

const [override, protected, virtual]

Create object by using typed constructor parameters in order to identity the constructor automatically.

Parameters:

[in]

cParams

Constructor parameters

Returns:

Pointer to created object (can be a null pointer)

Remarks:

This function will search for a constructor that matches the signature of the given parameters. If no such constructor can be found, the function will fail and return a null pointer.

Implements PLCore::ClassImpl.

virtual Object* PLCore::ClassDummy::Create	(	const String &	sName,
		const DynParams &	cParams
	)		const [override, protected, virtual]

Create object by using a given constructor name and typed constructor parameters.

Parameters:

[in]	sName	Constructor name
[in]	cParams	Constructor parameters

Returns:

Pointer to created object (can be a null pointer)

Remarks:

This function will search for a constructor with the specified name. If no such constructor can be found, or the given parameters do not match the signature of the constructor, the function will fail and return a null pointer.

Implements PLCore::ClassImpl.

virtual Object* PLCore::ClassDummy::Create	(	const String &	sName,
		const String &	sParams
	)		const [override, protected, virtual]

Create object by using a given constructor name and typeless constructor parameters.

Parameters:

[in]	sName	Constructor name
[in]	sParams	Constructor parameters

Returns:

Pointer to created object (can be a null pointer, destroy the returned instance when you no longer need it)

Remarks:

This function will search for a constructor with the specified name. If no such constructor can be found, the function will fail and return a null pointer.

Implements PLCore::ClassImpl.

---

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

• ClassDummy.h