docs/auto__tuning__setup_8h_source.html

#pragma once


#include <filesystem>

#include <optional>


#include "auto_tuning/client.h"

#include "auto_tuning/process.h"

#include "auto_tuning/status.h"

#include "config.h"


namespace mm {


struct AutoTuningStartup {

  auto_tuning::Status status;

  std::optional<auto_tuning::Client> client;

};


auto_tuning::ProcessOptions buildAutoTuningOptions(const AutoTuningConfig& config,

                                                   const std::filesystem::path& logFile);


AutoTuningStartup startAutoTuning(auto_tuning::Process& process, bool enabled);


void stopAutoTuning(auto_tuning::Process& process);


}  // namespace mm

mm::auto_tuning::Process
Starts the auto-tuning executable and keeps it running for the process lifetime.
Definition process.h:73

client.h
Calls made to the running auto-tuning process.

config.h

enabled
enabled
Definition config.h:216

mm
Definition auto_tuning_setup.cc:10

mm::buildAutoTuningOptions
auto_tuning::ProcessOptions buildAutoTuningOptions(const AutoTuningConfig &config, const std::filesystem::path &logFile)
Resolves what to start, and where its output goes.
Definition auto_tuning_setup.cc:12

mm::stopAutoTuning
void stopAutoTuning(auto_tuning::Process &process)
Stops the child and logs how it ended.
Definition auto_tuning_setup.cc:56

mm::startAutoTuning
AutoTuningStartup startAutoTuning(auto_tuning::Process &process, bool enabled)
Starts the child unless the configuration or the filesystem says otherwise, and logs it.
Definition auto_tuning_setup.cc:24

process.h
The auto-tuning executable, started and supervised as a child process.

status.h
What Motion Master knows about its auto-tuning process, as a client can read it.

AutoTuningConfig
"autoTuning" block — the auto-tuning child process.
Definition config.h:145

mm::AutoTuningStartup
The startup outcome, as the HTTP layer needs it.
Definition auto_tuning_setup.h:23

mm::AutoTuningStartup::status
auto_tuning::Status status
Definition auto_tuning_setup.h:27

mm::AutoTuningStartup::client
std::optional< auto_tuning::Client > client
Definition auto_tuning_setup.h:30

mm::auto_tuning::ProcessOptions
What to start, and where.
Definition process.h:42

mm::auto_tuning::Status
The state of the auto-tuning process, reported by GET /api/auto-tuning.
Definition status.h:22