Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
ola::plugin::gpio::GPIOPlugin Class Reference

Detailed Description

A plugin that drives general purpose digital I/O lines.

Inheritance diagram for ola::plugin::gpio::GPIOPlugin:
Inheritance graph
[legend]
Collaboration diagram for ola::plugin::gpio::GPIOPlugin:
Collaboration graph
[legend]

Public Member Functions

 GPIOPlugin (class ola::PluginAdaptor *plugin_adaptor)
 Create a new GPIOPlugin. More...
 
std::string Name () const
 Get the plugin name. More...
 
std::string Description () const
 
ola_plugin_id Id () const
 Get the plugin ID of this plugin. More...
 
std::string PluginPrefix () const
 The prefix to use for storing configuration files. More...
 
- Public Member Functions inherited from ola::Plugin
 Plugin (PluginAdaptor *plugin_adaptor)
 
bool LoadPreferences ()
 Load the preferences for a plugin and set defaults.
 
std::string PreferenceConfigLocation () const
 The location for preferences. More...
 
bool IsEnabled () const
 Is the plugin enabled? More...
 
void SetEnabledState (bool enable)
 Set the plugin's enabled state. More...
 
virtual bool Start ()
 Start the plugin. More...
 
virtual bool Stop ()
 Stop the plugin. More...
 
virtual bool DefaultMode () const
 
virtual void ConflictsWith (std::set< ola_plugin_id > *) const
 
bool operator< (const AbstractPlugin &other) const
 

Additional Inherited Members

- Protected Attributes inherited from ola::Plugin
PluginAdaptorm_plugin_adaptor
 
class Preferencesm_preferences
 
- Static Protected Attributes inherited from ola::Plugin
static const char ENABLED_KEY [] = "enabled"
 

Constructor & Destructor Documentation

ola::plugin::gpio::GPIOPlugin::GPIOPlugin ( class ola::PluginAdaptor plugin_adaptor)
inlineexplicit

Create a new GPIOPlugin.

Parameters
plugin_adaptorthe PluginAdaptor to use

Member Function Documentation

string ola::plugin::gpio::GPIOPlugin::Description ( ) const
virtual

Return the description for this plugin.

Returns
a string description of the plugin

Implements ola::AbstractPlugin.

ola_plugin_id ola::plugin::gpio::GPIOPlugin::Id ( ) const
inlinevirtual

Get the plugin ID of this plugin.

Returns
the ola_plugin_id of this plugin

Implements ola::Plugin.

std::string ola::plugin::gpio::GPIOPlugin::Name ( ) const
inlinevirtual

Get the plugin name.

Returns
the name of this plugin

Implements ola::AbstractPlugin.

std::string ola::plugin::gpio::GPIOPlugin::PluginPrefix ( ) const
inlinevirtual

The prefix to use for storing configuration files.

Returns
A unique prefix used to identify the configuration file for this plugin.

Implements ola::Plugin.


The documentation for this class was generated from the following files: