openrave.org

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Macros | Functions
plugin.h File Reference

(2013-03-18 10:33:00 +0900, commit:334d202)

Provides helper functions for creating plugins. Defines all the necessary functions to export. More...

#include <openrave/openrave.h>
#include <boost/format.hpp>
Include dependency graph for plugin.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define OPENRAVE_PLUGIN_API   extern "C" OPENRAVE_HELPER_DLL_EXPORT
 
#define RAVE_PLUGIN_API   OPENRAVE_PLUGIN_API
 

Functions

OpenRAVE::InterfaceBasePtr CreateInterfaceValidated (OpenRAVE::InterfaceType type, const std::string &name, std::istream &sinput, OpenRAVE::EnvironmentBasePtr penv)
 [helper] Validated function callback for creating an interface function. No checks need to be made on the parmaeters.
 
void GetPluginAttributesValidated (OpenRAVE::PLUGININFO &info)
 [helper] Validated function callback for returning a plugin's information. No checks need to be made on the parmaeters.
 
OPENRAVE_PLUGIN_API
OpenRAVE::InterfaceBasePtr 
OpenRAVECreateInterface (OpenRAVE::InterfaceType type, const std::string &name, const char *interfacehash, const char *envhash, OpenRAVE::EnvironmentBasePtr penv)
 [export] Definition of a plugin export. Requires CreateInterfaceValidated to be defined.
 
OPENRAVE_PLUGIN_API void OpenRAVEGetPluginAttributes (OpenRAVE::PLUGININFO *pinfo, int size, const char *infohash)
 [export] Definition of a plugin export. Requires GetPluginAttributesValidated to be defined.
 
OPENRAVE_PLUGIN_API void DestroyPlugin ()
 [export] Stub function to be defined by plugin that includes rave/plugin.h.
 

Detailed Description

Provides helper functions for creating plugins. Defines all the necessary functions to export.

This file is optional and not automatically included with openrave.h

Definition in file plugin.h.

Macro Definition Documentation

#define OPENRAVE_PLUGIN_API   extern "C" OPENRAVE_HELPER_DLL_EXPORT
Examples:
customreader.cpp, and plugincpp.cpp.

Definition at line 29 of file plugin.h.

#define RAVE_PLUGIN_API   OPENRAVE_PLUGIN_API
Deprecated:

Definition at line 32 of file plugin.h.