This document describes libRoadRunners Plugins API.
The Plugins API is centered around the PluginManager, Plugin, and the Property classes. The Plugin manager is responsible for validating, loading and unloading plugins at runtime.
The Plugins themselves are self contained shared libraries that may be designed to extend the functionality of the main libRoadRunners core API.
The capabilities of a Plugin is communicated to a client by the use of PluginProperties. A Plugin property is an object able to communicate various types of data betwen the Plugin and the client, such as an int, double or a string. In addition to its value, plugin properties have a name, hint and description field, assisting in communicating the purpose of the property.
A client typically loads and configure a plugin, through the use of Properties, and then subsequently executes the plugin using the plugins execute function. Finally, the client may retrieve some kind of result from the Plugin, again, using a Property.
Since a Plugins function will be determined by the actual Plugin author, documentation of a Plugins purpose and on how to use the plugin, is ideally bundled with the plugin and retrieved by various Plugin functions, e.g. getPluginInfo() and getPluginManualAsPDF().
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 University of Washington nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
Generated on Mon Mar 31 2014 14:36:33 for Tellurium Plugin C++ API by 1.8.4
1.8.4
