Fawkes API  Fawkes Development Version
NavGraphPlexilAdapter Class Reference

Interface adapter to provide logging facilities. More...

#include <navgraph_adapter.h>

Inheritance diagram for NavGraphPlexilAdapter:

Public Member Functions

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

Author
Tim Niemueller

Definition at line 41 of file navgraph_adapter.h.

Constructor & Destructor Documentation

◆ NavGraphPlexilAdapter() [1/2]

NavGraphPlexilAdapter::NavGraphPlexilAdapter ( PLEXIL::AdapterExecInterface &  execInterface)

Constructor.

Parameters
execInterfaceReference to the parent AdapterExecInterface object.

Definition at line 50 of file navgraph_adapter.cpp.

◆ NavGraphPlexilAdapter() [2/2]

NavGraphPlexilAdapter::NavGraphPlexilAdapter ( 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 60 of file navgraph_adapter.cpp.

◆ ~NavGraphPlexilAdapter()

NavGraphPlexilAdapter::~NavGraphPlexilAdapter ( )
virtual

Destructor.

Definition at line 67 of file navgraph_adapter.cpp.

Member Function Documentation

◆ executeCommand()

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

Perform given command.

Parameters
cmdcommand to execute

Definition at line 146 of file navgraph_adapter.cpp.

◆ initialize()

bool NavGraphPlexilAdapter::initialize ( )
virtual

Initialize adapter.

Returns
true if initialization was successful, false otherwise.

Definition at line 75 of file navgraph_adapter.cpp.

References fawkes::Logger::log_error(), and fawkes::Exception::what_no_backtrace().

◆ invokeAbort()

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

Abort currently running execution.

Parameters
cmdcommand to abort

Definition at line 272 of file navgraph_adapter.cpp.

◆ reset()

bool NavGraphPlexilAdapter::reset ( void  )
virtual

Reset adapter.

Returns
true if successful, false otherwise.

Definition at line 127 of file navgraph_adapter.cpp.

◆ shutdown()

bool NavGraphPlexilAdapter::shutdown ( )
virtual

Shut adapter down.

Returns
true if successful, false otherwise.

Definition at line 136 of file navgraph_adapter.cpp.

References fawkes::BlackBoard::close().

◆ start()

bool NavGraphPlexilAdapter::start ( )
virtual

Start adapter.

Returns
true if starting was successful, false otherwise.

Definition at line 109 of file navgraph_adapter.cpp.

◆ stop()

bool NavGraphPlexilAdapter::stop ( )
virtual

Stop adapter.

Returns
true if successful, false otherwise.

Definition at line 118 of file navgraph_adapter.cpp.


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