GlobalStatePlexilAdapter Class Reference

Interface adapter to provide logging facilities. More...

#include <globals_adapter.h>

Inheritance diagram for GlobalStatePlexilAdapter:

Public Member Functions
	GlobalStatePlexilAdapter (PLEXIL::AdapterExecInterface &execInterface)
	Constructor. More...
	GlobalStatePlexilAdapter (PLEXIL::AdapterExecInterface &execInterface, pugi::xml_node const xml)
	Constructor from configuration XML. More...
virtual	~GlobalStatePlexilAdapter ()
	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...
virtual void	subscribe (const PLEXIL::State &state)
	Subscribe to updates for given state. More...
virtual void	unsubscribe (const PLEXIL::State &state)
	Unsubscribe from updates. More...
virtual void	executeCommand (PLEXIL::Command *cmd)
	Perform given command. More...
virtual void	invokeAbort (PLEXIL::Command *cmd)
	Abort currently running execution. More...
virtual void	lookupNow (PLEXIL::State const &state, PLEXIL::StateCacheEntry &cache_entry)
	Immediate lookup of value. More...

Detailed Description

Interface adapter to provide logging facilities.

Plexil adapter to provide access to the Fawkes configuration.

Author

Tim Niemueller

Definition at line 35 of file globals_adapter.h.

Constructor & Destructor Documentation

GlobalStatePlexilAdapter() [1/2]

GlobalStatePlexilAdapter::GlobalStatePlexilAdapter

(

PLEXIL::AdapterExecInterface &

execInterface

)

Constructor.

Parameters

execInterface

Reference to the parent AdapterExecInterface object.

Definition at line 44 of file globals_adapter.cpp.

GlobalStatePlexilAdapter() [2/2]

GlobalStatePlexilAdapter::GlobalStatePlexilAdapter	(	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 54 of file globals_adapter.cpp.

~GlobalStatePlexilAdapter()

GlobalStatePlexilAdapter::~GlobalStatePlexilAdapter ( )

virtual

Destructor.

Definition at line 61 of file globals_adapter.cpp.

Member Function Documentation

executeCommand()

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

virtual

Perform given command.

Parameters

cmd	command to execute

Definition at line 272 of file globals_adapter.cpp.

initialize()

bool GlobalStatePlexilAdapter::initialize ( )

virtual

Initialize adapter.

Returns

true if initialization was successful, false otherwise.

Definition at line 69 of file globals_adapter.cpp.

References fawkes::Configuration::exists(), fawkes::Configuration::get_bool(), fawkes::Configuration::get_float(), fawkes::Configuration::get_int(), fawkes::Configuration::get_string(), fawkes::Logger::log_debug(), fawkes::Logger::log_warn(), fawkes::Configuration::ValueIterator::path(), fawkes::Configuration::search(), and fawkes::Exception::what_no_backtrace().

invokeAbort()

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

virtual

Abort currently running execution.

Parameters

cmd	command to abort

Definition at line 292 of file globals_adapter.cpp.

lookupNow()

void GlobalStatePlexilAdapter::lookupNow ( PLEXIL::State const &  state, PLEXIL::StateCacheEntry &  cache_entry  )

virtual

Immediate lookup of value.

Parameters

state	state variable to lookup
cache_entry	cache entry for retrieved value

Definition at line 303 of file globals_adapter.cpp.

reset()

bool GlobalStatePlexilAdapter::reset ( void  )

virtual

Reset adapter.

Returns

true if successful, false otherwise.

Definition at line 254 of file globals_adapter.cpp.

shutdown()

bool GlobalStatePlexilAdapter::shutdown ( )

virtual

Shut adapter down.

Returns

true if successful, false otherwise.

Definition at line 263 of file globals_adapter.cpp.

start()

bool GlobalStatePlexilAdapter::start ( )

virtual

Start adapter.

Returns

true if starting was successful, false otherwise.

Definition at line 236 of file globals_adapter.cpp.

stop()

bool GlobalStatePlexilAdapter::stop ( )

virtual

Stop adapter.

Returns

true if successful, false otherwise.

Definition at line 245 of file globals_adapter.cpp.

subscribe()

void GlobalStatePlexilAdapter::subscribe ( const PLEXIL::State &  state )

virtual

Subscribe to updates for given state.

Parameters

state

state variable to subscribe for

Definition at line 319 of file globals_adapter.cpp.

unsubscribe()

void GlobalStatePlexilAdapter::unsubscribe ( const PLEXIL::State &  state )

virtual

Unsubscribe from updates.

Parameters

state

state variable to unsubscribe from

Definition at line 328 of file globals_adapter.cpp.

---

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

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