KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
BASE_SET Class Reference

#include <base_set.h>

Inheritance diagram for BASE_SET:
LSET

Classes

class  const_iterator
 
class  iterator
 
class  set_bits_iterator
 
class  set_bits_reverse_iterator
 

Public Member Functions

iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
 BASE_SET (size_t size=64)
 
BASE_SET & set (size_t pos)
 
BASE_SET & set (size_t pos, bool value)
 
BASE_SET & set ()
 
BASE_SET & reset (size_t pos)
 
BASE_SET & reset ()
 
BASE_SET & flip (size_t pos)
 
BASE_SET & flip ()
 
BASE_SET operator~ () const
 
BASE_SET & operator&= (const BASE_SET &other)
 
BASE_SET & operator|= (const BASE_SET &other)
 
BASE_SET & operator^= (const BASE_SET &other)
 
int compare (const BASE_SET &other) const
 
bool operator< (const BASE_SET &other) const
 
std::string FmtBin () const
 Return a binary string showing contents of this set.
 
std::string FmtHex () const
 Return a hex string showing contents of this set.
 
int ParseHex (const std::string &str)
 Convert the output of FmtHex() and replaces this set's values with those given in the input string.
 
int ParseHex (const char *aStart, int aCount)
 Convert the output of FmtHex() and replaces this set's values with those given in the input string.
 
set_bits_iterator set_bits_begin () const
 
set_bits_iterator set_bits_end () const
 
set_bits_reverse_iterator set_bits_rbegin () const
 
set_bits_reverse_iterator set_bits_rend () const
 

Detailed Description

Definition at line 51 of file base_set.h.

Constructor & Destructor Documentation

◆ BASE_SET()

BASE_SET::BASE_SET ( size_t size = 64)
inline

Definition at line 121 of file base_set.h.

Referenced by LSET::all_set_layers_iterator::all_set_layers_iterator(), compare(), BASE_SET::const_iterator::const_iterator(), LSET::copper_layers_iterator::copper_layers_iterator(), flip(), flip(), BASE_SET::iterator::iterator(), LSET::LSET(), LSET::LSET(), LSET::non_copper_layers_iterator::non_copper_layers_iterator(), operator&=(), operator<(), operator^=(), operator|=(), operator~(), ParseHex(), reset(), reset(), set(), set(), set(), BASE_SET::set_bits_iterator::set_bits_iterator(), and BASE_SET::set_bits_reverse_iterator::set_bits_reverse_iterator().

Member Function Documentation

◆ begin() [1/2]

iterator BASE_SET::begin ( )
inline

Definition at line 116 of file base_set.h.

Referenced by compare(), and operator<().

◆ begin() [2/2]

const_iterator BASE_SET::begin ( ) const
inline

Definition at line 118 of file base_set.h.

◆ compare()

int BASE_SET::compare ( const BASE_SET & other) const
inline

Definition at line 271 of file base_set.h.

References BASE_SET(), begin(), end(), end, and alg::lexicographical_compare_three_way().

Referenced by BOOST_AUTO_TEST_CASE().

◆ end() [1/2]

iterator BASE_SET::end ( )
inline

Definition at line 117 of file base_set.h.

Referenced by compare(), and operator<().

◆ end() [2/2]

const_iterator BASE_SET::end ( ) const
inline

Definition at line 119 of file base_set.h.

◆ flip() [1/2]

BASE_SET & BASE_SET::flip ( )
inline

Definition at line 180 of file base_set.h.

References BASE_SET().

◆ flip() [2/2]

BASE_SET & BASE_SET::flip ( size_t pos)
inline

Definition at line 170 of file base_set.h.

References BASE_SET().

Referenced by DRC_TEST_PROVIDER_MISC::testDisabledLayers().

◆ FmtBin()

std::string BASE_SET::FmtBin ( ) const
inline

Return a binary string showing contents of this set.

Definition at line 286 of file base_set.h.

Referenced by viaSort().

◆ FmtHex()

std::string BASE_SET::FmtHex ( ) const
inline

Return a hex string showing contents of this set.

Definition at line 312 of file base_set.h.

References arrayDim().

Referenced by BOOST_AUTO_TEST_CASE(), PCB_PLOT_PARAMS::Format(), DRC_ENGINE::GetItemsMatchingCondition(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ operator&=()

BASE_SET & BASE_SET::operator&= ( const BASE_SET & other)
inline

Definition at line 197 of file base_set.h.

References BASE_SET().

◆ operator<()

bool BASE_SET::operator< ( const BASE_SET & other) const
inline

Definition at line 277 of file base_set.h.

References BASE_SET(), begin(), end(), end, and alg::lexicographical_compare_three_way().

◆ operator^=()

BASE_SET & BASE_SET::operator^= ( const BASE_SET & other)
inline

Definition at line 247 of file base_set.h.

References BASE_SET().

◆ operator|=()

BASE_SET & BASE_SET::operator|= ( const BASE_SET & other)
inline

Definition at line 222 of file base_set.h.

References BASE_SET().

◆ operator~()

BASE_SET BASE_SET::operator~ ( ) const
inline

Definition at line 189 of file base_set.h.

References BASE_SET(), and result.

◆ ParseHex() [1/2]

int BASE_SET::ParseHex ( const char * aStart,
int aCount )
inline

Convert the output of FmtHex() and replaces this set's values with those given in the input string.

Parsing stops at the first non hex ASCII byte, except that marker bytes output from FmtHex() are not terminators.

Returns
number of bytes consumed.

Definition at line 372 of file base_set.h.

References BASE_SET(), and set().

◆ ParseHex() [2/2]

int BASE_SET::ParseHex ( const std::string & str)
inline

Convert the output of FmtHex() and replaces this set's values with those given in the input string.

Parsing stops at the first non hex ASCII byte, except that marker bytes output from FmtHex() are not terminators.

Returns
the number of bytes consumed.

Definition at line 358 of file base_set.h.

References ParseHex().

Referenced by PCB_PLOT_PARAMS_PARSER::Parse(), and ParseHex().

◆ reset() [1/2]

BASE_SET & BASE_SET::reset ( )
inline

Definition at line 163 of file base_set.h.

References BASE_SET().

Referenced by LSET::ClearCopperLayers(), LSET::ClearNonCopperLayers(), LSET::ClearUserDefinedLayers(), and LSET::FlipStandardLayers().

◆ reset() [2/2]

BASE_SET & BASE_SET::reset ( size_t pos)
inline

Definition at line 153 of file base_set.h.

References BASE_SET().

Referenced by allNonCuMask(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), DrillDocumentationLayers(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), LAYER_UTILS::GetOrphanedFootprintLayers(), API_HANDLER_BOARD::handleGetBoardEnabledLayers(), PARAM_LAYER_PRESET::jsonToPresets(), PCB_IO_KICAD_SEXPR_PARSER::parseBOARD_unchecked(), BOARD::RemoveAllItemsOnLayer(), and PANEL_SETUP_LAYERS::setCopperLayerCheckBoxes().

◆ set() [1/3]

BASE_SET & BASE_SET::set ( )
inline

Definition at line 146 of file base_set.h.

References BASE_SET().

Referenced by LSET::FlipStandardLayers(), LSET::LSET(), LSET::LSET(), LSET::LSET(), and LSET::LSET().

◆ set() [2/3]

BASE_SET & BASE_SET::set ( size_t pos)
inline

Definition at line 126 of file base_set.h.

References BASE_SET().

Referenced by LSET::all_set_layers_iterator::all_set_layers_iterator(), allCuMask(), allNonCuMask(), DIPTRACE::PCB_PARSER::ApplyBoardSettings(), DIALOG_PLOT::applyPlotSettings(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), AR_AUTOPLACER::buildFpAreas(), PCB_IO_PADS_BINARY::buildPad(), BOARD::ComputeBoundingBox(), BASE_SET::const_iterator::const_iterator(), ALTIUM_PCB::ConvertFills6ToFootprintItemOnLayer(), ALTIUM_PCB::ConvertShapeBasedRegions6ToFootprintItemOnLayer(), LSET::copper_layers_iterator::copper_layers_iterator(), SPRINT_LAYOUT_PARSER::CreateBoard(), ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), PCB_IO_EAGLE::defaultKicadLayer(), FOOTPRINT::DeserializeDefinition(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), doIntersectsAreaFunc(), PCBEXPR_LAYER_VALUE::EqualTo(), existsOnLayerFunc(), ZONE_FILLER::Fill(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), PAD::Flip(), ZONE::Flip(), LSET::FlipStandardLayers(), PCB_PLOT_PARAMS::Format(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::getCustomLayersFromControls(), PCB_VIA::GetLayerSet(), PANEL_SETUP_LAYERS::GetUILayerMask(), DRC_ITEM::GetViolationLayers(), BOARD_ADAPTER::GetVisibleLayers(), APPEARANCE_CONTROLS::getVisibleLayers(), API_HANDLER_BOARD::handleCheckPadstackPresenceOnLayers(), ROUTER_TOOL::handleLayerSwitch(), API_HANDLER_BOARD::handleSetVisibleLayers(), ALTIUM_PCB::HelperSetZoneLayers(), BASE_SET::iterator::iterator(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PARAM_LAYER_PRESET::jsonToPresets(), PCB_IO_KICAD_LEGACY::leg_mask2new(), PCB_IO_EAGLE::loadBoard(), PCB_IO_GEDA::loadBoard(), PCB_IO_PADS::loadFootprints(), PADS_PCB_CONVERTER::LoadKeepouts(), FABMASTER::loadLayers(), LSET::non_copper_layers_iterator::non_copper_layers_iterator(), APPEARANCE_CONTROLS::onLayerVisibilityToggled(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), LENGTH_DELAY_CALCULATION::optimiseVias(), PANEL_FP_USER_LAYER_NAMES::PANEL_FP_USER_LAYER_NAMES(), PANEL_ZONE_PROPERTIES::PANEL_ZONE_PROPERTIES(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_EASYEDAPRO_V3_PARSER::ParseBoard(), PCB_IO_KICAD_SEXPR_PARSER::parseBOARD_unchecked(), PCB_IO_KICAD_SEXPR_PARSER::parseFOOTPRINT_unchecked(), PCB_IO_KICAD_SEXPR_PARSER::parseFootprintStackup(), ParseHex(), DRC_RULES_PARSER::parseLayer(), PCB_IO_KICAD_SEXPR_PARSER::parseLayers(), DRAWING_TOOL::PlaceMicroviaStack(), BOARD::RefreshDrillSymbolLayers(), PADSTACK::RelevantShapeLayers(), PCB_IO_KICAD_SEXPR_PARSER::remapAppendedLayers(), GERBVIEW_FRAME::RemapLayers(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), PCB_SELECTION_CONDITIONS::sameLayerFunc(), PCB_SELECTION_TOOL::Selectable(), PAD::SetAttribute(), DIALOG_PRINT_GERBVIEW::setLayerSetFromList(), DIALOG_PRINT_PCBNEW::setLayerSetFromList(), APPEARANCE_CONTROLS::SetLayerVisible(), PCB_VIA_STACK::ShowPropertiesDialog(), GLOBAL_EDIT_TOOL::swapBoardItem(), PANEL_SETUP_ZONE_HATCH_OFFSETS::SyncCopperLayers(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), kiapi::board::UnpackLayerSet(), FOOTPRINT_EDIT_FRAME::updateEnabledLayers(), LSET::UserDefinedLayersMask(), and RATSNEST_VIEW_ITEM::ViewDraw().

◆ set() [3/3]

BASE_SET & BASE_SET::set ( size_t pos,
bool value )
inline

Definition at line 136 of file base_set.h.

References BASE_SET().

◆ set_bits_begin()

set_bits_iterator BASE_SET::set_bits_begin ( ) const
inline

Definition at line 511 of file base_set.h.

Referenced by BOOST_AUTO_TEST_CASE().

◆ set_bits_end()

set_bits_iterator BASE_SET::set_bits_end ( ) const
inline

Definition at line 512 of file base_set.h.

Referenced by BOOST_AUTO_TEST_CASE().

◆ set_bits_rbegin()

set_bits_reverse_iterator BASE_SET::set_bits_rbegin ( ) const
inline

Definition at line 514 of file base_set.h.

Referenced by BOOST_AUTO_TEST_CASE().

◆ set_bits_rend()

set_bits_reverse_iterator BASE_SET::set_bits_rend ( ) const
inline

Definition at line 518 of file base_set.h.

Referenced by BOOST_AUTO_TEST_CASE().

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