Autonomy Software C++ 24.5.1
Welcome to the Autonomy Software repository of the Mars Rover Design Team (MRDT) at Missouri University of Science and Technology (Missouri S&T)! API reference contains the source code and other resources for the development of the autonomy software for our Mars rover. The Autonomy Software project aims to compete in the University Rover Challenge (URC) by demonstrating advanced autonomous capabilities and robust navigation algorithms.
Loading...
Searching...
No Matches
examples Directory Reference
Directory dependency graph for examples:
examples

Directories

 opencv
 
 threading
 

Detailed Description

Examples Directory

The Examples directory is intended to store C++ files that provide example code snippets, demos, or sample implementations related to the Rover project. This directory focuses on showcasing usage scenarios, best practices, or specific functionalities of the project.

Guidelines

The following are the guidelines for organizing files within the Examples directory:

  1. All example files must #include the ExampleChecker.h file. This enables main.cpp to automatically run your example when it's included.
  2. All example files must implement a void RunExample() function that will contain the higher level code for running the example.
  3. Each C++ file should contain a self-contained example or demo related to a specific aspect or functionality of the Rover project.
  4. Use descriptive names for the files that reflect the purpose or functionality of the example.
  5. Ensure that the files are properly documented with comments explaining the example, its purpose, input/output specifications, and any relevant details.
  6. Include a README file in the Examples directory to provide an overview of the available examples, instructions for running them, and any additional information.

Usage

Here are some common types of files you might find in the Examples directory:

  1. Basic functionality: Files that demonstrate the basic functionalities and usage patterns of the Rover project.
  2. Integration examples: Files that showcase the integration between different components or modules of the Rover project.
  3. Sensor usage: Files that provide examples of how to interact with sensors or external devices used in the Rover project.
  4. Algorithm implementations: Files that showcase the implementation of specific algorithms or techniques relevant to the Rover project.
  5. Case studies: Files that present real-world scenarios or case studies demonstrating the application of the Rover project in practical situations.

Organize the example files in a way that makes it easy to navigate and explore different aspects of the Rover project.

Remember to update this README file whenever new example files are added to the directory, providing a brief summary of each example's purpose and functionality.

Use the examples as a reference and learning resource, helping developers understand and leverage the capabilities of the Rover project effectively.

Happy coding and exploring the examples!