ProtobufCommPlexilAdapter Class Reference

Interface adapter to provide logging facilities. More...

#include <protobuf_adapter.h>

Inheritance diagram for ProtobufCommPlexilAdapter:

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

Author

Tim Niemueller

Definition at line 37 of file protobuf_adapter.h.

Constructor & Destructor Documentation

ProtobufCommPlexilAdapter() [1/2]

ProtobufCommPlexilAdapter::ProtobufCommPlexilAdapter

(

PLEXIL::AdapterExecInterface &

execInterface

)

Constructor.

Parameters

execInterface

Reference to the parent AdapterExecInterface object.

Definition at line 49 of file protobuf_adapter.cpp.

ProtobufCommPlexilAdapter() [2/2]

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

Constructor from configuration XML.

Parameters

execInterface	Reference to the parent AdapterExecInterface object.
xml	A const reference to the XML element describing this adapter

Note

The instance maintains a shared pointer to the XML.

Definition at line 59 of file protobuf_adapter.cpp.

~ProtobufCommPlexilAdapter()

ProtobufCommPlexilAdapter::~ProtobufCommPlexilAdapter ( )

virtual

Destructor.

Definition at line 66 of file protobuf_adapter.cpp.

Member Function Documentation

executeCommand()

void ProtobufCommPlexilAdapter::executeCommand

(

PLEXIL::Command *

cmd

)

Perform given command.

Parameters

cmd	command to execute

Definition at line 175 of file protobuf_adapter.cpp.

initialize()

bool ProtobufCommPlexilAdapter::initialize ( )

virtual

Initialize adapter.

Returns

true if initialization was successful, false otherwise.

Definition at line 74 of file protobuf_adapter.cpp.

References fawkes::Logger::log_info().

invokeAbort()

void ProtobufCommPlexilAdapter::invokeAbort

(

PLEXIL::Command *

cmd

)

Abort currently running execution.

Parameters

cmd	command to abort

Definition at line 350 of file protobuf_adapter.cpp.

reset()

bool ProtobufCommPlexilAdapter::reset ( void  )

virtual

Reset adapter.

Returns

true if successful, false otherwise.

Definition at line 157 of file protobuf_adapter.cpp.

shutdown()

bool ProtobufCommPlexilAdapter::shutdown ( )

virtual

Shut adapter down.

Returns

true if successful, false otherwise.

Definition at line 166 of file protobuf_adapter.cpp.

start()

bool ProtobufCommPlexilAdapter::start ( )

virtual

Start adapter.

Returns

true if starting was successful, false otherwise.

Definition at line 135 of file protobuf_adapter.cpp.

stop()

bool ProtobufCommPlexilAdapter::stop ( )

virtual

Stop adapter.

Returns

true if successful, false otherwise.

Definition at line 144 of file protobuf_adapter.cpp.

---

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

• src/plugins/plexil/protobuf_adapter.h
• src/plugins/plexil/protobuf_adapter.cpp