OpenBabel::PluginIter

PluginIter Class Template Reference

Template class used to simplify dynamic classes discovered at runtime. More...

#include <openbabel/pluginiter.h>

List of all members.

Public Member Functions

void Register (T *pType, const std::string ID, bool IsDefault)
T * FindType (const std::string &ID)
T * FindDefaultType () const
std::string ID () const
Iterator methods
void ToStart ()
PluginIter & operator++ ()
 operator bool () const
T * operator-> () const

Detailed Description

template<typename T>
class OpenBabel::PluginIter< T >

Template class used to simplify dynamic classes discovered at runtime.

See also:
openbabel/plugininter.h plugininter.h

Member Function Documentation

void Register ( T *  pType,
const std::string  ID,
bool  IsDefault 
) [inline]

Register a specific plugin module of a given type Not intended for direct use

See also:
openbabel/plugininter.h plugininter.h

T* FindType ( const std::string &  ID  )  [inline]

Find a plugin with a given ID code

Returns:
the plugin instance or NULL if the ID code does not exist

T* FindDefaultType (  )  const [inline]

Returns:
The default plugin for a given plugin type

std::string ID (  )  const [inline]

Returns:
The ID code for this plugin

void ToStart (  )  [inline]

Set the iterator to the beginning of the list of plugins.

PluginIter& operator++ (  )  [inline]

Increment the iterator to the next plugin in the list

Returns:
This plugin iterator

operator bool (  )  const [inline]

Returns:
Whether the iterator is valid (i.e., it is not at the end)

T* operator-> (  )  const [inline]

Returns:
The plugin associated with the current state of the iterator

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