I_PFM_APP_Creator Class Reference

Interface for creating a plug-in object for PanPhaseField platform. More...

#include <ppf_APP_interface.h>

Public Member Functions
virtual	~I_PFM_APP_Creator ()
virtual I_PFM_APP_Interface *	Create ()=0
virtual void	Delete (I_PFM_APP_Interface *user_app)=0
virtual float	getVersion ()=0
virtual const char *	getType ()
virtual const char *	getName ()=0
virtual const char *	getDescription ()=0

Static Public Member Functions
static const char *	Creator_Type ()

Static Public Attributes
static const int	Creator_Interface_Version = 1
static const int	Creator_Lowest_Version = 1

Detailed Description

Interface for creating a plug-in object for PanPhaseField platform.

Note

Each plug-in should have its own implementation of creator.

Constructor & Destructor Documentation

~I_PFM_APP_Creator()

virtual I_PFM_APP_Creator::~I_PFM_APP_Creator ( )

inlinevirtual

Default deconstructor

Member Function Documentation

Creator_Type()

static const char * I_PFM_APP_Creator::Creator_Type ( )

inlinestatic

Creator type identifier

Returns

a char array of creator type

Create()

virtual I_PFM_APP_Interface * I_PFM_APP_Creator::Create ( )

pure virtual

Create a plug-in object. See I_PFM_APP_Interface for interface of plug-in

Returns

a pointer to plug-in object

Delete()

virtual void I_PFM_APP_Creator::Delete ( I_PFM_APP_Interface *  user_app )

pure virtual

Recycle a plug-in object. See I_PFM_APP_Interface for interface of plug-in

Parameters

[in]

user_app

the user created plug-in object

Returns

void

getVersion()

virtual float I_PFM_APP_Creator::getVersion ( )

pure virtual

Get the version number. See I_PFM_APP_Creator::Creator_Interface_Version and I_PFM_APP_Creator::Creator_Lowest_Version for rules of version.

Returns

a float number of plug-in version id

getType()

virtual const char * I_PFM_APP_Creator::getType ( )

inlinevirtual

A wrapper of creator type identifier

Returns

a char array of creator type

getName()

virtual const char * I_PFM_APP_Creator::getName ( )

pure virtual

Get the name of plug-in

Returns

a char array of plug-in name

Note

Each plug-in's own implementation of I_PFM_APP_Creator::getName should return a name consistent with plug-in's project name

getDescription()

virtual const char * I_PFM_APP_Creator::getDescription ( )

pure virtual

Get the description of plug-in

Returns

the description of plug-in

Member Data Documentation

Creator_Interface_Version

const int I_PFM_APP_Creator::Creator_Interface_Version = 1

static

Version of creator version

Creator_Lowest_Version

const int I_PFM_APP_Creator::Creator_Lowest_Version = 1

static

Lowest acceptable version of creator

---

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

• ppf_APP_interface.h