構成 | |
class | OpenRAVE::PLUGININFO |
Holds all the OpenRAVE-specific information provided by a plugin. [詳細] | |
型定義 | |
typedef InterfaceBasePtr(* | OpenRAVE::PluginExportFn_OpenRAVECreateInterface )(InterfaceType type, const std::string &name, const char *pluginhash, const char *envhash, EnvironmentBasePtr penv) |
Create the interfaces, see CreateInterfaceValidated. | |
typedef bool(* | OpenRAVE::PluginExportFn_OpenRAVEGetPluginAttributes )(PLUGININFO *pinfo, int size, const char *infohash) |
Called to fill information about the plugin, see GetPluginAttributesValidated. | |
typedef void(* | OpenRAVE::PluginExportFn_DestroyPlugin )() |
Called before plugin is unloaded from openrave. See DestroyPlugin. | |
関数 | |
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. | |
Every plugin needs to export these functions
typedef void(* OpenRAVE::PluginExportFn_DestroyPlugin)() |
Called before plugin is unloaded from openrave. See DestroyPlugin.
openrave.h の 2728 行で定義されています。
typedef InterfaceBasePtr(* OpenRAVE::PluginExportFn_OpenRAVECreateInterface)(InterfaceType type, const std::string &name, const char *pluginhash, const char *envhash, EnvironmentBasePtr penv) |
Create the interfaces, see CreateInterfaceValidated.
openrave.h の 2720 行で定義されています。
typedef bool(* OpenRAVE::PluginExportFn_OpenRAVEGetPluginAttributes)(PLUGININFO *pinfo, int size, const char *infohash) |
Called to fill information about the plugin, see GetPluginAttributesValidated.
openrave.h の 2724 行で定義されています。
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.
If possible, always returns a valid pointer regardless of initialization failure since the actual interface pointer stores documentation information and is used in introspection. Only use when rave/plugin.h is included.
[in] | type | the interface type |
[in] | name | the lowercase letters of the interface name |
[in] | sinput | a stream to the rest of the input args to OpenRAVECreateInterface |
[in] | penv | the environment pointer |
OPENRAVE_PLUGIN_API void DestroyPlugin | ( | ) |
[export] Stub function to be defined by plugin that includes rave/plugin.h.
customreader.cpp の 170 行で定義されています。
void GetPluginAttributesValidated | ( | OpenRAVE::PLUGININFO & | info | ) |
[helper] Validated function callback for returning a plugin's information. No checks need to be made on the parmaeters.
This function is called only once initially to determine what the plugin offers. It should be the safest funcdtion and should not create any static resources for the plugin. Only use when rave/plugin.h is included.
[out] | info | Holds information on what services this plugin provides. |
customreader.cpp の 165 行で定義されています。
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.