OdbDesign
OdbDesign ODB++ Parser - C++ library, gRPC/REST server, CLI, tests
 
Loading...
Searching...
No Matches
DesignsController.h
Go to the documentation of this file.
1#pragma once
2
4
5#include <memory>
6#include <optional>
7#include <string>
8
10{
11 class Design;
12}
13
14namespace Odb::App::Server
15{
17 {
18 public:
19
21
22 // Inherited via RouteController
23 void register_routes() override;
24
25 constexpr inline static const char* kszIncludeFileArchiveQueryParamName = "include_filearchive";
26
27 private:
28
29 // Fetches the ProductModel Design for a design name, translating failures
30 // into HTTP responses: corrupt/unloadable archive (propagated from
31 // DesignCache::LoadFileArchive via GetDesign) -> engaged optional holding
32 // INTERNAL/500; design not found -> engaged optional holding NOT_FOUND/404.
33 // On success the optional is disengaged and pDesign is populated.
34 std::optional<crow::response> TryGetDesign(
35 const std::string& designName,
36 std::shared_ptr<Odb::Lib::ProductModel::Design>& pDesign) const;
37
38 crow::response designs_list_route_handler(const crow::request& req);
39 crow::response design_route_handler(std::string designName, const crow::request& req);
40
41 // REST twin of the gRPC RequestLoadDesign RPC: kicks a background load
42 // (202 Accepted) and returns the load status in the body.
43 crow::response designs_load_route_handler(std::string designName, const crow::request& req);
44
45 crow::response designs_components_route_handler(std::string designName, const crow::request& req);
46 crow::response designs_component_route_handler(std::string designName, std::string refDes, const crow::request& req);
47
48 crow::response designs_nets_route_handler(std::string designName, const crow::request& req);
49 crow::response designs_net_route_handler(std::string designName, std::string netName, const crow::request& req);
50
51 crow::response designs_parts_route_handler(std::string designName, const crow::request& req);
52 crow::response designs_part_route_handler(std::string designName, std::string partName, const crow::request& req);
53
54 crow::response designs_packages_route_handler(std::string designName, const crow::request& req);
55 crow::response designs_package_route_handler(std::string designName, std::string packageName, const crow::request& req);
56
57 };
58}
static constexpr const char * kszIncludeFileArchiveQueryParamName