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