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