Learn Environment
Functions | Variables
FolderStructureConstants Namespace Reference

Contains constants related to the folder structure of the learn_environment package. More...

Functions

QString getPackagePath ()
 Retrieves the path of the package. More...
 

Variables

const QString CONVERTED_SCRIPT_PATH = "/converter/converted.py"
 Path to the converted script. More...
 
const QString RESET_ROBOT_SCRIPT_PATH = "/task_pool/reset_robot.py"
 Path to the reset robot script. More...
 
const QString TASK_DEFINITIONS_PATH = ":/task_pool/task_definitions.json"
 Path to the task definitions json. More...
 
const QString TOPIC_DEFINITIONS_PATH = ":/task_pool/topic_definitions.json"
 Path to the topic definitions json. More...
 
const QString DIFFICULTY_LEVELS_DEFINITION_PATH = ":/task_pool/difficulty_levels.json"
 
const QString SOLUTION_SCRIPTS_SOURCE_PATH = "/task_pool/solution_scripts"
 Path to the solution scripts source directory. More...
 
const QString EVALUATION_SCRIPTS_SOURCE_PATH = "/task_pool/evaluation_scripts"
 Path to the evaluation scripts source directory. More...
 
const QString USER_WORKSPACE = "/tasks"
 Path to the user workspace directory. Adjust it in devconatiner.json if changed. More...
 
const QString PACKAGE_NAME = "learn_environment"
 Name of the package. More...
 

Detailed Description

Contains constants related to the folder structure of the learn_environment package.

This namespace provides constants for various paths used within the learn_environment package, as well as a function to retrieve the package path.

Function Documentation

◆ getPackagePath()

QString FolderStructureConstants::getPackagePath ( )
inline

Retrieves the path of the package.

This function attempts to retrieve the path of the package using ROS package utilities. If an error occurs during retrieval, it logs a critical error message and returns an empty QString.

Returns
QString The path of the package or an empty QString if an error occurs.
Here is the caller graph for this function:

Variable Documentation

◆ CONVERTED_SCRIPT_PATH

FolderStructureConstants::CONVERTED_SCRIPT_PATH = "/converter/converted.py"
inline

Path to the converted script.

◆ DIFFICULTY_LEVELS_DEFINITION_PATH

const QString FolderStructureConstants::DIFFICULTY_LEVELS_DEFINITION_PATH = ":/task_pool/difficulty_levels.json"
inline

◆ EVALUATION_SCRIPTS_SOURCE_PATH

FolderStructureConstants::EVALUATION_SCRIPTS_SOURCE_PATH = "/task_pool/evaluation_scripts"
inline

Path to the evaluation scripts source directory.

◆ PACKAGE_NAME

FolderStructureConstants::PACKAGE_NAME = "learn_environment"
inline

Name of the package.

◆ RESET_ROBOT_SCRIPT_PATH

FolderStructureConstants::RESET_ROBOT_SCRIPT_PATH = "/task_pool/reset_robot.py"
inline

Path to the reset robot script.

◆ SOLUTION_SCRIPTS_SOURCE_PATH

FolderStructureConstants::SOLUTION_SCRIPTS_SOURCE_PATH = "/task_pool/solution_scripts"
inline

Path to the solution scripts source directory.

◆ TASK_DEFINITIONS_PATH

FolderStructureConstants::TASK_DEFINITIONS_PATH = ":/task_pool/task_definitions.json"
inline

Path to the task definitions json.

◆ TOPIC_DEFINITIONS_PATH

FolderStructureConstants::TOPIC_DEFINITIONS_PATH = ":/task_pool/topic_definitions.json"
inline

Path to the topic definitions json.

Path to the difficulty definitions json.

◆ USER_WORKSPACE

FolderStructureConstants::USER_WORKSPACE = "/tasks"
inline

Path to the user workspace directory. Adjust it in devconatiner.json if changed.