NuguCapability::IRoutineHandler Class Reference

routine handler interface More...

#include <routine_interface.hh>

Inheritance diagram for NuguCapability::IRoutineHandler:

Collaboration diagram for NuguCapability::IRoutineHandler:

Public Member Functions
virtual bool	next ()=0
	move to the next action and process. More...
virtual bool	prev ()=0
	move to the previous action and process. More...
virtual bool	startRoutine (const std::string &dialog_id, const std::string &data)=0
	start routine using by data which is composed of Routine.Start directive. More...
Public Member Functions inherited from NuguClientKit::ICapabilityInterface
virtual void	addEventResultCallback (const std::string &ename, EventResultCallback callback)=0
	Add event result callback for error handling. More...
virtual void	cancelDirective (NuguDirective *ndir)=0
	Receive a directive cancellation from the Directive sequencer. More...
virtual void	deInitialize ()=0
	Deinitialize the current object.
virtual std::string	getName ()=0
	Get the capability name of the current object. More...
virtual bool	getProperties (const std::string &property, std::list< std::string > &values)=0
	It is possible to share own property values among objects. More...
virtual bool	getProperty (const std::string &property, std::string &value)=0
	It is possible to share own property value among objects. More...
virtual std::string	getVersion ()=0
	Get the capability version of the current object. More...
virtual void	initialize ()=0
	Initialize the current object.
virtual void	notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0
	Notify event response info. More...
virtual void	notifyEventResult (const std::string &event_desc)=0
	Notify event result. More...
virtual void	preprocessDirective (NuguDirective *ndir)=0
	Receive a directive preprocessing request from Directive sequencer. More...
virtual void	processDirective (NuguDirective *ndir)=0
	Receive a directive processing request from Directive sequencer. More...
virtual bool	receiveCommand (const std::string &from, const std::string &command, const std::string &param)=0
	Process command from other objects. More...
virtual void	receiveCommandAll (const std::string &command, const std::string &param)=0
	Process command received from capability manager. More...
virtual void	removeEventResultCallback (const std::string &ename)=0
	Remove event result callback. More...
virtual void	restore ()=0
	Restore previous suspended action.
virtual void	setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0
	Set directive cancel policy. More...
virtual void	setCapabilityListener (ICapabilityListener *clistener)=0
	Set the listener object. More...
virtual void	setNuguCoreContainer (INuguCoreContainer *core_container)=0
	Set INuguCoreContainer for using functions in NuguCore. More...
virtual void	setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0
	Set capability suspend policy. More...
virtual void	suspend ()=0
	Suspend current action.
virtual void	updateCompactContext (NJson::Value &ctx)=0
	Update the compact context information of the capability agent. More...
virtual void	updateInfoForContext (NJson::Value &ctx)=0
	Update the current context information of the capability agent. More...

Additional Inherited Members
Public Types inherited from NuguClientKit::ICapabilityInterface
using	EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)>
	Event result callback for error handling. More...
enum class	SuspendPolicy { STOP , PAUSE }
	Capability suspend policy. More...

Detailed Description

routine handler interface

See also

IRoutineListener

Member Function Documentation

startRoutine()

virtual bool NuguCapability::IRoutineHandler::startRoutine ( const std::string &  dialog_id, const std::string &  data  )

pure virtual

start routine using by data which is composed of Routine.Start directive.

Parameters

[in]	dialog_id	dialog id
[in]	data	Routine.Start directive payload

Returns

whether starting routine is success or not

next()

virtual bool NuguCapability::IRoutineHandler::next ( )

pure virtual

move to the next action and process.

Returns

Result of operation

Return values

true	succeed to move and process
false	fail to move and process

prev()

virtual bool NuguCapability::IRoutineHandler::prev ( )

pure virtual

move to the previous action and process.

Returns

Result of operation

Return values

true	succeed to move and process
false	fail to move and process

---

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

• routine_interface.hh