#include <EventDesc.h>

Inheritance diagram for PLCore::EventDesc:

Public Member Functions
PLCORE_API	EventDesc (const String &sSignature, const String &sName, const String &sDescription, const String &sAnnotation)
	Constructor.
virtual PLCORE_API	~EventDesc ()
	Destructor.
PLCORE_API void	Dummy ()
	Initialize instance.
String	GetSignature () const
	Get signature.
virtual PLCORE_API DynEvent *	GetSignal (const Object &cObject) const
	Get signal.
Protected Attributes
String	m_sSignature

Detailed Description

Event descriptor.

Remarks:: This class contains a descriptor for an event and consists of information belonging to a specific event, such as it's name and signature.

Constructor & Destructor Documentation

PLCORE_API PLCore::EventDesc::EventDesc	(	const String &	sSignature,
		const String &	sName,
		const String &	sDescription,
		const String &	sAnnotation
	)

Parameters:

virtual PLCORE_API PLCore::EventDesc::~EventDesc ( ) [virtual]

Destructor.

PLCORE_API void PLCore::EventDesc::Dummy ( )

Initialize instance.

Remarks:: This method is just here to ensure, that the compiler will actually create static instances

String PLCore::EventDesc::GetSignature ( ) const [inline]

Get signature.

virtual PLCORE_API DynEvent* PLCore::EventDesc::GetSignal ( const Object & cObject ) const [virtual]

Get signal.

Parameters:

[in] cObject Object to return the signal pointer from

Returns:: Pointer to signal (can be a null pointer, do not destroy the returned instance)

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