#include <crules/detect.hpp>

Public Member Functions
const Role *	role (std::string_view name) const
const RuleOverride *	override_for (std::string_view rule) const
bool	disabled (std::string_view rule) const

Public Attributes
int	category = -1
	index into Catalogue::categories
int	anchor = -1
	footprint index
int	confidence = 0
	0..100
bool	capped = false
	confidence capped because the board has no pin names (doc 15 §3.6)
std::vector< std::string >	evidence
	matched detectors, e.g. "lib_id +60"
std::vector< Role >	roles
	bound roles, binding order
std::string	superseded_by
	set when a conflicting category won the same anchor (doc 15 §3.4)
bool	asserted = false
	forced by the user override file (assert)
std::vector< RuleOverride >	overrides
	from disable and set entries, one per rule id

Detailed Description

Definition at line 37 of file detect.hpp.

Member Function Documentation

◆ disabled()

bool tmk::crules::Instance::disabled ( std::string_view rule ) const

◆ override_for()

const RuleOverride * tmk::crules::Instance::override_for ( std::string_view rule ) const

◆ role()

const Role * tmk::crules::Instance::role ( std::string_view name ) const

Member Data Documentation

◆ anchor

int tmk::crules::Instance::anchor = -1

footprint index

Definition at line 39 of file detect.hpp.

◆ asserted

bool tmk::crules::Instance::asserted = false

forced by the user override file (assert)

Definition at line 45 of file detect.hpp.

◆ capped

bool tmk::crules::Instance::capped = false

confidence capped because the board has no pin names (doc 15 §3.6)

Definition at line 41 of file detect.hpp.

◆ category

int tmk::crules::Instance::category = -1

index into Catalogue::categories

Definition at line 38 of file detect.hpp.

◆ confidence

int tmk::crules::Instance::confidence = 0

0..100

Definition at line 40 of file detect.hpp.

◆ evidence

std::vector<std::string> tmk::crules::Instance::evidence

matched detectors, e.g. "lib_id +60"

Definition at line 42 of file detect.hpp.

◆ overrides

std::vector<RuleOverride> tmk::crules::Instance::overrides

from disable and set entries, one per rule id

Definition at line 46 of file detect.hpp.

◆ roles

std::vector<Role> tmk::crules::Instance::roles

bound roles, binding order

Definition at line 43 of file detect.hpp.

◆ superseded_by

std::string tmk::crules::Instance::superseded_by

set when a conflicting category won the same anchor (doc 15 §3.4)

Definition at line 44 of file detect.hpp.

The documentation for this struct was generated from the following file:

crules/detect.hpp

Public Member Functions

Public Attributes