Horizon
board_rules.hpp
1 #pragma once
2 #include "nlohmann/json_fwd.hpp"
3 #include "rule_clearance_copper.hpp"
4 #include "rule_clearance_copper_other.hpp"
5 #include "rule_clearance_silk_exp_copper.hpp"
6 #include "rule_diffpair.hpp"
7 #include "rule_hole_size.hpp"
8 #include "rule_parameters.hpp"
9 #include "rule_plane.hpp"
10 #include "rule_track_width.hpp"
11 #include "rule_via.hpp"
12 #include "rule_preflight_checks.hpp"
13 #include "rule_clearance_copper_keepout.hpp"
14 #include "rule_layer_pair.hpp"
15 #include "rule_clearance_same_net.hpp"
16 #include "rules/rules.hpp"
17 #include "util/uuid.hpp"
18 
19 namespace horizon {
20 using json = nlohmann::json;
21 
22 class BoardRules : public Rules {
23 public:
24  BoardRules();
25  BoardRules(const BoardRules &other);
26  void operator=(const BoardRules &other);
27 
28  void load_from_json(const json &j) override;
29  RulesCheckResult check(RuleID id, const class Board &b, class RulesCheckCache &cache,
30  check_status_cb_t status_cb) const;
31  void apply(RuleID id, class Board &b, class ViaPadstackProvider &vpp) const;
32  json serialize() const override;
33  std::set<RuleID> get_rule_ids() const override;
34  const Rule *get_rule(RuleID id) const override;
35  const Rule *get_rule(RuleID id, const UUID &uu) const override;
36  std::map<UUID, const Rule *> get_rules(RuleID id) const override;
37  void remove_rule(RuleID id, const UUID &uu) override;
38  Rule *add_rule(RuleID id) override;
39  void cleanup(const class Block *block);
40 
41  uint64_t get_default_track_width(const class Net *net, int layer) const;
42  const RuleClearanceCopper *get_clearance_copper(const Net *net_a, const Net *net_b, int layer) const;
43  const RuleClearanceCopperOther *get_clearance_copper_other(const Net *net, int layer) const;
44  const RuleDiffpair *get_diffpair(const NetClass *net_class, int layer) const;
45  const RuleClearanceCopperKeepout *get_clearance_copper_keepout(const Net *net, const KeepoutContour *contour) const;
46  const RuleClearanceSameNet *get_clearance_same_net(const Net *net, int layer) const;
47  uint64_t get_max_clearance() const;
48 
49  const RuleParameters *get_parameters() const;
50 
51  UUID get_via_padstack_uuid(const class Net *net) const;
52  const ParameterSet &get_via_parameter_set(const class Net *net) const;
53 
54  const PlaneSettings &get_plane_settings(const class Net *net, int layer) const;
55 
56  int get_layer_pair(const Net *net, int layer) const;
57 
58 private:
59  std::map<UUID, RuleHoleSize> rule_hole_size;
60  std::map<UUID, RuleTrackWidth> rule_track_width;
61  std::map<UUID, RuleClearanceCopper> rule_clearance_copper;
62  std::map<UUID, RuleVia> rule_via;
63  std::map<UUID, RuleClearanceCopperOther> rule_clearance_copper_other;
64  std::map<UUID, RulePlane> rule_plane;
65  std::map<UUID, RuleDiffpair> rule_diffpair;
66  std::map<UUID, RuleClearanceCopperKeepout> rule_clearance_copper_keepout;
67  std::map<UUID, RuleLayerPair> rule_layer_pair;
68  std::map<UUID, RuleClearanceSameNet> rule_clearance_same_net;
69 
70  std::vector<const RuleClearanceCopper *> rule_sorted_clearance_copper;
71  void update_sorted();
72 
73  RuleClearanceSilkscreenExposedCopper rule_clearance_silkscreen_exposed_copper;
74  RuleParameters rule_parameters;
75  RulePreflightChecks rule_preflight_checks;
76 
77  RulesCheckResult check_track_width(const class Board &b) const;
78  RulesCheckResult check_hole_size(const class Board &b) const;
79  RulesCheckResult check_clearance_copper(const class Board &b, class RulesCheckCache &cache,
80  check_status_cb_t status_cb) const;
81  RulesCheckResult check_clearance_copper_non_copper(const class Board &b, class RulesCheckCache &cache,
82  check_status_cb_t status_cb) const;
83  RulesCheckResult check_preflight(const class Board &b) const;
84  RulesCheckResult check_clearance_copper_keepout(const class Board &b, class RulesCheckCache &cache,
85  check_status_cb_t status_cb) const;
86  RulesCheckResult check_clearance_same_net(const class Board &b, class RulesCheckCache &cache,
87  check_status_cb_t status_cb) const;
88 };
89 } // namespace horizon
nlohmann::basic_json
a class to store JSON values
Definition: json.hpp:166
nlohmann::json
basic_json<> json
default JSON class
Definition: json_fwd.hpp:61
libzip::uint64_t
zip_uint64_t uint64_t
zip_uint64_t_t typedef.
Definition: zip.hpp:108