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 41 of file base_set.h.

Constructor & Destructor Documentation

◆ BASE_SET()

BASE_SET::BASE_SET ( size_t  size = 64)
inline

Definition at line 111 of file base_set.h.

Member Function Documentation

◆ begin() [1/2]

iterator BASE_SET::begin ( )
inline

Definition at line 106 of file base_set.h.

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

◆ begin() [2/2]

const_iterator BASE_SET::begin ( ) const
inline

Definition at line 108 of file base_set.h.

◆ compare()

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

Definition at line 261 of file base_set.h.

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

Referenced by BOOST_AUTO_TEST_CASE(), and PADSTACK::Compare().

◆ end() [1/2]

iterator BASE_SET::end ( )
inline

Definition at line 107 of file base_set.h.

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

◆ end() [2/2]

const_iterator BASE_SET::end ( ) const
inline

Definition at line 109 of file base_set.h.

◆ flip() [1/2]

BASE_SET & BASE_SET::flip ( )
inline

Definition at line 170 of file base_set.h.

◆ flip() [2/2]

BASE_SET & BASE_SET::flip ( size_t  pos)
inline

Definition at line 160 of file base_set.h.

Referenced by operator~(), and 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 276 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 302 of file base_set.h.

References arrayDim().

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

◆ operator&=()

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

Definition at line 187 of file base_set.h.

◆ operator<()

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

Definition at line 267 of file base_set.h.

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

◆ operator^=()

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

Definition at line 237 of file base_set.h.

◆ operator|=()

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

Definition at line 212 of file base_set.h.

◆ operator~()

BASE_SET BASE_SET::operator~ ( ) const
inline

Definition at line 179 of file base_set.h.

References flip().

◆ 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 362 of file base_set.h.

References 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 348 of file base_set.h.

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

◆ reset() [1/2]

BASE_SET & BASE_SET::reset ( )
inline

Definition at line 153 of file base_set.h.

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

◆ reset() [2/2]

BASE_SET & BASE_SET::reset ( size_t  pos)
inline

Definition at line 143 of file base_set.h.

Referenced by LSET::AllNonCuMask(), BOARD::BOARD(), BOOST_AUTO_TEST_CASE(), ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), PCB_VIA::Deserialize(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), PARAM_LAYER_PRESET::jsonToPresets(), BOARD_PRINTOUT_SETTINGS::Load(), PCB_IO_KICAD_SEXPR_PARSER::parseBOARD_unchecked(), PCB_VIA::PCB_VIA(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), PANEL_SETUP_LAYERS::setCopperLayerCheckBoxes(), PANEL_SETUP_LAYERS::SyncCopperLayers(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), PANEL_SETUP_LAYERS::TransferDataToWindow(), ZONE::UnFill(), and ZONE_SETTINGS::ZONE_SETTINGS().

◆ set() [1/3]

BASE_SET & BASE_SET::set ( )
inline

Definition at line 136 of file base_set.h.

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

◆ set() [2/3]

BASE_SET & BASE_SET::set ( size_t  pos)
inline

Definition at line 116 of file base_set.h.

Referenced by SCOPED_LAYERSET::Add(), PANEL_SETUP_LAYERS::addUserDefinedLayer(), LSET::AllCuMask(), DIALOG_PLOT::applyPlotSettings(), LSET::BackMask(), BOARD::BOARD(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), BOARD_PRINTOUT_SETTINGS::BOARD_PRINTOUT_SETTINGS(), BOOST_AUTO_TEST_CASE(), AR_AUTOPLACER::buildFpAreas(), BOARD::ComputeBoundingBox(), ALTIUM_PCB::ConvertFills6ToFootprintItemOnLayer(), ALTIUM_PCB::ConvertShapeBasedRegions6ToFootprintItemOnLayer(), ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), PCB_IO_EAGLE::defaultKicadLayer(), FOOTPRINT::Deserialize(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), PCBEXPR_LAYER_VALUE::EqualTo(), existsOnLayerFunc(), EXPORTER_STEP::Export(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), LSET::FrontMask(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), PCB_SHAPE::GetLayerSet(), PCB_TRACK::GetLayerSet(), PCB_VIA::GetLayerSet(), PANEL_SETUP_LAYERS::GetUILayerMask(), APPEARANCE_CONTROLS::getVisibleLayers(), BOARD_ADAPTER::GetVisibleLayers(), ROUTER_TOOL::handleLayerSwitch(), API_HANDLER_PCB::handleSetVisibleLayers(), ALTIUM_PCB::HelperSetZoneLayers(), intersectsAreaFunc(), PARAM_LAYER_PRESET::jsonToPresets(), PCB_IO_KICAD_LEGACY::leg_mask2new(), BOARD_PRINTOUT_SETTINGS::Load(), FABMASTER::loadLayers(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_COPPER_ZONE::OnLayerSelection(), DIALOG_NON_COPPER_ZONES_EDITOR::OnLayerSelection(), DIALOG_RULE_AREA_PROPERTIES::OnLayerSelection(), APPEARANCE_CONTROLS::onLayerVisibilityToggled(), PCBNEW_PRINTOUT::OnPrintPage(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), PCB_PLOT_PARAMS_PARSER::Parse(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_KICAD_SEXPR_PARSER::parseBOARD_unchecked(), PCB_IO_KICAD_SEXPR_PARSER::parseFOOTPRINT_unchecked(), ParseHex(), DRC_RULES_PARSER::parseLayer(), PCB_IO_KICAD_SEXPR_PARSER::parseLayers(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), PRIVATE_LAYERS_GRID_TABLE::PRIVATE_LAYERS_GRID_TABLE(), PADSTACK::RelevantShapeLayers(), GERBVIEW_FRAME::RemapLayers(), PCB_SELECTION_CONDITIONS::sameLayerFunc(), PCB_SELECTION_TOOL::Selectable(), PAD::SetAttribute(), BOARD_DESIGN_SETTINGS::SetEnabledLayers(), ZONE::SetFillFlag(), DIALOG_PRINT_GERBVIEW::setLayerSetFromList(), DIALOG_PRINT_PCBNEW::setLayerSetFromList(), APPEARANCE_CONTROLS::SetLayerVisible(), GENERAL_COLLECTORS_GUIDE::SetLayerVisible(), ZONE_SETTINGS::SetupLayersList(), GLOBAL_EDIT_TOOL::swapBoardItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), kiapi::board::UnpackLayerSet(), LSET::UserDefinedLayersMask(), RATSNEST_VIEW_ITEM::ViewDraw(), and ZONE_SETTINGS::ZONE_SETTINGS().

◆ set() [3/3]

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

Definition at line 126 of file base_set.h.

◆ set_bits_begin()

set_bits_iterator BASE_SET::set_bits_begin ( ) const
inline

Definition at line 501 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 502 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 504 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 508 of file base_set.h.

Referenced by BOOST_AUTO_TEST_CASE().

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