Fawkes API  Fawkes Development Version
FawkesRemotePlexilAdapter Class Reference

Interface adapter to provide logging facilities. More...

#include <remote_adapter.h>

Inheritance diagram for FawkesRemotePlexilAdapter:

Public Member Functions

 FawkesRemotePlexilAdapter (PLEXIL::AdapterExecInterface &execInterface)
 Constructor. More...
 
 FawkesRemotePlexilAdapter (PLEXIL::AdapterExecInterface &execInterface, pugi::xml_node const xml)
 Constructor from configuration XML. More...
 
virtual ~FawkesRemotePlexilAdapter ()
 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...
 
virtual void fam_event (const char *filename, unsigned int mask)
 Event has been raised. More...
 
- Public Member Functions inherited from fawkes::FamListener
virtual ~FamListener ()
 Virtual empty destructor. More...
 

Additional Inherited Members

- Static Public Attributes inherited from fawkes::FamListener
static const unsigned int FAM_ACCESS = 0x00000001
 File was accessed. More...
 
static const unsigned int FAM_MODIFY = 0x00000002
 File was modified. More...
 
static const unsigned int FAM_ATTRIB = 0x00000004
 Metadata changed. More...
 
static const unsigned int FAM_CLOSE_WRITE = 0x00000008
 Writtable file was closed. More...
 
static const unsigned int FAM_CLOSE_NOWRITE = 0x00000010
 Unwrittable file closed. More...
 
static const unsigned int FAM_CLOSE = (FAM_CLOSE_WRITE | FAM_CLOSE_NOWRITE)
 Close. More...
 
static const unsigned int FAM_OPEN = 0x00000020
 File was opened. More...
 
static const unsigned int FAM_MOVED_FROM = 0x00000040
 File was moved from X. More...
 
static const unsigned int FAM_MOVED_TO = 0x00000080
 File was moved to Y. More...
 
static const unsigned int FAM_MOVE = (FAM_MOVED_FROM | FAM_MOVED_TO)
 Moves. More...
 
static const unsigned int FAM_CREATE = 0x00000100
 Subfile was created. More...
 
static const unsigned int FAM_DELETE = 0x00000200
 Subfile was deleted. More...
 
static const unsigned int FAM_DELETE_SELF = 0x00000400
 Self was deleted. More...
 
static const unsigned int FAM_MOVE_SELF = 0x00000800
 Self was moved. More...
 
static const unsigned int FAM_UNMOUNT = 0x00002000
 Backing fs was unmounted. More...
 
static const unsigned int FAM_Q_OVERFLOW = 0x00004000
 Event queued overflowed. More...
 
static const unsigned int FAM_IGNORED = 0x00008000
 File was ignored. More...
 
static const unsigned int FAM_ONLYDIR = 0x01000000
 Only watch the path if it is a directory. More...
 
static const unsigned int FAM_DONT_FOLLOW = 0x02000000
 Do not follow a sym link. More...
 
static const unsigned int FAM_MASK_ADD = 0x20000000
 Add to the mask of an already existing watch. More...
 
static const unsigned int FAM_ISDIR = 0x40000000
 Event occurred against dir. More...
 
static const unsigned int FAM_ONESHOT = 0x80000000
 Only send event once. More...
 
static const unsigned int FAM_ALL_EVENTS
 All events which a program can wait on. More...
 

Detailed Description

Interface adapter to provide logging facilities.

Plexil adapter to provide access to the FawkesRemote.

Author
Tim Niemueller

Definition at line 48 of file remote_adapter.h.

Constructor & Destructor Documentation

◆ FawkesRemotePlexilAdapter() [1/2]

FawkesRemotePlexilAdapter::FawkesRemotePlexilAdapter ( PLEXIL::AdapterExecInterface &  execInterface)

Constructor.

Parameters
execInterfaceReference to the parent AdapterExecInterface object.

Definition at line 55 of file remote_adapter.cpp.

◆ FawkesRemotePlexilAdapter() [2/2]

FawkesRemotePlexilAdapter::FawkesRemotePlexilAdapter ( 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 65 of file remote_adapter.cpp.

◆ ~FawkesRemotePlexilAdapter()

FawkesRemotePlexilAdapter::~FawkesRemotePlexilAdapter ( )
virtual

Destructor.

Definition at line 72 of file remote_adapter.cpp.

Member Function Documentation

◆ executeCommand()

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

Perform given command.

Parameters
cmdcommand to execute

Definition at line 234 of file remote_adapter.cpp.

◆ fam_event()

void FawkesRemotePlexilAdapter::fam_event ( const char *  filename,
unsigned int  mask 
)
virtual

◆ initialize()

bool FawkesRemotePlexilAdapter::initialize ( )
virtual

Initialize adapter.

Returns
true if initialization was successful, false otherwise.

Definition at line 80 of file remote_adapter.cpp.

References fawkes::load_yaml_navgraph(), and fawkes::Exception::what_no_backtrace().

◆ invokeAbort()

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

Abort currently running execution.

Parameters
cmdcommand to abort

Definition at line 255 of file remote_adapter.cpp.

◆ reset()

bool FawkesRemotePlexilAdapter::reset ( void  )
virtual

Reset adapter.

Returns
true if successful, false otherwise.

Definition at line 209 of file remote_adapter.cpp.

◆ shutdown()

bool FawkesRemotePlexilAdapter::shutdown ( )
virtual

Shut adapter down.

Returns
true if successful, false otherwise.

Definition at line 218 of file remote_adapter.cpp.

References fawkes::Clock::finalize().

◆ start()

bool FawkesRemotePlexilAdapter::start ( )
virtual

Start adapter.

Returns
true if starting was successful, false otherwise.

Definition at line 191 of file remote_adapter.cpp.

◆ stop()

bool FawkesRemotePlexilAdapter::stop ( )
virtual

Stop adapter.

Returns
true if successful, false otherwise.

Definition at line 200 of file remote_adapter.cpp.


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