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 "rules/rules.hpp"
15 #include "util/uuid.hpp"
16 
17 namespace horizon {
18 using json = nlohmann::json;
19 
20 class BoardRules : public Rules {
21 public:
22  BoardRules();
23 
24  void load_from_json(const json &j);
25  RulesCheckResult check(RuleID id, const class Board *b, class RulesCheckCache &cache, check_status_cb_t status_cb);
26  void apply(RuleID id, class Board *b, class ViaPadstackProvider &vpp);
27  json serialize() const;
28  std::set<RuleID> get_rule_ids() const;
29  Rule *get_rule(RuleID id);
30  Rule *get_rule(RuleID id, const UUID &uu);
31  std::map<UUID, Rule *> get_rules(RuleID id);
32  void remove_rule(RuleID id, const UUID &uu);
33  Rule *add_rule(RuleID id);
34  void cleanup(const class Block *block);
35 
36  uint64_t get_default_track_width(class Net *net, int layer);
37  const RuleClearanceCopper *get_clearance_copper(Net *net_a, Net *net_b, int layer);
38  const RuleClearanceCopperOther *get_clearance_copper_other(Net *net, int layer);
39  const RuleDiffpair *get_diffpair(NetClass *net_class, int layer);
40  const RuleClearanceCopperKeepout *get_clearance_copper_keepout(Net *net, const KeepoutContour *contour);
41  uint64_t get_max_clearance();
42 
43  const RuleParameters *get_parameters();
44 
45  UUID get_via_padstack_uuid(class Net *net);
46  const ParameterSet &get_via_parameter_set(class Net *net);
47 
48  const PlaneSettings &get_plane_settings(class Net *net, int layer);
49 
50 private:
51  std::map<UUID, RuleHoleSize> rule_hole_size;
52  std::map<UUID, RuleTrackWidth> rule_track_width;
53  std::map<UUID, RuleClearanceCopper> rule_clearance_copper;
54  std::map<UUID, RuleVia> rule_via;
55  std::map<UUID, RuleClearanceCopperOther> rule_clearance_copper_other;
56  std::map<UUID, RulePlane> rule_plane;
57  std::map<UUID, RuleDiffpair> rule_diffpair;
58  std::map<UUID, RuleClearanceCopperKeepout> rule_clearance_copper_keepout;
59 
60  RuleClearanceSilkscreenExposedCopper rule_clearance_silkscreen_exposed_copper;
61  RuleParameters rule_parameters;
62  RulePreflightChecks rule_preflight_checks;
63 
64  RulesCheckResult check_track_width(const class Board *b);
65  RulesCheckResult check_hole_size(const class Board *b);
66  RulesCheckResult check_clearance_copper(const class Board *b, class RulesCheckCache &cache,
67  check_status_cb_t status_cb);
68  RulesCheckResult check_clearance_copper_non_copper(const class Board *b, class RulesCheckCache &cache,
69  check_status_cb_t status_cb);
70  RulesCheckResult check_preflight(const class Board *b);
71  RulesCheckResult check_clearance_copper_keepout(const class Board *b, class RulesCheckCache &cache,
72  check_status_cb_t status_cb);
73 };
74 } // 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:44
horizon::Rule
Definition: rule.hpp:26
libzip::uint64_t
zip_uint64_t uint64_t
zip_uint64_t_t typedef.
Definition: zip.hpp:108
horizon::BoardRules
Definition: board_rules.hpp:20
horizon::RulePreflightChecks
Definition: rule_preflight_checks.hpp:6
horizon::RuleDiffpair
Definition: rule_diffpair.hpp:7
horizon::Board
Definition: board.hpp:31
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:161
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:31
horizon::RuleClearanceCopperKeepout
Definition: rule_clearance_copper_keepout.hpp:8
horizon::RuleClearanceCopper
Definition: rule_clearance_copper.hpp:7