JUMPER_GROUP_SET Class Reference

Represents an (ordered) list of JUMPER_GROUP objects. More...

#include <jumper_group.h>

Public Member Functions
void	Add (JUMPER_GROUP aGroup)
	Add a JUMPER_GROUP to the set.
void	Add (std::set< wxString > aNames)
	Convenience method to create and add a JUMPER_GROUP from a set of names.
void	Clear ()
const std::vector< JUMPER_GROUP > &	GetAll () const
bool	IsEmpty () const
const JUMPER_GROUP *	FindContaining (const wxString &aName) const
bool	operator== (const JUMPER_GROUP_SET &aOther) const =default

Private Attributes
std::vector< JUMPER_GROUP >	m_groups

Detailed Description

Represents an (ordered) list of JUMPER_GROUP objects.

This class is used to store the jumper groups associated with a symbol or footprint. It can be empty (no defined jumper groups).

Definition at line 67 of file jumper_group.h.

Member Function Documentation

Add() [1/2]

void JUMPER_GROUP_SET::Add

(

JUMPER_GROUP

aGroup

)

Add a JUMPER_GROUP to the set.

Definition at line 53 of file jumper_group.cpp.

References m_groups.

Referenced by Add(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), CONNECTION_GRAPH::boost_test_update_symbol_connectivity, LIB_SYMBOL::Deserialize(), FOOTPRINT::DeserializeDefinition(), KICAD_NETLIST_PARSER::parseComponent(), PCB_IO_KICAD_SEXPR_PARSER::parseFOOTPRINT_unchecked(), SCH_IO_KICAD_SEXPR_PARSER::parseLibSymbol(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

Add() [2/2]

void JUMPER_GROUP_SET::Add

(

std::set< wxString >

aNames

)

Convenience method to create and add a JUMPER_GROUP from a set of names.

Blank names are discarded. If no usable names remain, nothing is added.

Definition at line 59 of file jumper_group.cpp.

References Add(), group, and JUMPER_GROUP::Make().

Clear()

void JUMPER_GROUP_SET::Clear ( )

inline

Definition at line 81 of file jumper_group.h.

References m_groups.

Referenced by LIB_SYMBOL::Deserialize(), FOOTPRINT::DeserializeDefinition(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

FindContaining()

const JUMPER_GROUP * JUMPER_GROUP_SET::FindContaining

(

const wxString &

aName

)

const

Returns

the first group containing aName, or nullptr if no group contains it.

Definition at line 68 of file jumper_group.cpp.

References group, and m_groups.

GetAll()

const std::vector< JUMPER_GROUP > & JUMPER_GROUP_SET::GetAll ( ) const

inline

Definition at line 83 of file jumper_group.h.

References m_groups.

Referenced by boost_test_print_type(), PCB_IO_KICAD_SEXPR::format(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), and CONNECTION_GRAPH::updateSymbolConnectivity().

IsEmpty()

bool JUMPER_GROUP_SET::IsEmpty ( ) const

inline

Definition at line 84 of file jumper_group.h.

References m_groups.

Referenced by boost_test_print_type(), PCB_IO_KICAD_SEXPR::format(), NETLIST_EXPORTER_XML::makeSymbols(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

operator==()

bool JUMPER_GROUP_SET::operator== ( const JUMPER_GROUP_SET & aOther ) const

default

Member Data Documentation

m_groups

std::vector<JUMPER_GROUP> JUMPER_GROUP_SET::m_groups

private

Definition at line 94 of file jumper_group.h.

Referenced by Add(), Clear(), FindContaining(), GetAll(), and IsEmpty().

---

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

• jumper_group.h
• jumper_group.cpp