tmk::crules::BoardIndex Class Reference

#include <crules/topology.hpp>

Public Member Functions
	BoardIndex (const model::Board &b)
const model::Board &	board () const
const std::vector< int > &	net_pads (model::NetId n) const
const std::vector< model::NetId > &	fp_nets (int fi) const
	Distinct nets (non-zero) on a footprint's pads, ascending.
std::vector< int >	parts_on (model::NetId n) const
	Footprints with a pad on the net, ascending.
int	pad_on (int fi, model::NetId n) const
	First pad (ascending index) of footprint fi on net n, or -1.
const std::string &	letters (int fi) const
const std::string &	net_name (model::NetId n) const
int	pad_count (int fi) const
	pads with a net or copper (mechanical NPTH excluded)
bool	ground (model::NetId n) const
bool	supply (model::NetId n) const
bool	signal (model::NetId n) const
	Neither ground nor supply.
bool	is_ic (int fi) const
	U, IC (D25's definition).
bool	is_regulator_ref (int fi) const
	U, IC, VR*, REG*, PS*.
bool	is_cap (int fi) const
	C* with exactly two pads.
bool	is_series (int fi) const
	two-pad R*, FB*, L*, RN? (series element for net walks)
bool	is_connector (int fi) const
	J, P, CN*, CON*, USB*, XS* followed by a digit (doc 04 connectors).
bool	has_pin_names () const

Detailed Description

Definition at line 17 of file topology.hpp.

Constructor & Destructor Documentation

BoardIndex()

tmk::crules::BoardIndex::BoardIndex ( const model::Board & b )

explicit

Member Function Documentation

board()

const model::Board & tmk::crules::BoardIndex::board ( ) const

inline

Definition at line 21 of file topology.hpp.

fp_nets()

const std::vector< model::NetId > & tmk::crules::BoardIndex::fp_nets ( int fi ) const

inline

Distinct nets (non-zero) on a footprint's pads, ascending.

Definition at line 24 of file topology.hpp.

ground()

bool tmk::crules::BoardIndex::ground ( model::NetId n ) const

inline

Definition at line 33 of file topology.hpp.

has_pin_names()

bool tmk::crules::BoardIndex::has_pin_names ( ) const

inline

Definition at line 43 of file topology.hpp.

is_cap()

bool tmk::crules::BoardIndex::is_cap

(

int

fi

)

const

C* with exactly two pads.

is_connector()

bool tmk::crules::BoardIndex::is_connector

(

int

fi

)

const

J, P, CN*, CON*, USB*, XS* followed by a digit (doc 04 connectors).

is_ic()

bool tmk::crules::BoardIndex::is_ic

(

int

fi

)

const

U, IC (D25's definition).

is_regulator_ref()

bool tmk::crules::BoardIndex::is_regulator_ref

(

int

fi

)

const

U, IC, VR*, REG*, PS*.

is_series()

bool tmk::crules::BoardIndex::is_series

(

int

fi

)

const

two-pad R*, FB*, L*, RN? (series element for net walks)

letters()

const std::string & tmk::crules::BoardIndex::letters ( int fi ) const

inline

Definition at line 29 of file topology.hpp.

net_name()

const std::string & tmk::crules::BoardIndex::net_name ( model::NetId n ) const

inline

Definition at line 30 of file topology.hpp.

net_pads()

const std::vector< int > & tmk::crules::BoardIndex::net_pads ( model::NetId n ) const

inline

Definition at line 22 of file topology.hpp.

pad_count()

int tmk::crules::BoardIndex::pad_count

(

int

fi

)

const

pads with a net or copper (mechanical NPTH excluded)

pad_on()

int tmk::crules::BoardIndex::pad_on	(	int	fi,
		model::NetId	n ) const

First pad (ascending index) of footprint fi on net n, or -1.

parts_on()

std::vector< int > tmk::crules::BoardIndex::parts_on

(

model::NetId

n

)

const

Footprints with a pad on the net, ascending.

signal()

bool tmk::crules::BoardIndex::signal ( model::NetId n ) const

inline

Neither ground nor supply.

Definition at line 36 of file topology.hpp.

supply()

bool tmk::crules::BoardIndex::supply ( model::NetId n ) const

inline

Definition at line 34 of file topology.hpp.

---

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

• crules/topology.hpp