NuguClientKit::IDirectiveSequencer Class Reference

IDirectiveSequencer. More...

#include <directive_sequencer_interface.hh>

Public Member Functions
virtual bool	add (NuguDirective *ndir)=0
	Add new directive to sequencer. More...
virtual void	addListener (const std::string &name_space, IDirectiveSequencerListener *listener)=0
	Add the Listener object. More...
virtual bool	addPolicy (const std::string &name_space, const std::string &name, BlockingPolicy policy)=0
	Add the BlockingPolicy. More...
virtual bool	cancel (const std::string &dialog_id, bool cancel_active_directive=true)=0
	Cancel all pending directives related to the dialog_id. The canceled directives are freed. More...
virtual bool	cancel (const std::string &dialog_id, std::set< std::string > groups)=0
	Cancels specific pending directives related to the dialog_id. The canceled directives are freed. More...
virtual bool	cancelAll (bool cancel_active_directive=true)=0
	Cancels all pending directives. The canceled directives are freed. More...
virtual bool	complete (NuguDirective *ndir)=0
	Complete the blocking directive. The NuguDirective object will be destroyed. If there are pending directives, those directives will be processed at the next idle time. More...
virtual const NuguDirective *	findPending (const std::string &name_space, const std::string &name)=0
	Find directive from pending list. More...
virtual const std::string &	getCanceledDialogId ()=0
	Get the last canceled dialog_id. More...
virtual BlockingPolicy	getPolicy (const std::string &name_space, const std::string &name)=0
	Get the BlockingPolicy for namespace.name. More...
virtual void	removeListener (const std::string &name_space, IDirectiveSequencerListener *listener)=0
	Remove the Listener object. More...

Detailed Description

IDirectiveSequencer.

See also

IDirectiveSequencerListener

Member Function Documentation

addListener()

virtual void NuguClientKit::IDirectiveSequencer::addListener ( const std::string &  name_space, IDirectiveSequencerListener *  listener  )

pure virtual

Add the Listener object.

Parameters

[in]	name_space	directive namespace
[in]	listener	listener object

removeListener()

virtual void NuguClientKit::IDirectiveSequencer::removeListener ( const std::string &  name_space, IDirectiveSequencerListener *  listener  )

pure virtual

Remove the Listener object.

Parameters

[in]	name_space	directive namespace
[in]	listener	listener object

addPolicy()

virtual bool NuguClientKit::IDirectiveSequencer::addPolicy ( const std::string &  name_space, const std::string &  name, BlockingPolicy  policy  )

pure virtual

Add the BlockingPolicy.

Parameters

[in]	name_space	directive namespace
[in]	name	directive name
[in]	policy	BlockingPolicy

Returns

Result of adding policy

Return values

true	success
false	failure

getPolicy()

virtual BlockingPolicy NuguClientKit::IDirectiveSequencer::getPolicy ( const std::string &  name_space, const std::string &  name  )

pure virtual

Get the BlockingPolicy for namespace.name.

Parameters

[in]	name_space	directive namespace
[in]	name	directive name

Returns

BlockingPolicy

cancel() [1/2]

virtual bool NuguClientKit::IDirectiveSequencer::cancel ( const std::string &  dialog_id, bool  cancel_active_directive = true  )

pure virtual

Cancel all pending directives related to the dialog_id. The canceled directives are freed.

Parameters

[in]	dialog_id	dialog-request-id
[in]	cancel_active_directive	cancel including currently active directives

Returns

result

Return values

true	success
false	failure

cancel() [2/2]

virtual bool NuguClientKit::IDirectiveSequencer::cancel ( const std::string &  dialog_id, std::set< std::string >  groups  )

pure virtual

Cancels specific pending directives related to the dialog_id. The canceled directives are freed.

Parameters

[in]	dialog_id	dialog-request-id
[in]	groups	list of directives('{Namespace}.{Name}')

Returns

result

Return values

true	success
false	failure

cancelAll()

virtual bool NuguClientKit::IDirectiveSequencer::cancelAll ( bool  cancel_active_directive = true )

pure virtual

Cancels all pending directives. The canceled directives are freed.

Parameters

[in]

cancel_active_directive

cancel including currently active directives

Returns

result

Return values

true	success
false	failure

complete()

virtual bool NuguClientKit::IDirectiveSequencer::complete ( NuguDirective *  ndir )

pure virtual

Complete the blocking directive. The NuguDirective object will be destroyed. If there are pending directives, those directives will be processed at the next idle time.

Parameters

[in]

ndir

NuguDirective object

Returns

result

Return values

true	success
false	failure

add()

virtual bool NuguClientKit::IDirectiveSequencer::add ( NuguDirective *  ndir )

pure virtual

Add new directive to sequencer.

Parameters

[in]

ndir

NuguDirective object

Returns

result

Return values

true	success
false	failure

getCanceledDialogId()

virtual const std::string& NuguClientKit::IDirectiveSequencer::getCanceledDialogId ( )

pure virtual

Get the last canceled dialog_id.

Returns

dialog_id

findPending()

virtual const NuguDirective* NuguClientKit::IDirectiveSequencer::findPending ( const std::string &  name_space, const std::string &  name  )

pure virtual

Find directive from pending list.

Parameters

[in]	name_space	directive namespace
[in]	name	directive name

Returns

NuguDirective object or NULL

---

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

• directive_sequencer_interface.hh