Generic Tool. More...

#include <gtool.h>

Inheritance diagram for GTool:
[legend]

Public Member Functions

 GTool (GSession *session, GPlugInFactory *fac)
 
virtual void Run (GSlot *slot)=0
 
virtual ~GTool (void)
 
- Public Member Functions inherited from GPlugIn
 GPlugIn (GSession *session, GPlugInFactory *fac)
 
virtual void ApplyConfig (void)
 
void InsertParam (R::RParam *param)
 
template<class T >
T * FindParam (const R::RString &name)
 
R::RCursor< R::RParamGetParams (const R::RString &cat=R::RString::Null)
 
void GetCategories (R::RContainer< R::RString, true, false > &cats)
 
virtual void Init (void)
 
virtual void CreateConfig (void)
 
virtual void Reset (void)
 
GPlugInFactoryGetFactory (void) const
 
int Compare (const GPlugIn &plugin) const
 
int Compare (const R::RString &plugin) const
 
R::RString GetName (void) const
 
R::RString GetDesc (void) const
 
GSessionGetSession (void) const
 
virtual void Done (void)
 
virtual ~GPlugIn (void)
 

Additional Inherited Members

- Protected Attributes inherited from GPlugIn
GPlugInFactoryFactory
 
GSessionSession
 
size_t Id
 

Detailed Description

Generic Tool.

The GTool class provides a generic tool that could be called.

See the documentation related to GPlugIn for more general information.

Constructor & Destructor Documentation

GTool ( GSession session,
GPlugInFactory fac 
)

Construct the tool.

Parameters
sessionSession.
facFactory of the plug-in.
virtual ~GTool ( void  )
virtual

Destructor of the tool.

Member Function Documentation

virtual void Run ( GSlot slot)
pure virtual

Run the tool.

Parameters
slotSlot for comments.