VICI::stub::ViciStub Class Reference

A stub version of the Vici module. More...

#include <vici/libifstubs.h>

Inheritance diagram for VICI::stub::ViciStub:

Public Member Functions
virtual Interp::Interpreter *	getInterpreter ()
	Get a reference to the interpreter object.
virtual void	openFile (const VICI::Path &)
	Set the file to execute.
virtual void	autoStart ()
	Start the script as soon as the GUI is ready.
virtual void	setValue (csr varName, csr value)
	this gets called when a script variable has a change of value More...
virtual void	setFile (int state, csr filename)
	this gets called when a monitored file changes state. More...
virtual void	setCursor (ThreadId, NodeId)
	this gets called as the shell steps through the script More...
virtual void	breakReached (ThreadId, NodeId)
	this gets called when a break point is reached More...
virtual void	dataReady (NodeId)
	this gets called when data is available on a display More...
virtual void	reportError (Severity, csr)
	This gets called if an error is detected. More...
virtual void	done ()
	this gets called when the script completes
Public Member Functions inherited from VICI::Vici
virtual	~Vici ()
	virtual destructor
Public Member Functions inherited from VICI::Interp::InterpreterClient
virtual	~InterpreterClient ()
	virtual destructor

Detailed Description

A stub version of the Vici module.

Member Function Documentation

void ViciStub::breakReached ( ThreadId  tid, NodeId  node  )

virtual

this gets called when a break point is reached

Parameters

tid	the thread which reached the breakpoint
node	the location of the breakpoint

Implements VICI::Interp::InterpreterClient.

void ViciStub::dataReady ( NodeId  node )

virtual

this gets called when data is available on a display

Parameters

node	the node of the display object in the flowchart

Implements VICI::Interp::InterpreterClient.

void ViciStub::reportError ( Severity  sev, csr  msg  )

virtual

This gets called if an error is detected.

Parameters

msg	The text of the error message.
sev	The severity of the error

Implements VICI::Interp::InterpreterClient.

void ViciStub::setCursor ( ThreadId  tid, NodeId  node  )

virtual

this gets called as the shell steps through the script

Parameters

tid	the thread which changed to executing this node
node	the node that is currently being executed

Implements VICI::Interp::InterpreterClient.

void ViciStub::setFile ( int  state, csr  filename  )

virtual

this gets called when a monitored file changes state.

Parameters

state	this needs to be defined
filename	the name of the file that changed

Implements VICI::Interp::InterpreterClient.

void ViciStub::setValue ( csr  varName, csr  value  )

virtual

this gets called when a script variable has a change of value

Parameters

varName	the name of the variable that changed value
value	the new value of the variable

Implements VICI::Interp::InterpreterClient.

---

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

• libifstubs.h
• libifstubs.cpp