Fawkes API  Fawkes Development Version
LoggingPlexilAdapter Class Reference

Interface adapter to provide logging facilities. More...

#include <log_adapter.h>

Inheritance diagram for LoggingPlexilAdapter:

Public Member Functions

 LoggingPlexilAdapter (PLEXIL::AdapterExecInterface &execInterface)
 Constructor. More...
 
 LoggingPlexilAdapter (PLEXIL::AdapterExecInterface &execInterface, pugi::xml_node const xml)
 Constructor from configuration XML. More...
 
virtual ~LoggingPlexilAdapter ()
 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 logging facilities.

Author
Tim Niemueller

Definition at line 31 of file log_adapter.h.

Constructor & Destructor Documentation

◆ LoggingPlexilAdapter() [1/2]

LoggingPlexilAdapter::LoggingPlexilAdapter ( PLEXIL::AdapterExecInterface &  execInterface)

Constructor.

Parameters
execInterfaceReference to the parent AdapterExecInterface object.

Definition at line 40 of file log_adapter.cpp.

◆ LoggingPlexilAdapter() [2/2]

LoggingPlexilAdapter::LoggingPlexilAdapter ( 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 50 of file log_adapter.cpp.

◆ ~LoggingPlexilAdapter()

LoggingPlexilAdapter::~LoggingPlexilAdapter ( )
virtual

Destructor.

Definition at line 57 of file log_adapter.cpp.

Member Function Documentation

◆ executeCommand()

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

Perform given command.

Parameters
cmdcommand to execute

Definition at line 150 of file log_adapter.cpp.

References fawkes::Logger::log_debug(), fawkes::Logger::log_error(), fawkes::Logger::log_info(), and fawkes::Logger::log_warn().

◆ initialize()

bool LoggingPlexilAdapter::initialize ( )
virtual

Initialize adapter.

Returns
true if initialization was successful, false otherwise.

Definition at line 65 of file log_adapter.cpp.

◆ invokeAbort()

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

Abort currently running execution.

Parameters
cmdcommand to abort

Definition at line 206 of file log_adapter.cpp.

◆ reset()

bool LoggingPlexilAdapter::reset ( )
virtual

Reset adapter.

Returns
true if successful, false otherwise.

Definition at line 105 of file log_adapter.cpp.

◆ shutdown()

bool LoggingPlexilAdapter::shutdown ( )
virtual

Shut adapter down.

Returns
true if successful, false otherwise.

Definition at line 114 of file log_adapter.cpp.

◆ start()

bool LoggingPlexilAdapter::start ( )
virtual

Start adapter.

Returns
true if starting was successful, false otherwise.

Definition at line 87 of file log_adapter.cpp.

◆ stop()

bool LoggingPlexilAdapter::stop ( )
virtual

Stop adapter.

Returns
true if successful, false otherwise.

Definition at line 96 of file log_adapter.cpp.


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