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