#include <MeanderScanMethodScript.h>

Inheritance diagram for sf::ipj::AcquireScript:

Collaboration diagram for sf::ipj::AcquireScript:

Public Types
enum	ECommand { acOFF = 0 , acFREE_RUN , acACQUIRE , acSAVE_SET , acSAVE }
	Available command to execute. More...

enum	EState { asERROR = -1 , asOFF = 0 , asWAITING , asRUNNING , asACQUIRING , asSTOPPED }
	Stages for acquiring data. More...

Public Member Functions
	AcquireScript ()
	Constructor that needs a compiler or derived class.

bool	Execute (ECommand ac)
	Execute a given acquisition ac command.

EState	GetState ()
	Gets the current state.

Public Member Functions inherited from sf::ScriptLink
	ScriptLink (ScriptInterpreter *compiler, bool owner)
	Constructor passing a script interpreter.

virtual	~ScriptLink ()
	Destructor stopping any running script. Deletes the interpreter when it is set to be the owner.

void	setOutputStream (std::ostream *os)
	Sets and enables debugging output stream.

ScriptInterpreter &	getInterpreter ()
	Gets the reference to the interpreter of this instance.

const ScriptInterpreter &	getInterpreter () const
	Gets the const reference to the interpreter of this instance.

bool	setScript (const std::string &script)
	Stops and flushes a running script and sets a new script.

std::string	getScript () const
	Gets the script text.

bool	initialize ()
	Initializes the script with a execution of the interpreter sf::ScriptInterpreter::emInit .

bool	compile ()
	Compiles the set script using the set interpreter.

void	abort ()
	Stops the script when it is running.

void	flush ()
	Flushes the interpreter script allowing recompiling the script.

void	start ()
	Starts a script in the background depending on the background flag.

void	execute ()
	Executes the script according to the settings.

bool	run (bool bk_gnd)
	Compiles, initializes and runs or starts the script in the background.

bool	process ()
	Executes a background processing script.

std::string	getFile () const
	Gets the filepath of the loaded script.

bool	setFile (const std::string &path)
	Sets the script filepath and loads the script. When the path is set the file is stored at destruction of the class.

bool	reloadFile ()
	Reloads the script from the current set file.

bool	saveFile ()
	Saves the file when the script was set using a file.

void	setName (const std::string &name)
	Sets the descriptive name of the script.

std::string	getName () const
	Gets the descriptive name of the script.

bool	isDirty () const
	Gets dirty flag on the script which means it has changed.

void	setBackground (bool background=true)
	Sets the script to be executed in the background.

bool	isBackground () const
	Gets the background execution flag.

Member Enumeration Documentation

◆ ECommand

enum sf::ipj::AcquireScript::ECommand

Available command to execute.

Enumerator
acOFF	Set acquisition so that no data is generated.
acFREE_RUN	Set acquisition into running mode for no data storage.
acACQUIRE	Enable the devices to acquire data.
acSAVE_SET	Saves current settings and system parameters as they are right now. Also stops the acquisition.
acSAVE	Same as above but also save the acquired data. When settings are al read saved yet settings at the moment of the call with SAVE_SET are stored instead.

◆ EState

enum sf::ipj::AcquireScript::EState

Stages for acquiring data.

Enumerator
asERROR	A command resulted in an error state.
asOFF	Acquisition device is off and generates no data.
asWAITING	Waiting for command to finish.
asRUNNING	The acquisition device is acquiring data which cannot be stored.
asACQUIRING	The acquisition device is acquiring data which can be stored.
asSTOPPED	The acquisition device has stopped and data can or is being saved.

Constructor & Destructor Documentation

◆ AcquireScript()

sf::ipj::AcquireScript::AcquireScript ( )

Constructor that needs a compiler or derived class.

Member Function Documentation

◆ Execute()

bool sf::ipj::AcquireScript::Execute ( ECommand ac )

Execute a given acquisition ac command.

◆ GetState()

EState sf::ipj::AcquireScript::GetState ( )

Gets the current state.

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

MeanderScanMethodScript.h

Public Types

Public Member Functions