pion::platform::PlatformPlugin Class Reference

#include <PlatformPlugin.hpp>

Inherited by pion::platform::Codec, pion::platform::Database, pion::platform::Protocol, pion::platform::Reactor, and pion::server::PlatformService.

List of all members.


Detailed Description

PlatformPlugin: interface class extended by all Pion Platform plug-ins

Definition at line 50 of file PlatformPlugin.hpp.

Public Member Functions

 PlatformPlugin (void)
 constructs a new PlatformPlugin object
virtual ~PlatformPlugin ()
 virtual destructor: this class is meant to be extended
virtual void setConfig (const Vocabulary &v, const xmlNodePtr config_ptr)
virtual void updateVocabulary (const Vocabulary &v)
void setId (const std::string &plugin_id)
 sets the unique identifier for this plug-in
const std::string & getId (void) const
 returns the unique identifier for this plug-in
void setName (const std::string &plugin_name)
 sets the descriptive name for this plug-in
const std::string & getName (void) const
 returns the descriptive name for this plug-in
void setComment (const std::string &plugin_comment)
 sets the descriptive comment for this plug-in
const std::string & getComment (void) const
 returns the descriptive comment for this plug-in
void setCodecFactory (CodecFactory &factory)
 sets the CodecFactory that will used by the plugin to access Codecs
void setDatabaseManager (DatabaseManager &mgr)
 sets the DatabaseManager that will used by the plugin to access Databases
void setReactionEngine (ReactionEngine &engine)
 sets the ReactionEngine that will used by the plugin to access Reactors
void setProtocolFactory (ProtocolFactory &factory)
 sets the ProtocolFactory that will used by the plugin to access Protocols
void setServiceManager (pion::server::ServiceManager &mgr)
 sets the ServiceManager that will used by the plugin to access PlatformServices

Protected Member Functions

void copyPlugin (const PlatformPlugin &pp)
 protected copy function (use clone() instead)
CodecFactorygetCodecFactory (void)
 returns the CodecFactory to use for accessing Codecs
DatabaseManagergetDatabaseManager (void)
 returns the DatabaseManager to use for accessing Databases
ReactionEnginegetReactionEngine (void)
 returns the ReactionEngine to use for accessing Reactors
ProtocolFactorygetProtocolFactory (void)
 returns the ProtocolFactory to use for accessing Protocols
pion::server::ServiceManagergetServiceManager (void)
 returns the ServiceManager to use for accessing PlatformServices


Member Function Documentation

void pion::platform::PlatformPlugin::setConfig ( const Vocabulary v,
const xmlNodePtr  config_ptr 
) [virtual]

sets configuration parameters for this plug-in

Parameters:
v the Vocabulary that this plug-in will use to describe Terms
config_ptr pointer to a list of XML nodes containing plug-in configuration parameters

Reimplemented in pion::platform::Codec, pion::platform::Database, pion::platform::Protocol, pion::platform::Reactor, pion::plugins::JSONCodec, pion::plugins::LogCodec, pion::plugins::XMLCodec, pion::plugins::SQLiteDatabase, pion::plugins::DatabaseOutputReactor, pion::plugins::FilterReactor, pion::plugins::FissionReactor, pion::plugins::LogInputReactor, pion::plugins::LogOutputReactor, pion::plugins::PythonReactor, pion::plugins::ScriptReactor, pion::plugins::TransformReactor, pion::plugins::ConfigService, and pion::server::PlatformService.

Definition at line 36 of file PlatformPlugin.cpp.

References pion::platform::ConfigManager::getConfigOption().

Referenced by pion::platform::Reactor::setConfig(), pion::platform::Protocol::setConfig(), pion::platform::Database::setConfig(), and pion::platform::Codec::setConfig().

void pion::platform::PlatformPlugin::updateVocabulary ( const Vocabulary v  )  [virtual]

this updates the Vocabulary information used by this plug-in; it should be called whenever the global Vocabulary is updated

Parameters:
v the Vocabulary that this plug-in will use to describe Terms

Reimplemented in pion::platform::Codec, pion::platform::Protocol, pion::platform::Reactor, pion::plugins::JSONCodec, pion::plugins::LogCodec, pion::plugins::XMLCodec, pion::plugins::DatabaseOutputReactor, pion::plugins::FilterReactor, pion::plugins::FissionReactor, pion::plugins::LogOutputReactor, pion::plugins::PythonReactor, pion::plugins::ScriptReactor, and pion::plugins::TransformReactor.

Definition at line 47 of file PlatformPlugin.cpp.

Referenced by pion::platform::Reactor::updateVocabulary(), pion::platform::Protocol::updateVocabulary(), and pion::platform::Codec::updateVocabulary().


The documentation for this class was generated from the following files:
Generated on Wed Apr 13 16:38:36 2011 for pion-platform by  doxygen 1.4.7