te::vm::core::VirtualMachine Class Referenceabstract

#include <VirtualMachine.h>

Inheritance diagram for te::vm::core::VirtualMachine:
te::vm::lua::VirtualMachine te::vm::python::VirtualMachine

Public Slots

virtual void execute ()=0
 execute Executes the script file previously set. More...
 
virtual void readline (QString msg)=0
 readline Reads a user input. More...
 
virtual void stop ()=0
 stop Stops the current running script. More...
 
virtual void write (const QString &str)=0
 write Writes the output coming from the Virtual Machine More...
 

Signals

void output (QString msg)
 output Signal emmited when the Virtual Machine receives a string. More...
 
void requestReadline ()
 Signal emmited when the Virtual Machine needs to execute a input operation. More...
 

Public Member Functions

virtual std::string getDescription () const =0
 Returns a brief description about the underlying Virtual Machine. More...
 
virtual std::string getName () const =0
 
virtual std::string getTitle () const =0
 Return the title of Virtual Machine: a name that can be used by applications to show in a GUI. More...
 
virtual std::string readline ()=0
 readline Method to be used by the language of the Virtual Machine when doing a input operation. More...
 
virtual void setFileName (QString file)=0
 setFileName Sets the file that will be used in the Virtual Machine. More...
 
 VirtualMachine ()
 VirtualMachine. More...
 
virtual ~VirtualMachine ()
 Virtual destructor. More...
 

Detailed Description

Definition at line 53 of file VirtualMachine.h.

Constructor & Destructor Documentation

te::vm::core::VirtualMachine::VirtualMachine ( )
inline

VirtualMachine.

Definition at line 61 of file VirtualMachine.h.

virtual te::vm::core::VirtualMachine::~VirtualMachine ( )
inlinevirtual

Virtual destructor.

Reimplemented in te::vm::python::VirtualMachine, and te::vm::lua::VirtualMachine.

Definition at line 68 of file VirtualMachine.h.

References slots.

Member Function Documentation

virtual void te::vm::core::VirtualMachine::execute ( )
pure virtualslot

execute Executes the script file previously set.

virtual std::string te::vm::core::VirtualMachine::getDescription ( ) const
pure virtual

Returns a brief description about the underlying Virtual Machine.

Implemented in te::vm::python::VirtualMachine, and te::vm::lua::VirtualMachine.

virtual std::string te::vm::core::VirtualMachine::getName ( ) const
pure virtual

the name of the Virtual Machine: it is also an identifier about the VM type.

Implemented in te::vm::python::VirtualMachine, and te::vm::lua::VirtualMachine.

virtual std::string te::vm::core::VirtualMachine::getTitle ( ) const
pure virtual

Return the title of Virtual Machine: a name that can be used by applications to show in a GUI.

Implemented in te::vm::python::VirtualMachine, and te::vm::lua::VirtualMachine.

void te::vm::core::VirtualMachine::output ( QString  msg)
signal

output Signal emmited when the Virtual Machine receives a string.

Parameters
msgString received from the Virtual Machine.
virtual std::string te::vm::core::VirtualMachine::readline ( )
pure virtual

readline Method to be used by the language of the Virtual Machine when doing a input operation.

Returns
A string containing the user input.

Implemented in te::vm::python::VirtualMachine, and te::vm::lua::VirtualMachine.

virtual void te::vm::core::VirtualMachine::readline ( QString  msg)
pure virtualslot

readline Reads a user input.

Parameters
msgString of the input.
void te::vm::core::VirtualMachine::requestReadline ( )
signal

Signal emmited when the Virtual Machine needs to execute a input operation.

virtual void te::vm::core::VirtualMachine::setFileName ( QString  file)
pure virtual

setFileName Sets the file that will be used in the Virtual Machine.

Parameters
fileThe full path filename.

Implemented in te::vm::python::VirtualMachine, and te::vm::lua::VirtualMachine.

virtual void te::vm::core::VirtualMachine::stop ( )
pure virtualslot

stop Stops the current running script.

virtual void te::vm::core::VirtualMachine::write ( const QString &  str)
pure virtualslot

write Writes the output coming from the Virtual Machine

Parameters
strThe out put string received.

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