Plugin.hpp File Reference

This file defines the Orocos plugin API. More...

#include "rtt-config.h"
#include <string>

Go to the source code of this file.

Namespaces

namespace  RTT
 

We can't use typedefs since C++ doesn't allow it for templated classes without specifying all the template parameters.


Functions

RTT_EXPORT bool loadRTTPlugin (RTT::TaskContext *t)
 Instructs this plugin to load itself into the application.
RTT_EXPORT std::string getRTTPluginName ()
 Return the unique name of this plugin.

Detailed Description

This file defines the Orocos plugin API.

A plugin is a dynamic library which has a unique name and can be loaded in a running application. In case the loading is done by an Orocos TaskContext, the plugin is notified of the loading TaskContext. A plugin can reject to load, in which case the library should be unloaded from the application again. Once loaded, a plugin remains in the current process until the process exits.

Definition in file Plugin.hpp.


Function Documentation

RTT_EXPORT std::string getRTTPluginName (  ) 

Return the unique name of this plugin.

No two plugins with the same name will be allowed to live in a single process.

RTT_EXPORT bool loadRTTPlugin ( RTT::TaskContext t  ) 

Instructs this plugin to load itself into the application.

Implement in this function any startup code your plugin requires. This function should not throw.

Parameters:
t The optional TaskContext which is loading this plugin. May be zero.
Returns:
true if the initialisation succeeded, false if the plugin could not do so.
Generated on Thu Dec 23 13:22:38 2010 for Orocos Real-Time Toolkit by  doxygen 1.6.3