Abstract base class for all invokers.

Inheritance diagram for uscxml::InvokerImpl:

Collaboration diagram for uscxml::InvokerImpl:

Public Member Functions
virtual std::shared_ptr< InvokerImpl >	create (InvokerCallbacks *callbacks)=0
	Factory demands a new instance. More...

virtual void	deserialize (const Data &encodedState)
	Load a state from a Data object. More...

virtual void	eventFromSCXML (const Event &event)=0
	Invoker received an event from the SCXML Interpreter.

virtual std::list< std::string >	getNames ()=0
	Return a list of names for types we implement.

virtual void	invoke (const std::string &source, const Event &invokeEvent)=0
	Invoker's parent state became active at the end of a macro-step. More...

virtual Data	serialize ()
	Save our state into a Data object.

virtual void	setInvokeId (const std::string &invokeId)
	Set the invocation identifier as required when returning events. More...

virtual void	uninvoke ()=0
	The invokers's parent state was left at the end of a macro-step.

Public Member Functions inherited from uscxml::EventHandlerImpl
virtual Data	getDataModelVariables ()=0
	Export a Data object for the `_x['name']` data-model namespace. More...

Protected Member Functions
void	eventToSCXML (Event &event, const std::string &type, const std::string &invokeId, bool internal=false)
	Return an event to the SCXML Interpreter instance. More...

Member Function Documentation

virtual std::shared_ptr<InvokerImpl> uscxml::InvokerImpl::create ( InvokerCallbacks * callbacks )

pure virtual

Parameters

callbacks An object implementing the invoker callbacks.

virtual void uscxml::InvokerImpl::deserialize ( const Data & encodedState )

inlinevirtual

Parameters

encodedState The state we returned somewhen else via serialize.

void uscxml::InvokerImpl::eventToSCXML	(	Event &	event,
		const std::string &	type,
		const std::string &	invokeId,
		bool	internal = `false`
	)

protected

Parameters

event	An event to enqueue at the interpreter's external queue.
type	The type of this I/O Processor for `event.origintype`.
invokeId	The invocation identifier of this invocation for `event.invokeid`.
internal	If the event is to be delivered to the Interpreter's internal queue instead.

virtual void uscxml::InvokerImpl::invoke	(	const std::string &	source,
		const Event &	invokeEvent
	)

pure virtual

Parameters

source	The content of the invoke's `src` or evaluated `srcexpr` attribute
invokeEvent	The invocation with all its data as an event

virtual void uscxml::InvokerImpl::setInvokeId ( const std::string & invokeId )

inlinevirtual

Parameters

invokeId The invocation identifier.

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

Public Member Functions