PixelLightAPI  .
Public Member Functions | Protected Attributes
PLCore::FuncDesc Class Reference

Function descriptor. More...

#include <FuncDesc.h>

Inheritance diagram for PLCore::FuncDesc:
Inheritance graph
[legend]

List of all members.

Public Member Functions

PLCORE_API FuncDesc (const String &sSignature, const String &sName, const String &sDescription, const String &sAnnotation)
 Constructor.
virtual PLCORE_API ~FuncDesc ()
 Destructor.
PLCORE_API void Dummy ()
 Initialize instance.
String GetSignature () const
 Get signature.
virtual PLCORE_API DynFuncPtr GetMethod (Object &cObject) const
 Get callable method.

Protected Attributes

String m_sSignature

Detailed Description

Function descriptor.

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

Constructor & Destructor Documentation

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

Constructor.

Parameters:
[in]sSignatureFunction signature
[in]sNameFunction name
[in]sDescriptionFunction description
[in]sAnnotationFunction annotation
virtual PLCORE_API PLCore::FuncDesc::~FuncDesc ( ) [virtual]

Destructor.


Member Function Documentation

PLCORE_API void PLCore::FuncDesc::Dummy ( )

Initialize instance.

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

Get signature.

Returns:
Signature
virtual PLCORE_API DynFuncPtr PLCore::FuncDesc::GetMethod ( Object cObject) const [virtual]

Get callable method.

Parameters:
[in]cObjectRTTI class instance
Returns:
Smart pointer to callable method (can be a null pointer)
Note:
  • The default implementations returns a null pointer

Member Data Documentation


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


PixelLight PixelLight 0.9.11-R1
Copyright (C) 2002-2012 by The PixelLight Team
Last modified Thu Feb 23 2012 14:09:06
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported