uppaal2jetracer package
Subpackages
- uppaal2jetracer.controller package
- Submodules
- uppaal2jetracer.controller.executor module
Executor
Executor.stop()
Executor.visit_arraydecl()
Executor.visit_arrayref()
Executor.visit_assignment()
Executor.visit_binaryop()
Executor.visit_compound()
Executor.visit_compoundliteral()
Executor.visit_constant()
Executor.visit_decl()
Executor.visit_decllist()
Executor.visit_emptystatement()
Executor.visit_exprlist()
Executor.visit_fileast()
Executor.visit_funccall()
Executor.visit_funcdecl()
Executor.visit_funcdef()
Executor.visit_id()
Executor.visit_identifiertype()
Executor.visit_initlist()
Executor.visit_namedinitializer()
Executor.visit_paramlist()
Executor.visit_rangedecl()
Executor.visit_return()
Executor.visit_struct()
Executor.visit_structref()
Executor.visit_typedecl()
Executor.visit_typedef()
Executor.visit_typename()
Executor.visit_unaryop()
HardwareCallError
- uppaal2jetracer.controller.hardware_command_system module
FreeAheadCommand
HardwareCommand
HardwareCommandError
HardwareCommandHandler
HardwareCommandHandler.FREE_AHEAD_COMMAND_NAME
HardwareCommandHandler.POTENTIAL_COLLISION_COMMAND_NAME
HardwareCommandHandler.SET_SPEED_COMMAND_NAME
HardwareCommandHandler.TURN_COMMAND_NAME
HardwareCommandHandler.get_command()
HardwareCommandHandler.has_command()
HardwareCommandHandler.run_command()
HardwareCommandHandler.stop()
HardwareCommandResult
HardwareCommandResultType
HardwareError
InvalidParamTypeError
InvalidParamValueError
InvalidParamsAmountError
JRHardwareCommand
PotentialCollisionCommand
SetSpeedCommand
TurnCommand
- uppaal2jetracer.controller.hardware_controller module
- uppaal2jetracer.controller.uppaal_controller module
- Module contents
- uppaal2jetracer.jetracerros2 package
- Subpackages
- uppaal2jetracer.jetracerros2.jetracerros2 package
- Submodules
- uppaal2jetracer.jetracerros2.jetracerros2.collision_controller module
- uppaal2jetracer.jetracerros2.jetracerros2.jetracer_controller module
- uppaal2jetracer.jetracerros2.jetracerros2.laser_filter module
- uppaal2jetracer.jetracerros2.jetracerros2.servo_motor_controller module
- uppaal2jetracer.jetracerros2.jetracerros2.speed_controller module
- uppaal2jetracer.jetracerros2.jetracerros2.turn_controller module
- Module contents
- uppaal2jetracer.jetracerros2.jetracerros2 package
- Submodules
- uppaal2jetracer.jetracerros2.setup module
- Module contents
- Subpackages
- uppaal2jetracer.parser package
- uppaal2jetracer.uppaalmodel package
- Submodules
- uppaal2jetracer.uppaalmodel.elements module
- uppaal2jetracer.uppaalmodel.frame module
- uppaal2jetracer.uppaalmodel.system module
- uppaal2jetracer.uppaalmodel.variable module
- Module contents
- uppaal2jetracer.versioncontrol package
- Submodules
- uppaal2jetracer.versioncontrol.config module
- uppaal2jetracer.versioncontrol.database module
- uppaal2jetracer.versioncontrol.models module
- uppaal2jetracer.versioncontrol.versioncontrol module
- Module contents
Submodules
uppaal2jetracer.cli module
Command line interface
This file contains all functionality required to run uppaal2jetracer in the command line.
The CLI accepts the following commands:
help: Get list of available commands.
parse: Parse an uppaal system to an executable model.
prj: Access projects which contain versions of parsed uppaal systems.
quit: Quit uppaal2jetracer.
run: Run a parsed uppaal system.
ver: Access saved versions of parsed uppaal systems.
This file can be imported as a module and contains the following classes:
Uppaal2JetRacer: Starts uppaal2jetracer.
CLI: Handles CLI input.
- class CLI(version_manager: VersionManager, project_manager: ProjectManager)[source]
Bases:
CommandHandler
A CommandHandler that handles CLI commands.
uppaal2jetracer.command_system module
Command system
This file provides all interfaces required to access uppaal2jetracer commands.
This file can be imported as a module and contains the following classes:
CommandHandler: Interface for handling uppaal2jetracer commands.
CommandResult: Result of uppaal2jetracer commands.
CommandResultType: Result type of uppaal2jetracer commands.
Command: Interface for all uppaal2jetracer commands.
ParseCommand: Command for parsing UPPAAL automata.
ParseRunCommand: Command for parsing and running an UPPAAL system.
ProjectCommand: Command for managing projects.
QuitCommand: Command for quitting uppaal2jetracer.
RunCommand: Command for running a parsed UPPAAL system.
VersionCommand: Command for managing versions of parsed automata.
- class Command[source]
Bases:
ABC
Abstract base class for all u2j-commands.
- abstract execute(args: List[str]) CommandResult [source]
Executes the command.
- Parameters:
args (List[str]) – Arguments passed to the command.
- Returns:
Result of the command.
- Return type:
- property help_message: str
Returns the help message for the command.
- Returns:
The help message.
- Return type:
str
- property loggers: List[str]
Returns the debugger of the command.
- Returns:
The debugger.
- Return type:
str
- class CommandHandler(version_manager: VersionManager, project_manager: ProjectManager)[source]
Bases:
ABC
Abstract base class for all command handlers.
- Variables:
_project_manager (ProjectManager) – Manages all projects.
_version_manager (VersionManager) – Manages all versions in a project.
- static activate_debug(loggers: List[str])[source]
Activates debug mode for given loggers. :param loggers: List of logger names. :type loggers: List[str]
- property parse_command_name: str
Returns the name of the parse command.
- property parse_run_command_name: str
Returns the name of the parse and run command.
- property project_command_name: str
Returns the name of the project command.
- property quit_command_name: str
Returns the name of the quit command.
- property run_command_name: str
Returns the name of the run command.
- property version_command_name: str
Returns the name of the version command.
- class CommandResult(message: str, result_type: CommandResultType, payload: List[ResponseObject] = None)[source]
Bases:
object
A class capsuling the result of a command execution.
- Variables:
_message (str) – The return message of the command.
_payload (List[ResponseObject]) – Response payload of the command.
_result_type (CommandResultType) – The type of the result. Either “success” or “failure”.
- property message: str
The return message of the command.
- property payload: List[ResponseObject]
The payload of the command.
- property result_type: CommandResultType
The type of the result. Either “success” or “failure”.
- class CommandResultType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
Enum
An enum class with result types of a command.
- FAILURE = 1
- SUCCESS = 0
- class ParseCommand(version_manager: VersionManager)[source]
Bases:
Command
A command to parse an UPPAAL system to an executable UPPAAL model.
- execute(args: List[str]) CommandResult [source]
Executes the command.
- Parameters:
args (List[str]) – Arguments passed to the command.
- Returns:
Result of the command.
- Return type:
- class ParseRunCommand(parse_command: ParseCommand, run_command: RunCommand)[source]
Bases:
Command
A command to parse and execute an UPPAAL system.
- execute(args: List[str]) CommandResult [source]
Executes the command.
- Parameters:
args (List[str]) – Arguments passed to the command.
- Returns:
Result of the command.
- Return type:
- class ProjectCommand(project_manager: ProjectManager)[source]
Bases:
Command
A command for managing projects.
- execute(args: List[str]) CommandResult [source]
Executes the command.
- Parameters:
args (List[str]) – Arguments passed to the command.
- Returns:
Result of the command.
- Return type:
- class QuitCommand(command_handler: CommandHandler)[source]
Bases:
Command
A command to quit uppaal2jetracer.
- execute(args: List[str]) CommandResult [source]
Executes the command.
- Parameters:
args (List[str]) – Arguments passed to the command.
- Returns:
Result of the command.
- Return type:
- class RunCommand[source]
Bases:
Command
A command to run an UPPAAL system.
- execute(args: List[str]) CommandResult [source]
Executes the command.
- Parameters:
args (List[str]) – Arguments passed to the command.
- Returns:
Result of the command.
- Return type:
- class VersionCommand(version_manager: VersionManager)[source]
Bases:
Command
A command to manage versions of parsed UPPAAL systems.
- execute(args: List[str]) CommandResult [source]
Executes the command.
- Parameters:
args (List[str]) – Arguments passed to the command.
- Returns:
Result of the command.
- Return type:
uppaal2jetracer.httphandler module
HTTP
This file tests the capabilities of an HTTP python client.
This file can be imported as a module and contains the following classes:
HTTPHandler: The main handler for the HTTP requests.