Abstract base class for IOProcessors implementations.

Inheritance diagram for uscxml::IOProcessorImpl:

Collaboration diagram for uscxml::IOProcessorImpl:

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

virtual void	eventFromSCXML (const std::string &target, const Event &event)=0
	We received an event from the SCXML Interpreter we are associated with. More...

virtual bool	isValidTarget (const std::string &target)=0
	Determine whether the given target is a valid destination for events. More...

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

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

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

Member Function Documentation

virtual std::shared_ptr<IOProcessorImpl> uscxml::IOProcessorImpl::create ( IOProcessorCallbacks * callbacks )

pure virtual

Parameters

interpreter The imlementation of the associated Interpreter

Todo:: We will eventually introduce callbacks and prevent complete access to the interpreter.

virtual void uscxml::IOProcessorImpl::eventFromSCXML	(	const std::string &	target,
		const Event &	event
	)

pure virtual

Parameters

target	Where the event is supposed to be delivered to.
event	The event to deliver.

void uscxml::IOProcessorImpl::eventToSCXML	(	Event &	event,
		const std::string &	type,
		const std::string &	origin,
		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`.
origin	The origin of this I/O Processor for `event.origin`.
internal	If the event is to be delivered to the Interpreter's internal queue instead.

virtual bool uscxml::IOProcessorImpl::isValidTarget ( const std::string & target )

pure virtual

Parameters

target A target where the Interpreter wants to deliver Events to.

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

Public Member Functions