Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members  

SIGEL_Robot::SIG_LanguageParameters Class Reference

This class describes the possibilities and limitations of the robot control language. More...

#include <SIG_LanguageParameters.h>

List of all members.

Public Methods

 SIG_LanguageParameters (void)
 Standard constructor. More...

 SIG_LanguageParameters (QTextStream & tx, bool nir = false)
 Reads the contents of the object from a stream, whose data may be originating from a file or from a network. More...

 ~SIG_LanguageParameters (void)
 Destructor. More...

void addCommand (QString name, SIG_CommandParameters *cmdP)
 Adds a command to the dictionary. More...

void removeCommand ( QString name )
 Removes a command from the dictionary. More...

bool hasCommand (QString name) const
 Query whether a command is allowed. More...

SIG_CommandParametersgetCommand (QString name) const
 Getting the object describing the command properties. More...

void setRegisterWidth (int width)
 Sets the width of the memory cells within the robots control unit. More...

int getRegisterWidth (void) const
 Provides the width of the robot's memory cells. More...

void setMemorySize (int amount)
 This sets the number of registers. More...

int getMemorySize (void) const
 How many registers are there? More...

void setMaximalDelayTime ( int amount )
 Sets the maximal time that a delay may take place. More...

int getMaximalDelayTime ( void ) const
 Gets the maximal time that a delay may take place. More...

void writeToFileTransfer (QTextStream & tx) const
 Writes the object's data to a stream. More...


Private Attributes

QDict<SIG_CommandParametersallowedCommands
 A dictionary of the commands allowed in the control language of the particular robot. More...

int bitsPerRegister
 The width of the registers of the robot's memory. More...

int memSize
 The number of registers of the robot. More...

int maximalDelayTime


Detailed Description

This class describes the possibilities and limitations of the robot control language.

For each allowed command it contains an instance of SIG_CommandParam describing the capabilities of the command.

Definition at line 19 of file SIGEL_Robot/SIG_LanguageParameters.h.


Constructor & Destructor Documentation

SIGEL_Robot::SIG_LanguageParameters::SIG_LanguageParameters ( void )
 

Standard constructor.

Empty dictionary and 32-bit-registers.

Definition at line 6 of file SIGEL_Robot/SIG_LanguageParameters.cpp.

SIGEL_Robot::SIG_LanguageParameters::SIG_LanguageParameters ( QTextStream & tx,
bool nir = false )
 

Reads the contents of the object from a stream, whose data may be originating from a file or from a network.

Definition at line 75 of file SIGEL_Robot/SIG_LanguageParameters.cpp.

SIGEL_Robot::SIG_LanguageParameters::~SIG_LanguageParameters ( void )
 

Destructor.

Definition at line 101 of file SIGEL_Robot/SIG_LanguageParameters.cpp.


Member Function Documentation

void SIGEL_Robot::SIG_LanguageParameters::addCommand ( QString name,
SIG_CommandParameters * cmdP )
 

Adds a command to the dictionary.

Definition at line 106 of file SIGEL_Robot/SIG_LanguageParameters.cpp.

SIG_CommandParameters * SIGEL_Robot::SIG_LanguageParameters::getCommand ( QString name ) const
 

Getting the object describing the command properties.

Definition at line 121 of file SIGEL_Robot/SIG_LanguageParameters.cpp.

Referenced by SIGEL_MasterGUI::SIG_LanguageParameters::SIG_LanguageParameters(), and SIGEL_Simulation::SIG_Interpreter::interprete().

int SIGEL_Robot::SIG_LanguageParameters::getMaximalDelayTime ( void ) const
 

Gets the maximal time that a delay may take place.

Definition at line 151 of file SIGEL_Robot/SIG_LanguageParameters.cpp.

Referenced by SIGEL_Simulation::SIG_Interpreter::interprete().

int SIGEL_Robot::SIG_LanguageParameters::getMemorySize ( void ) const
 

How many registers are there?

Definition at line 141 of file SIGEL_Robot/SIG_LanguageParameters.cpp.

Referenced by SIGEL_Simulation::SIG_Interpreter::SIG_Interpreter(), and SIGEL_MasterGUI::SIG_LanguageParameters::SIG_LanguageParameters().

int SIGEL_Robot::SIG_LanguageParameters::getRegisterWidth ( void ) const
 

Provides the width of the robot's memory cells.

Definition at line 131 of file SIGEL_Robot/SIG_LanguageParameters.cpp.

Referenced by SIGEL_Simulation::SIG_Interpreter::SIG_Interpreter(), and SIGEL_MasterGUI::SIG_LanguageParameters::SIG_LanguageParameters().

bool SIGEL_Robot::SIG_LanguageParameters::hasCommand ( QString name ) const
 

Query whether a command is allowed.

Definition at line 116 of file SIGEL_Robot/SIG_LanguageParameters.cpp.

Referenced by SIGEL_MasterGUI::SIG_LanguageParameters::SIG_LanguageParameters(), SIGEL_Simulation::SIG_Interpreter::interprete(), and SIGEL_Program::SIG_ProgramLine::randomRobotinstruction().

void SIGEL_Robot::SIG_LanguageParameters::removeCommand ( QString name )
 

Removes a command from the dictionary.

Definition at line 111 of file SIGEL_Robot/SIG_LanguageParameters.cpp.

void SIGEL_Robot::SIG_LanguageParameters::setMaximalDelayTime ( int amount )
 

Sets the maximal time that a delay may take place.

Definition at line 146 of file SIGEL_Robot/SIG_LanguageParameters.cpp.

void SIGEL_Robot::SIG_LanguageParameters::setMemorySize ( int amount )
 

This sets the number of registers.

Definition at line 136 of file SIGEL_Robot/SIG_LanguageParameters.cpp.

void SIGEL_Robot::SIG_LanguageParameters::setRegisterWidth ( int width )
 

Sets the width of the memory cells within the robots control unit.

Definition at line 126 of file SIGEL_Robot/SIG_LanguageParameters.cpp.

void SIGEL_Robot::SIG_LanguageParameters::writeToFileTransfer ( QTextStream & tx ) const
 

Writes the object's data to a stream.

The stream may be connected to a file or to a network or to whatever.

Definition at line 156 of file SIGEL_Robot/SIG_LanguageParameters.cpp.


Member Data Documentation

QDict< SIG_CommandParameters > SIGEL_Robot::SIG_LanguageParameters::allowedCommands [private]
 

A dictionary of the commands allowed in the control language of the particular robot.

Definition at line 25 of file SIGEL_Robot/SIG_LanguageParameters.h.

int SIGEL_Robot::SIG_LanguageParameters::bitsPerRegister [private]
 

The width of the registers of the robot's memory.

Definition at line 30 of file SIGEL_Robot/SIG_LanguageParameters.h.

int SIGEL_Robot::SIG_LanguageParameters::maximalDelayTime [private]
 

Definition at line 40 of file SIGEL_Robot/SIG_LanguageParameters.h.

int SIGEL_Robot::SIG_LanguageParameters::memSize [private]
 

The number of registers of the robot.

Definition at line 35 of file SIGEL_Robot/SIG_LanguageParameters.h.


The documentation for this class was generated from the following files:
Generated at Mon Sep 3 01:32:51 2001 for PG 368 - SIGEL by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000