procedure_catalogue.h

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <expected>
#include <functional>
#include <nlohmann/json_fwd.hpp>
#include <string>
#include <string_view>
#include <variant>
#include <vector>
 
#include "node/device.h"
#include "node/device_manager.h"
#include "node/procedure.h"
#include "node/procedure_manager.h"
 
namespace mm::node {
 
 
struct ProcedureCatalogueEntry {
  ProcedureDescriptor descriptor;  
 
  std::function<bool(Device& device)> applies;
 
  std::function<std::expected<ProcedureBody, std::string>(const nlohmann::json& request)> makeBody;
};
 
const std::vector<ProcedureCatalogueEntry>& procedureCatalogue();
 
struct ProcedureListing {
  ProcedureDescriptor descriptor;
  ProcedureSnapshot snapshot;
};
void to_json(nlohmann::json& j, const ProcedureListing& listing);
 
std::expected<std::vector<ProcedureListing>, ProcedureError> listProcedures(
    DeviceManager& deviceManager, ProcedureManager& procedureManager, uint16_t devicePosition);
 
std::expected<ProcedureSnapshot, ProcedureError> procedureSnapshot(
    DeviceManager& deviceManager, ProcedureManager& procedureManager, uint16_t devicePosition,
    std::string_view name);
 
std::expected<ProcedureSnapshot, ProcedureError> startProcedure(DeviceManager& deviceManager,
                                                                ProcedureManager& procedureManager,
                                                                uint16_t devicePosition,
                                                                std::string_view name,
                                                                const nlohmann::json& request);
 
std::expected<void, ProcedureError> cancelProcedure(DeviceManager& deviceManager,
                                                    ProcedureManager& procedureManager,
                                                    uint16_t devicePosition, std::string_view name);
 
}  // namespace mm::node