Fawkes API  Fawkes Development Version
ConfigurationPlexilAdapter Class Reference

Interface adapter to provide logging facilities. More...

#include <config_adapter.h>

Inheritance diagram for ConfigurationPlexilAdapter:

Public Member Functions

 ConfigurationPlexilAdapter (PLEXIL::AdapterExecInterface &execInterface)
 Constructor. More...
 
 ConfigurationPlexilAdapter (PLEXIL::AdapterExecInterface &execInterface, pugi::xml_node const xml)
 Constructor from configuration XML. More...
 
virtual ~ConfigurationPlexilAdapter ()
 Destructor. More...
 
virtual bool initialize ()
 Initialize adapter. More...
 
virtual bool start ()
 Start adapter. More...
 
virtual bool stop ()
 Stop adapter. More...
 
virtual bool reset ()
 Reset adapter. More...
 
virtual bool shutdown ()
 Shut adapter down. More...
 
void executeCommand (PLEXIL::Command *cmd)
 Perform given command. More...
 
void invokeAbort (PLEXIL::Command *cmd)
 Abort currently running execution. More...
 

Detailed Description

Interface adapter to provide logging facilities.

Plexil adapter to provide access to the Fawkes configuration.

Author
Tim Niemueller

Definition at line 34 of file config_adapter.h.

Constructor & Destructor Documentation

◆ ConfigurationPlexilAdapter() [1/2]

ConfigurationPlexilAdapter::ConfigurationPlexilAdapter ( PLEXIL::AdapterExecInterface &  execInterface)

Constructor.

Parameters
execInterfaceReference to the parent AdapterExecInterface object.

Definition at line 44 of file config_adapter.cpp.

◆ ConfigurationPlexilAdapter() [2/2]

ConfigurationPlexilAdapter::ConfigurationPlexilAdapter ( PLEXIL::AdapterExecInterface &  execInterface,
pugi::xml_node const  xml 
)

Constructor from configuration XML.

Parameters
execInterfaceReference to the parent AdapterExecInterface object.
xmlA const reference to the XML element describing this adapter
Note
The instance maintains a shared pointer to the XML.

Definition at line 54 of file config_adapter.cpp.

◆ ~ConfigurationPlexilAdapter()

ConfigurationPlexilAdapter::~ConfigurationPlexilAdapter ( )
virtual

Destructor.

Definition at line 61 of file config_adapter.cpp.

Member Function Documentation

◆ executeCommand()

void ConfigurationPlexilAdapter::executeCommand ( PLEXIL::Command *  cmd)

Perform given command.

Parameters
cmdcommand to execute

Definition at line 151 of file config_adapter.cpp.

◆ initialize()

bool ConfigurationPlexilAdapter::initialize ( )
virtual

Initialize adapter.

Returns
true if initialization was successful, false otherwise.

Definition at line 69 of file config_adapter.cpp.

◆ invokeAbort()

void ConfigurationPlexilAdapter::invokeAbort ( PLEXIL::Command *  cmd)

Abort currently running execution.

Parameters
cmdcommand to abort

Definition at line 171 of file config_adapter.cpp.

◆ reset()

bool ConfigurationPlexilAdapter::reset ( )
virtual

Reset adapter.

Returns
true if successful, false otherwise.

Definition at line 133 of file config_adapter.cpp.

◆ shutdown()

bool ConfigurationPlexilAdapter::shutdown ( )
virtual

Shut adapter down.

Returns
true if successful, false otherwise.

Definition at line 142 of file config_adapter.cpp.

◆ start()

bool ConfigurationPlexilAdapter::start ( )
virtual

Start adapter.

Returns
true if starting was successful, false otherwise.

Definition at line 115 of file config_adapter.cpp.

◆ stop()

bool ConfigurationPlexilAdapter::stop ( )
virtual

Stop adapter.

Returns
true if successful, false otherwise.

Definition at line 124 of file config_adapter.cpp.


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