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 "rule_shorted_pads.hpp"
17 #include "rules/rules.hpp"
18 #include "util/uuid.hpp"
19 
20 namespace horizon {
21 using json = nlohmann::json;
22 
23 class BoardRules : public Rules {
24 public:
25  BoardRules();
26  BoardRules(const BoardRules &other);
27  void operator=(const BoardRules &other);
28 
29  void load_from_json(const json &j) override;
30  RulesCheckResult check(RuleID id, const class Board &b, class RulesCheckCache &cache,
31  check_status_cb_t status_cb) const;
32  void apply(RuleID id, class Board &b, class IPool &pool) const;
33  json serialize() const override;
34  std::vector<RuleID> get_rule_ids() const override;
35  const Rule &get_rule(RuleID id) const override;
36  const Rule &get_rule(RuleID id, const UUID &uu) const override;
37  std::map<UUID, const Rule *> get_rules(RuleID id) const override;
38  void remove_rule(RuleID id, const UUID &uu) override;
39  Rule &add_rule(RuleID id) override;
40  void cleanup(const class Block *block);
41 
42  uint64_t get_default_track_width(const class Net *net, int layer) const;
43  const RuleClearanceCopper *get_clearance_copper(const Net *net_a, const Net *net_b, int layer) const;
44  const RuleClearanceCopperOther *get_clearance_copper_other(const Net *net, int layer) const;
45  const RuleDiffpair *get_diffpair(const NetClass *net_class, int layer) const;
46  const RuleClearanceCopperKeepout *get_clearance_copper_keepout(const Net *net, const KeepoutContour *contour) const;
47  const RuleClearanceSameNet *get_clearance_same_net(const Net *net, int layer) const;
48  uint64_t get_max_clearance() const;
49 
50  const RuleParameters *get_parameters() const;
51 
52  UUID get_via_padstack_uuid(const class Net *net) const;
53  const ParameterSet &get_via_parameter_set(const class Net *net) const;
54 
55  const PlaneSettings &get_plane_settings(const class Net *net, int layer) const;
56 
57  int get_layer_pair(const Net *net, int layer) const;
58 
59  json export_rules(const class RulesExportInfo &export_info, const Board &brd) const;
60  void import_rules(const json &j, const RuleImportMap &import_map) override;
61 
62  bool can_export() const override
63  {
64  return true;
65  }
66 
67 private:
68  std::map<UUID, RuleHoleSize> rule_hole_size;
69  std::map<UUID, RuleTrackWidth> rule_track_width;
70  std::map<UUID, RuleClearanceCopper> rule_clearance_copper;
71  std::map<UUID, RuleVia> rule_via;
72  std::map<UUID, RuleClearanceCopperOther> rule_clearance_copper_other;
73  std::map<UUID, RulePlane> rule_plane;
74  std::map<UUID, RuleDiffpair> rule_diffpair;
75  std::map<UUID, RuleClearanceCopperKeepout> rule_clearance_copper_keepout;
76  std::map<UUID, RuleLayerPair> rule_layer_pair;
77  std::map<UUID, RuleClearanceSameNet> rule_clearance_same_net;
78  std::map<UUID, RuleShortedPads> rule_shorted_pads;
79 
80  std::vector<const RuleClearanceCopper *> rule_sorted_clearance_copper;
81  void update_sorted();
82 
83  RuleClearanceSilkscreenExposedCopper rule_clearance_silkscreen_exposed_copper;
84  RuleParameters rule_parameters;
85  RulePreflightChecks rule_preflight_checks;
86 
87  RulesCheckResult check_track_width(const class Board &b) const;
88  RulesCheckResult check_hole_size(const class Board &b) const;
89  RulesCheckResult check_clearance_copper(const class Board &b, class RulesCheckCache &cache,
90  check_status_cb_t status_cb) const;
91  RulesCheckResult check_clearance_copper_non_copper(const class Board &b, class RulesCheckCache &cache,
92  check_status_cb_t status_cb) const;
93  RulesCheckResult check_clearance_silkscreen_exposed_copper(const class Board &b, class RulesCheckCache &cache,
94  check_status_cb_t status_cb) const;
95  RulesCheckResult check_preflight(const class Board &b) const;
96  RulesCheckResult check_clearance_copper_keepout(const class Board &b, class RulesCheckCache &cache,
97  check_status_cb_t status_cb) const;
98  RulesCheckResult check_clearance_same_net(const class Board &b, class RulesCheckCache &cache,
99  check_status_cb_t status_cb) const;
100  RulesCheckResult check_plane_priorities(const class Board &b) const;
101 
102  json serialize_or_export(Rule::SerializeMode mode) const;
103 };
104 } // namespace horizon
A block is one level of hierarchy in the netlist.
Definition: block.hpp:29
Definition: board_rules.hpp:23
Definition: board.hpp:43
Definition: ipool.hpp:14
Definition: keepout.hpp:26
Definition: net_class.hpp:8
Definition: net.hpp:11
Definition: plane.hpp:9
Definition: rule_clearance_copper_keepout.hpp:8
Definition: rule_clearance_copper_other.hpp:7
Definition: rule_clearance_copper.hpp:7
Definition: rule_clearance_same_net.hpp:7
Definition: rule_clearance_silk_exp_copper.hpp:6
Definition: rule_diffpair.hpp:7
Definition: rule.hpp:34
Definition: rule_parameters.hpp:6
Definition: rule_preflight_checks.hpp:6
Definition: rule.hpp:54
Definition: cache.hpp:54
Definition: rules.hpp:36
Definition: rules_import_export.hpp:18
Definition: rules.hpp:51
This class encapsulates a UUID and allows it to be uses as a value type.
Definition: uuid.hpp:16
a class to store JSON values
Definition: json.hpp:177
zip_uint64_t uint64_t
zip_uint64_t_t typedef.
Definition: zip.hpp:108
basic_json<> json
default JSON class
Definition: json_fwd.hpp:62