Fawkes API Fawkes Development Version
ThreadNamePlexilAdapter Class Reference

Interface adapter to set thread name. More...

#include <thread_adapter.h>

Inheritance diagram for ThreadNamePlexilAdapter:

Public Member Functions

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

Detailed Description

Interface adapter to set thread name.

Plexil adapter to provide logging facilities.

Author
Tim Niemueller

Definition at line 31 of file thread_adapter.h.

Constructor & Destructor Documentation

◆ ThreadNamePlexilAdapter() [1/2]

ThreadNamePlexilAdapter::ThreadNamePlexilAdapter ( PLEXIL::AdapterExecInterface &  execInterface)

Constructor.

Parameters
execInterfaceReference to the parent AdapterExecInterface object.

Definition at line 39 of file thread_adapter.cpp.

◆ ThreadNamePlexilAdapter() [2/2]

ThreadNamePlexilAdapter::ThreadNamePlexilAdapter ( 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 49 of file thread_adapter.cpp.

◆ ~ThreadNamePlexilAdapter()

ThreadNamePlexilAdapter::~ThreadNamePlexilAdapter ( )
virtual

Destructor.

Definition at line 56 of file thread_adapter.cpp.

Member Function Documentation

◆ initialize()

bool ThreadNamePlexilAdapter::initialize ( )
virtual

Initialize adapter.

Returns
true if initialization was successful, false otherwise.

Definition at line 64 of file thread_adapter.cpp.

◆ reset()

bool ThreadNamePlexilAdapter::reset ( void  )
virtual

Reset adapter.

Returns
true if successful, false otherwise.

Definition at line 113 of file thread_adapter.cpp.

◆ shutdown()

bool ThreadNamePlexilAdapter::shutdown ( )
virtual

Shut adapter down.

Returns
true if successful, false otherwise.

Definition at line 122 of file thread_adapter.cpp.

◆ start()

bool ThreadNamePlexilAdapter::start ( )
virtual

Start adapter.

Returns
true if starting was successful, false otherwise.

Definition at line 73 of file thread_adapter.cpp.

References fawkes::Thread::current_thread_name().

◆ stop()

bool ThreadNamePlexilAdapter::stop ( )
virtual

Stop adapter.

Returns
true if successful, false otherwise.

Definition at line 104 of file thread_adapter.cpp.


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