F1/10 Yellowtails Main class Documentation

main.py

This is documentation for the main class that holds all of our logic for our solution.

class main.ImageDialog

closeROS

This function is used when the user closes out of GUI, this method will make sure Robot Oberating Systm and Screen will close.

emergencyBttnAction

Holds the logic to stop the car if the user presses stop Car button.

generateLaunchVars

Return the launch string to use properly in the launch file.

loadConfiguration

Takes in a configuration file as a yaml, and parses the information to populate the GUI with the configurations options.

loadData(dictionary, from_savedData)

This function lets the user load in any profile saved. There is a check to make sure that you can only load in valid profiles.

Parameters:

dictionary This what is the dictionary that is passed in that is holding all of the information.

from_savedData This is a boolean value that will tell if it loading in from a saved value or just the previous profile.

loadPreviousOptions

Loads the previous option from the klepto saved file.

loadProfile

Loads a saved profile that the user would like to see back in the GUI.

saveProfile

Holds the logic to save all of the selected configuration options into a profile.

saveSelectedOptions(name, moduleNum)

When the user selects all of the buttons they want to, they can save that option to use later on if they end up changing it.

Parameters:

name This is the name of the button that was selected.

moduleNum This is where the button is stored in the GUI.

showHelp

This method hows helpful information to the user when you mouse over anything on our GUI.

startCarBttnAction

Holds the logic for when the user wants to start the car.This method hows helpful information to the user when you mouse over anything on our GUI.

startSimBttnAction

Holds the logic for when the user wants to start the simulation of the car.