Program Listing for File class_loader_base.hpp

↰ Return to documentation for file (include/pluginlib/class_loader_base.hpp)

// Copyright 2012, Willow Garage, Inc. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//    * Redistributions of source code must retain the above copyright
//      notice, this list of conditions and the following disclaimer.
//
//    * Redistributions in binary form must reproduce the above copyright
//      notice, this list of conditions and the following disclaimer in the
//      documentation and/or other materials provided with the distribution.
//
//    * Neither the name of the Willow Garage nor the names of its
//      contributors may be used to endorse or promote products derived from
//      this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

#ifndef PLUGINLIB__CLASS_LOADER_BASE_HPP_
#define PLUGINLIB__CLASS_LOADER_BASE_HPP_

#include <vector>
#include <string>

namespace pluginlib
{

class ClassLoaderBase
{
public:
  virtual ~ClassLoaderBase() {}


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


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


  virtual void refreshDeclaredClasses() = 0;


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


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


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


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


  virtual std::string getBaseClassType() const = 0;


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


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


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


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


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


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


  virtual std::string getClassLibraryPath(const std::string & lookup_name) = 0;
};
}  // namespace pluginlib

#endif  // PLUGINLIB__CLASS_LOADER_BASE_HPP_