📄 classpion_1_1_pion_plugin.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"><title>libpion: pion::PionPlugin Class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"><link href="tabs.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.5.2 --><div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul></div><div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul></div><div class="nav"><a class="el" href="namespacepion.html">pion</a>::<a class="el" href="classpion_1_1_pion_plugin.html">PionPlugin</a></div><h1>pion::PionPlugin Class Reference</h1><!-- doxytag: class="pion::PionPlugin" --><code>#include <<a class="el" href="_pion_plugin_8hpp-source.html">PionPlugin.hpp</a>></code><p>Inherited by <a class="el" href="classpion_1_1_pion_plugin_ptr.html">pion::PionPluginPtr< InterfaceClassType ></a>.<p><a href="classpion_1_1_pion_plugin-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2><a class="el" href="classpion_1_1_pion_plugin.html">PionPlugin</a>: base class for plug-in management <p><p>Definition at line <a class="el" href="_pion_plugin_8hpp-source.html#l00027">27</a> of file <a class="el" href="_pion_plugin_8hpp-source.html">PionPlugin.hpp</a>.<table border="0" cellpadding="0" cellspacing="0"><tr><td></td></tr><tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d09314045c11e6c0e9d7aa7ddb857acf"></a><!-- doxytag: member="pion::PionPlugin::~PionPlugin" ref="d09314045c11e6c0e9d7aa7ddb857acf" args="()" -->virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#d09314045c11e6c0e9d7aa7ddb857acf">~PionPlugin</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f7f1e9162c9788d7c84eee023c5db825"></a><!-- doxytag: member="pion::PionPlugin::is_open" ref="f7f1e9162c9788d7c84eee023c5db825" args="(void) const " -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#f7f1e9162c9788d7c84eee023c5db825">is_open</a> (void) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if a shared library is loaded/open <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="693a3b35e4b8086ef33c11cffdab3491"></a><!-- doxytag: member="pion::PionPlugin::getPluginName" ref="693a3b35e4b8086ef33c11cffdab3491" args="(void) const " -->std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#693a3b35e4b8086ef33c11cffdab3491">getPluginName</a> (void) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the name of the plugin that is currently open <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#998d9f6ff965e708ad466ed3afac3b68">open</a> (const std::string &plugin_file)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b75b4731103e5117844a1fd540c79ae6"></a><!-- doxytag: member="pion::PionPlugin::close" ref="b75b4731103e5117844a1fd540c79ae6" args="(void)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#b75b4731103e5117844a1fd540c79ae6">close</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">closes plug-in library <br></td></tr><tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#b2a5652e82e5b50143153d3b12f808e8">findPluginFile</a> (std::string &path_to_file, const std::string &name)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#f5987395dce53c3921baa44be7d62a65">findConfigFile</a> (std::string &path_to_file, const std::string &name)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#b84026edef087fb963e6a828d4b8f730">checkCygwinPath</a> (boost::filesystem::path &final_path, const std::string &path_string)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8b8215145cd47f8f87d87cad24bbc488"></a><!-- doxytag: member="pion::PionPlugin::addPluginDirectory" ref="8b8215145cd47f8f87d87cad24bbc488" args="(const std::string &dir)" -->static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#8b8215145cd47f8f87d87cad24bbc488">addPluginDirectory</a> (const std::string &dir)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">appends a directory to the plug-in search path <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e3edad5eff79a95d95e622ef4bbe3fc0"></a><!-- doxytag: member="pion::PionPlugin::resetPluginDirectories" ref="e3edad5eff79a95d95e622ef4bbe3fc0" args="(void)" -->static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#e3edad5eff79a95d95e622ef4bbe3fc0">resetPluginDirectories</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">clears all directories from the plug-in search path <br></td></tr><tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e48aa98706b350c0c163c7473a77acf4"></a><!-- doxytag: member="pion::PionPlugin::PionPlugin" ref="e48aa98706b350c0c163c7473a77acf4" args="(void)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#e48aa98706b350c0c163c7473a77acf4">PionPlugin</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">default constructor is private (use <a class="el" href="classpion_1_1_pion_plugin_ptr.html">PionPluginPtr</a> class to create objects) <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c0cb7583f75f3979850d756a4e80559d"></a><!-- doxytag: member="pion::PionPlugin::PionPlugin" ref="c0cb7583f75f3979850d756a4e80559d" args="(const PionPlugin &p)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#c0cb7583f75f3979850d756a4e80559d">PionPlugin</a> (const <a class="el" href="classpion_1_1_pion_plugin.html">PionPlugin</a> &p)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">copy constructor <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d875b723a57311289a77f9c9dbb11137"></a><!-- doxytag: member="pion::PionPlugin::operator=" ref="d875b723a57311289a77f9c9dbb11137" args="(const PionPlugin &p)" --><a class="el" href="classpion_1_1_pion_plugin.html">PionPlugin</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#d875b723a57311289a77f9c9dbb11137">operator=</a> (const <a class="el" href="classpion_1_1_pion_plugin.html">PionPlugin</a> &p)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">assignment operator <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="072e8c34ecffa3202c8e0782415b5de0"></a><!-- doxytag: member="pion::PionPlugin::getCreateFunction" ref="072e8c34ecffa3202c8e0782415b5de0" args="(void)" -->void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#072e8c34ecffa3202c8e0782415b5de0">getCreateFunction</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns a pointer to the plug-in's "create object" function <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="563e914ec913f5114774495ff85eca2b"></a><!-- doxytag: member="pion::PionPlugin::getDestroyFunction" ref="563e914ec913f5114774495ff85eca2b" args="(void)" -->void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#563e914ec913f5114774495ff85eca2b">getDestroyFunction</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns a pointer to the plug-in's "destroy object" function <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1a4d45d0870f435e2b64242062db8e2d"></a><!-- doxytag: member="pion::PionPlugin::releaseData" ref="1a4d45d0870f435e2b64242062db8e2d" args="(void)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#1a4d45d0870f435e2b64242062db8e2d">releaseData</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">releases the plug-in's shared library symbols <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a76dc0c0fdf0ca4b19f719c122ae424"></a><!-- doxytag: member="pion::PionPlugin::grabData" ref="9a76dc0c0fdf0ca4b19f719c122ae424" args="(const PionPlugin &p)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin.html#9a76dc0c0fdf0ca4b19f719c122ae424">grabData</a> (const <a class="el" href="classpion_1_1_pion_plugin.html">PionPlugin</a> &p)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">grabs a reference to another plug-in's shared library symbols <br></td></tr><tr><td colspan="2"><br><h2>Classes</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin_1_1_directory_not_found_exception.html">DirectoryNotFoundException</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">exception thrown if the plug-in directory does not exist <a href="classpion_1_1_pion_plugin_1_1_directory_not_found_exception.html#_details">More...</a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structpion_1_1_pion_plugin_1_1_pion_plugin_data.html">PionPluginData</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin_1_1_plugin_missing_create_exception.html">PluginMissingCreateException</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">exception thrown if a plug-in library is missing the create() function <a href="classpion_1_1_pion_plugin_1_1_plugin_missing_create_exception.html#_details">More...</a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin_1_1_plugin_missing_destroy_exception.html">PluginMissingDestroyException</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">exception thrown if a plug-in library is missing the destroy() function <a href="classpion_1_1_pion_plugin_1_1_plugin_missing_destroy_exception.html#_details">More...</a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin_1_1_plugin_not_found_exception.html">PluginNotFoundException</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">exception thrown if the plug-in file cannot be opened <a href="classpion_1_1_pion_plugin_1_1_plugin_not_found_exception.html#_details">More...</a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_plugin_1_1_plugin_undefined_exception.html">PluginUndefinedException</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">exception thrown if the plug-in file cannot be opened <a href="classpion_1_1_pion_plugin_1_1_plugin_undefined_exception.html#_details">More...</a><br></td></tr></table><hr><h2>Member Function Documentation</h2><a class="anchor" name="b2a5652e82e5b50143153d3b12f808e8"></a><!-- doxytag: member="pion::PionPlugin::findPluginFile" ref="b2a5652e82e5b50143153d3b12f808e8" args="(std::string &path_to_file, const std::string &name)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">static bool pion::PionPlugin::findPluginFile </td> <td>(</td> <td class="paramtype">std::string & </td> <td class="paramname"> <em>path_to_file</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>name</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline, static]</code></td> </tr> </table></div>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -