#include <class_loader_base.hpp>

Inheritance diagram for pluginlib::ClassLoaderBase:

[legend]

List of all members.

Public Member Functions

virtual std::string getBaseClassType () const =0

Given the lookup name of a class, returns the type of the associated base class.

virtual std::string getClassDescription (const std::string &lookup_name)=0

Given the lookup name of a class, returns its description.

virtual std::string getClassLibraryPath (const std::string &lookup_name)=0

Given the name of a class, returns the path to its associated library.

virtual std::string getClassPackage (const std::string &lookup_name)=0

Given the name of a class, returns name of the containing package.

virtual std::string getClassType (const std::string &lookup_name)=0

Given the lookup name of a class, returns the type of the derived class associated with it.

virtual std::vector< std::string > getDeclaredClasses ()=0

Returns a list of all available classes for this ClassLoader's base class type.

virtual std::string getName (const std::string &lookup_name)=0

Strips the package name off of a lookup name.

virtual std::string getPluginManifestPath (const std::string &lookup_name)=0

Given the name of a class, returns the path of the associated plugin manifest.

virtual std::vector< std::string > getPluginXmlPaths ()=0

Returns a list of all available plugin manifest paths for this ClassLoader's base class type.

virtual std::vector< std::string > getRegisteredLibraries ()=0

Returns the libraries that are registered and can be loaded.

virtual bool isClassAvailable (const std::string &lookup_name)=0

Checks if the class associated with a plugin name is available to be loaded.

virtual bool isClassLoaded (const std::string &lookup_name)=0

Checks if a given class is currently loaded.

virtual void loadLibraryForClass (const std::string &lookup_name)=0

Attempts to load a class with a given name.

virtual void refreshDeclaredClasses ()=0

Refreshs the list of all available classes for this ClassLoader's base class type

Exceptions:

pluginlib::LibraryLoadException Thrown if package manifest cannot be found.

virtual int unloadLibraryForClass (const std::string &lookup_name)=0

Attempts to unload a class with a given name.

virtual ~ClassLoaderBase ()

Empty virtual destructor.

Detailed Description

Pure virtual base class of pluginlib::ClassLoader which is not templated. This allows the writing of non-templated manager code which can call all the administrative functions of ClassLoaders - everything except createClassInstance(), createInstance() and createUnmanagedInstance().

Definition at line 45 of file class_loader_base.hpp.

Constructor & Destructor Documentation

virtual pluginlib::ClassLoaderBase::~ClassLoaderBase ( ) [inline, virtual]

Empty virtual destructor.

Definition at line 51 of file class_loader_base.hpp.

Member Function Documentation

virtual std::string pluginlib::ClassLoaderBase::getBaseClassType ( ) const [pure virtual]

Given the lookup name of a class, returns the type of the associated base class.

Returns:: The type of the associated base class

Implemented in pluginlib::ClassLoader< T >.

virtual std::string pluginlib::ClassLoaderBase::getClassDescription ( const std::string & lookup_name ) [pure virtual]

Given the lookup name of a class, returns its description.

Parameters:

lookup_name The lookup name of the class

Returns:: The description of the class

Implemented in pluginlib::ClassLoader< T >.

virtual std::string pluginlib::ClassLoaderBase::getClassLibraryPath ( const std::string & lookup_name ) [pure virtual]

Given the name of a class, returns the path to its associated library.

Parameters:

lookup_name The name of the class

Returns:: The path to the associated library

Implemented in pluginlib::ClassLoader< T >.

virtual std::string pluginlib::ClassLoaderBase::getClassPackage ( const std::string & lookup_name ) [pure virtual]

Given the name of a class, returns name of the containing package.

Parameters:

lookup_name The name of the class

Returns:: The name of the containing package

Implemented in pluginlib::ClassLoader< T >.

virtual std::string pluginlib::ClassLoaderBase::getClassType ( const std::string & lookup_name ) [pure virtual]

Given the lookup name of a class, returns the type of the derived class associated with it.

Parameters:

lookup_name The name of the class

Returns:: The name of the associated derived class

Implemented in pluginlib::ClassLoader< T >.

virtual std::vector<std::string> pluginlib::ClassLoaderBase::getDeclaredClasses ( ) [pure virtual]

Returns a list of all available classes for this ClassLoader's base class type.

Returns:: A vector of strings corresponding to the names of all available classes

Implemented in pluginlib::ClassLoader< T >.

virtual std::string pluginlib::ClassLoaderBase::getName ( const std::string & lookup_name ) [pure virtual]

Strips the package name off of a lookup name.

Parameters:

lookup_name The name of the plugin

Returns:: The name of the plugin stripped of the package name

Implemented in pluginlib::ClassLoader< T >.

virtual std::string pluginlib::ClassLoaderBase::getPluginManifestPath ( const std::string & lookup_name ) [pure virtual]

Given the name of a class, returns the path of the associated plugin manifest.

Parameters:

lookup_name The name of the class

Returns:: The path of the associated plugin manifest

Implemented in pluginlib::ClassLoader< T >.

virtual std::vector<std::string> pluginlib::ClassLoaderBase::getPluginXmlPaths ( ) [pure virtual]

Returns a list of all available plugin manifest paths for this ClassLoader's base class type.

Returns:: A vector of strings corresponding to the paths of all available plugin manifests

Implemented in pluginlib::ClassLoader< T >.

virtual std::vector<std::string> pluginlib::ClassLoaderBase::getRegisteredLibraries ( ) [pure virtual]

Returns the libraries that are registered and can be loaded.

Returns:: A vector of strings corresponding to the names of registered libraries

Implemented in pluginlib::ClassLoader< T >.

virtual bool pluginlib::ClassLoaderBase::isClassAvailable ( const std::string & lookup_name ) [pure virtual]

Checks if the class associated with a plugin name is available to be loaded.

Parameters:

lookup_name The name of the plugin

Returns:: True if the plugin is available, false otherwise

Implemented in pluginlib::ClassLoader< T >.

virtual bool pluginlib::ClassLoaderBase::isClassLoaded ( const std::string & lookup_name ) [pure virtual]

Checks if a given class is currently loaded.

Parameters:

lookup_name The lookup name of the class to query

Returns:: True if the class is loaded, false otherwise

Implemented in pluginlib::ClassLoader< T >.

virtual void pluginlib::ClassLoaderBase::loadLibraryForClass ( const std::string & lookup_name ) [pure virtual]

Attempts to load a class with a given name.

Parameters:

lookup_name The lookup name of the class to load

Exceptions:

pluginlib::LibraryLoadException Thrown if the library for the class cannot be loaded

Implemented in pluginlib::ClassLoader< T >.

virtual void pluginlib::ClassLoaderBase::refreshDeclaredClasses ( ) [pure virtual]

Refreshs the list of all available classes for this ClassLoader's base class type

Exceptions:

pluginlib::LibraryLoadException Thrown if package manifest cannot be found.

Implemented in pluginlib::ClassLoader< T >.

virtual int pluginlib::ClassLoaderBase::unloadLibraryForClass ( const std::string & lookup_name ) [pure virtual]

Attempts to unload a class with a given name.

Parameters:

lookup_name The lookup name of the class to unload

Exceptions:

pluginlib::LibraryUnloadException Thrown if the library for the class cannot be unloaded

Returns:: The number of pending unloads until the library is removed from memory

Implemented in pluginlib::ClassLoader< T >.

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

class_loader_base.hpp