LSET is a set of PCB_LAYER_IDs. More...

#include <layer_ids.h>

Inheritance diagram for LSET:

Public Member Functions
	LSET ()
	Create an empty (cleared) set. More...

	LSET (const BASE_SET &aOther)

	LSET (PCB_LAYER_ID aLayer)
	Take a PCB_LAYER_ID and sets that bit. More...

	LSET (const PCB_LAYER_ID *aArray, unsigned aCount)
	Create an array or LSEQ. More...

	LSET (unsigned aIdCount, int aFirst,...)
	Take one or more PCB_LAYER_IDs in the argument list to construct the set. More...

bool	Contains (PCB_LAYER_ID aLayer)
	See if the layer set contains a PCB layer. More...

LSEQ	CuStack () const
	Return a sequence of copper layers in starting from the front/top and extending to the back/bottom. More...

LSEQ	Technicals (LSET aSubToOmit=LSET()) const
	Return a sequence of technical layers. More...

LSEQ	Users () const
	*_User layers. More...

LSEQ	TechAndUserUIOrder () const
	Returns the technical and user layers in the order shown in layer widget. More...

LSEQ	UIOrder () const

LSEQ	Seq (const PCB_LAYER_ID *aWishListSequence, unsigned aCount) const
	Return an LSEQ from the union of this LSET and a desired sequence. More...

LSEQ	Seq (const LSEQ &aSequence) const

LSEQ	Seq () const
	Return a LSEQ from this LSET in ascending PCB_LAYER_ID order. More...

LSEQ	SeqStackupBottom2Top () const
	Return the sequence that is typical for a bottom-to-top stack-up. More...

std::string	FmtHex () const
	Return a hex string showing contents of this LSEQ. More...

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. More...

std::string	FmtBin () const
	Return a binary string showing contents of this LSEQ. More...

PCB_LAYER_ID	ExtractLayer () const
	Find the first set PCB_LAYER_ID. More...

Static Public Member Functions
static const wxChar *	Name (PCB_LAYER_ID aLayerId)
	Return the fixed name association with aLayerId. More...

static LSET	InternalCuMask ()
	Return a complete set of internal copper layers which is all Cu layers except F_Cu and B_Cu. More...

static LSET	FrontAssembly ()
	Return a complete set of all top assembly layers which is all F_SilkS and F_Mask. More...

static LSET	BackAssembly ()
	Return a complete set of all bottom assembly layers which is all B_SilkS and B_Mask. More...

static LSET	AllCuMask (int aCuLayerCount=MAX_CU_LAYERS)
	Return a mask holding the requested number of Cu PCB_LAYER_IDs. More...

static LSET	ExternalCuMask ()
	Return a mask holding the Front and Bottom layers. More...

static LSET	AllNonCuMask ()
	Return a mask holding all layer minus CU layers. More...

static LSET	AllLayersMask ()

static LSET	FrontTechMask ()
	Return a mask holding all technical layers (no CU layer) on front side. More...

static LSET	FrontBoardTechMask ()
	Return a mask holding technical layers used in a board fabrication (no CU layer) on front side. More...

static LSET	BackTechMask ()
	Return a mask holding all technical layers (no CU layer) on back side. More...

static LSET	BackBoardTechMask ()
	Return a mask holding technical layers used in a board fabrication (no CU layer) on Back side. More...

static LSET	AllTechMask ()
	Return a mask holding all technical layers (no CU layer) on both side. More...

static LSET	AllBoardTechMask ()
	Return a mask holding board technical layers (no CU layer) on both side. More...

static LSET	FrontMask ()
	Return a mask holding all technical layers and the external CU layer on front side. More...

static LSET	BackMask ()
	Return a mask holding all technical layers and the external CU layer on back side. More...

static LSET	SideSpecificMask ()

static LSET	UserMask ()

static LSET	PhysicalLayersMask ()
	Return a mask holding all layers which are physically realized. More...

static LSET	UserDefinedLayers ()
	Return a mask with all of the allowable user defined layers. More...

static LSET	ForbiddenFootprintLayers ()
	Layers which are not allowed within footprint definitions. More...

Private Member Functions
	LSET (unsigned long __val)
	Take this off the market, it may not be used because of LSET( PCB_LAYER_ID ). More...

Detailed Description

LSET is a set of PCB_LAYER_IDs.

It can be converted to numerous purpose LSEQs using the various member functions, most of which are based on Seq(). The advantage of converting to LSEQ using purposeful code, is it removes any dependency on order/sequence inherent in this set.

Definition at line 535 of file layer_ids.h.

Constructor & Destructor Documentation

◆ LSET() [1/6]

LSET::LSET ( )

inline

Create an empty (cleared) set.

Definition at line 552 of file layer_ids.h.

Referenced by AllLayersMask(), and AllNonCuMask().

◆ LSET() [2/6]

LSET::LSET ( const BASE_SET & aOther )

inline

Definition at line 557 of file layer_ids.h.

◆ LSET() [3/6]

LSET::LSET ( PCB_LAYER_ID aLayer )

inline

Take a PCB_LAYER_ID and sets that bit.

This makes the following code into a bug:

LSET s = 0;

Instead use:

LSET s;

for an empty set.

Definition at line 576 of file layer_ids.h.

◆ LSET() [4/6]

LSET::LSET	(	const PCB_LAYER_ID *	aArray,
		unsigned	aCount
	)

Create an array or LSEQ.

Definition at line 39 of file lset.cpp.

◆ LSET() [5/6]

LSET::LSET	(	unsigned	aIdCount,
		int	aFirst,
			...
	)

Take one or more PCB_LAYER_IDs in the argument list to construct the set.

Typically only used in static construction.

Parameters

aIdCount	is the number of PCB_LAYER_IDs which follow.
aFirst	is the first included in aIdCount and must always be present, and can be followed by any number of additional PCB_LAYER_IDs so long as aIdCount accurately reflects the count.

Parameter is 'int' to avoid va_start undefined behavior.

Definition at line 47 of file lset.cpp.

References PCB_LAYER_ID_COUNT.

◆ LSET() [6/6]

LSET::LSET ( unsigned long __val )

inlineprivate

Take this off the market, it may not be used because of LSET( PCB_LAYER_ID ).

Definition at line 795 of file layer_ids.h.

Member Function Documentation

◆ AllBoardTechMask()

LSET LSET::AllBoardTechMask ( )

static

Return a mask holding board technical layers (no CU layer) on both side.

Definition at line 848 of file lset.cpp.

References BackBoardTechMask(), and FrontBoardTechMask().

Referenced by DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), PhysicalLayersMask(), and CADSTAR_PCB_ARCHIVE_LOADER::remapUnsureLayers().

◆ AllCuMask()

LSET LSET::AllCuMask ( int aCuLayerCount = MAX_CU_LAYERS )

static

Return a mask holding the requested number of Cu PCB_LAYER_IDs.

Definition at line 773 of file lset.cpp.

References B_Cu, Clamp(), F_Cu, In30_Cu, InternalCuMask(), and MAX_CU_LAYERS.

Referenced by PCAD2KICAD::PCAD_PAD::AddToFootprint(), DIALOG_PLOT::applyPlotSettings(), FOOTPRINT::CheckPads(), FOOTPRINT::CheckShortingPads(), TRACKS_CLEANER::cleanup(), HYPERLYNX_EXPORTER::collectNetObjects(), compute_pad_access_code(), EXPORTER_PCB_VRML::ComputeLayer3D_Zpos(), BOARD_ADAPTER::createLayers(), ZONE_CREATE_HELPER::createNewZone(), PANEL_SETUP_LAYERS::DenyChangeCheckBox(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), BOARD_COMMIT::dirtyIntersectingZones(), CLI::EXPORT_PCB_BASE_COMMAND::EXPORT_PCB_BASE_COMMAND(), ZONE_FILLER::Fill(), fmt_mask(), PCB_PLUGIN::formatLayers(), GENDRILL_WRITER_BASE::GenDrillReportFile(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadLayerSet(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), PCB_VIA::GetLayerSet(), BOARD::GetPad(), PAD::GetSolderMaskExpansion(), PAD::GetSolderPasteMargin(), FOOTPRINT::GetUniquePadCount(), ROUTER_TOOL::handleLayerSwitch(), ALTIUM_PCB::HelperSetZoneLayers(), BOARD_INSPECTION_TOOL::highlightNet(), PCB_PARSER::init(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), PAD::IsAperturePad(), HYPERLYNX_PAD_STACK::IsEmpty(), PAD::IsOnCopperLayer(), ZONE::IsOnCopperLayer(), DSN::isRoundKeepout(), BOARD_ITEM::layerMaskDescribe(), LEGACY_PLUGIN::leg_mask2new(), CADSTAR_PCB_ARCHIVE_LOADER::Load(), KIGFX::PCB_RENDER_SETTINGS::LoadColors(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryCoppers(), FABMASTER::loadZone(), DSN::SPECCTRA_DB::makeIMAGE(), DSN::SPECCTRA_DB::makePADSTACK(), DIALOG_PRINT_PCBNEW::onPopUpLayers(), DIALOG_PLOT::OnPopUpLayers(), DIALOG_PAD_PROPERTIES::OnUpdateUI(), DIALOG_PAD_PROPERTIES::OnUpdateUINonCopperWarning(), EAGLE_PLUGIN::packageHole(), EAGLE_PLUGIN::packagePad(), PCB_PLOT_PARAMS_PARSER::Parse(), GPCB_FPL_CACHE::parseFOOTPRINT(), DRC_RULES_PARSER::parseLayer(), PCB_PARSER::parsePAD(), PCB_PARSER::parsePCB_VIA(), PCB_PLOT_PARAMS::PCB_PLOT_PARAMS(), PhysicalLayersMask(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), PCB_PLOT_SVG::Plot(), DIALOG_PLOT::Plot(), BRDITEMS_PLOTTER::PlotPad(), PlotStandardLayer(), PRIVATE_LAYERS_GRID_TABLE::PRIVATE_LAYERS_GRID_TABLE(), PAD::PTHMask(), DRC_CACHE_GENERATOR::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_SLIVER_CHECKER::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), BOARD_DESIGN_SETTINGS::SetCopperLayerCount(), BOARD_DESIGN_SETTINGS::SetEnabledLayers(), EAGLE_PLUGIN::setKeepoutSettingsToZone(), ZONE_CREATE_HELPER::setUniquePriority(), PCBNEW_PRINTOUT::setupViewLayers(), PANEL_SETUP_LAYERS::showLayerTypes(), SideSpecificMask(), PNS_KICAD_IFACE_BASE::syncPad(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), DIALOG_SWAP_LAYERS::TransferDataFromWindow(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), DIALOG_SWAP_LAYERS::TransferDataToWindow(), PCB_PROPERTIES_PANEL::updateLists(), PCB_CONTROL::UpdateMessagePanel(), DIALOG_PAD_PROPERTIES::updatePadLayersList(), RATSNEST_VIEW_ITEM::ViewDraw(), and HYPERLYNX_EXPORTER::writeSinglePadStack().

◆ AllLayersMask()

LSET LSET::AllLayersMask ( )

static

Definition at line 808 of file lset.cpp.

References LSET().

Referenced by PCB_GRID_HELPER::BestDragOrigin(), PCB_GRID_HELPER::BestSnapAnchor(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), CLI::FP_EXPORT_SVG_COMMAND::doPerform(), DRC_RTREE::DRC_RTREE(), CLI::EXPORT_PCB_BASE_COMMAND::EXPORT_PCB_BASE_COMMAND(), FOOTPRINT_DESC::FOOTPRINT_DESC(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PCB_LAYER_BOX_SELECTOR::getEnabledLayers(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadLayerSet(), APPEARANCE_CONTROLS::getVisibleLayers(), GERBVIEW_FRAME::GetVisibleLayers(), BOARD::GetVisibleLayers(), ROUTER_TOOL::handleLayerSwitch(), LAYER_PRESET::LAYER_PRESET(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), PCB_EDIT_FRAME::onBoardLoaded(), DIALOG_DRC::OnDRCItemSelected(), PCB_POINT_EDITOR::OnSelectionChange(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), PCB_PICKER_TOOL::reset(), PCB_LAYER_BOX_SELECTOR::Resync(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), PCB_SELECTION_TOOL::Selectable(), DRAWING_TOOL::SetAnchor(), APPEARANCE_CONTROLS::setVisibleLayers(), DRC_TEST_PROVIDER_MISC::testAssertions(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), PANEL_SETUP_LAYERS::testLayerNames(), DRC_TEST_PROVIDER_MISC::testTextVars(), TRACK_VIA_DESC::TRACK_VIA_DESC(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), PCB_EDIT_FRAME::UpdateUserInterface(), PCB_VIA::ViewGetLOD(), WriteDRCReport(), and ZONE_DESC::ZONE_DESC().

◆ AllNonCuMask()

LSET LSET::AllNonCuMask ( )

static

Return a mask holding all layer minus CU layers.

Definition at line 794 of file lset.cpp.

References LSET().

Referenced by DIALOG_GLOBAL_EDIT_TEARDROPS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), ROUTER_TOOL::handleLayerSwitch(), and DIALOG_SWAP_LAYERS::TransferDataToWindow().

◆ AllTechMask()

LSET LSET::AllTechMask ( )

static

Return a mask holding all technical layers (no CU layer) on both side.

Definition at line 841 of file lset.cpp.

References BackTechMask(), and FrontTechMask().

Referenced by BOARD_ITEM::layerMaskDescribe(), FABMASTER::loadLayers(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_PRINT_PCBNEW::onPopUpLayers(), DIALOG_PLOT::OnPopUpLayers(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), and PRIVATE_LAYERS_GRID_TABLE::PRIVATE_LAYERS_GRID_TABLE().

◆ BackAssembly()

LSET LSET::BackAssembly ( )

static

Return a complete set of all bottom assembly layers which is all B_SilkS and B_Mask.

Definition at line 719 of file lset.cpp.

References arrayDim(), B_CrtYd, B_Fab, B_Mask, and B_SilkS.

◆ BackBoardTechMask()

LSET LSET::BackBoardTechMask ( )

static

Return a mask holding technical layers used in a board fabrication (no CU layer) on Back side.

Definition at line 821 of file lset.cpp.

References B_Adhes, B_Mask, B_Paste, and B_SilkS.

Referenced by AllBoardTechMask(), and PAD::FlashLayer().

◆ BackMask()

LSET LSET::BackMask ( )

static

Return a mask holding all technical layers and the external CU layer on back side.

Definition at line 902 of file lset.cpp.

References B_Cu, and BackTechMask().

Referenced by collidesWithArea(), DRC_ENGINE::EvalRules(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), PCB_SELECTION_TOOL::Selectable(), and DRC_INTERACTIVE_COURTYARD_CLEARANCE::testCourtyardClearances().

◆ BackTechMask()

LSET LSET::BackTechMask ( )

static

Return a mask holding all technical layers (no CU layer) on back side.

Definition at line 815 of file lset.cpp.

References B_Adhes, B_CrtYd, B_Fab, B_Mask, B_Paste, and B_SilkS.

Referenced by AllTechMask(), BackMask(), SideSpecificMask(), and PCB_VIA::ViewGetLOD().

◆ Contains()

bool LSET::Contains ( PCB_LAYER_ID aLayer )

inline

See if the layer set contains a PCB layer.

Parameters

aLayer is the layer to check

Returns: true if the layer is included

Definition at line 606 of file layer_ids.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::calculateZonePriorities(), collidesWithArea(), APPEARANCE_CONTROLS::doApplyLayerPreset(), PCB_LAYER_VALUE::EqualTo(), ZONE_FILLER::Fill(), BOARD_INSPECTION_TOOL::highlightNet(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryCoppers(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), APPEARANCE_CONTROLS::setVisibleLayers(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), and DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones().

◆ CuStack()

LSEQ LSET::CuStack ( ) const

Return a sequence of copper layers in starting from the front/top and extending to the back/bottom.

This specific sequence is depended upon in numerous places.

Definition at line 170 of file lset.cpp.

References arrayDim(), B_Cu, F_Cu, In10_Cu, In11_Cu, In12_Cu, In13_Cu, In14_Cu, In15_Cu, In16_Cu, In17_Cu, In18_Cu, In19_Cu, In1_Cu, In20_Cu, In21_Cu, In22_Cu, In23_Cu, In24_Cu, In25_Cu, In26_Cu, In27_Cu, In28_Cu, In29_Cu, In2_Cu, In30_Cu, In3_Cu, In4_Cu, In5_Cu, In6_Cu, In7_Cu, In8_Cu, In9_Cu, and Seq().

Referenced by PCB_PLUGIN::format(), PCB_PLUGIN::formatBoardLayers(), APPEARANCE_CONTROLS::rebuildLayers(), UIOrder(), PCB_CONTROL::UpdateMessagePanel(), and HYPERLYNX_EXPORTER::writeStackupInfo().

◆ ExternalCuMask()

LSET LSET::ExternalCuMask ( )

static

Return a mask holding the Front and Bottom layers.

Definition at line 801 of file lset.cpp.

References B_Cu, and F_Cu.

Referenced by DRC_RULES_PARSER::parseLayer(), BRDITEMS_PLOTTER::PlotPad(), PANEL_SETUP_BOARD_STACKUP::showOnlyActiveLayers(), BOARD_STACKUP::StackupAllowedBrdLayers(), and PANEL_SETUP_BOARD_STACKUP::updateCopperLayerCount().

◆ ExtractLayer()

PCB_LAYER_ID LSET::ExtractLayer ( ) const

Find the first set PCB_LAYER_ID.

Returns UNDEFINED_LAYER if more than one is set or UNSELECTED_LAYER if none is set.

Definition at line 684 of file lset.cpp.

References UNDEFINED_LAYER, and UNSELECTED_LAYER.

Referenced by PCBNEW_PRINTOUT::OnPrintPage().

◆ FmtBin()

std::string LSET::FmtBin ( ) const

Return a binary string showing contents of this LSEQ.

Definition at line 297 of file lset.cpp.

Referenced by ViaSort().

◆ FmtHex()

std::string LSET::FmtHex ( ) const

Return a hex string showing contents of this LSEQ.

Definition at line 321 of file lset.cpp.

References arrayDim().

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

◆ ForbiddenFootprintLayers()

LSET LSET::ForbiddenFootprintLayers ( )

static

Layers which are not allowed within footprint definitions.

Currently internal copper layers and Margin.

Definition at line 915 of file lset.cpp.

References InternalCuMask().

Referenced by DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), APPEARANCE_CONTROLS::onLayerLeftClick(), APPEARANCE_CONTROLS::rebuildLayers(), and FOOTPRINT_EDIT_FRAME::ReCreateHToolbar().

◆ FrontAssembly()

LSET LSET::FrontAssembly ( )

static

Return a complete set of all top assembly layers which is all F_SilkS and F_Mask.

Definition at line 705 of file lset.cpp.

References arrayDim(), F_CrtYd, F_Fab, F_Mask, and F_SilkS.

◆ FrontBoardTechMask()

LSET LSET::FrontBoardTechMask ( )

static

Return a mask holding technical layers used in a board fabrication (no CU layer) on front side.

Definition at line 834 of file lset.cpp.

References F_Adhes, F_Mask, F_Paste, and F_SilkS.

Referenced by AllBoardTechMask(), and PAD::FlashLayer().

◆ FrontMask()

LSET LSET::FrontMask ( )

static

Return a mask holding all technical layers and the external CU layer on front side.

Definition at line 895 of file lset.cpp.

References F_Cu, and FrontTechMask().

Referenced by collidesWithArea(), DRC_ENGINE::EvalRules(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), PCB_SELECTION_TOOL::Selectable(), and DRC_INTERACTIVE_COURTYARD_CLEARANCE::testCourtyardClearances().

◆ FrontTechMask()

LSET LSET::FrontTechMask ( )

static

Return a mask holding all technical layers (no CU layer) on front side.

Definition at line 827 of file lset.cpp.

References F_Adhes, F_CrtYd, F_Fab, F_Mask, F_Paste, and F_SilkS.

Referenced by AllTechMask(), FrontMask(), SideSpecificMask(), and PCB_VIA::ViewGetLOD().

◆ InternalCuMask()

LSET LSET::InternalCuMask ( )

static

Return a complete set of internal copper layers which is all Cu layers except F_Cu and B_Cu.

Definition at line 733 of file lset.cpp.

References arrayDim(), In10_Cu, In11_Cu, In12_Cu, In13_Cu, In14_Cu, In15_Cu, In16_Cu, In17_Cu, In18_Cu, In19_Cu, In1_Cu, In20_Cu, In21_Cu, In22_Cu, In23_Cu, In24_Cu, In25_Cu, In26_Cu, In27_Cu, In28_Cu, In29_Cu, In2_Cu, In30_Cu, In3_Cu, In4_Cu, In5_Cu, In6_Cu, In7_Cu, In8_Cu, and In9_Cu.

Referenced by AllCuMask(), CLI::EXPORT_PCB_BASE_COMMAND::EXPORT_PCB_BASE_COMMAND(), ZONE_FILLER::Fill(), ZONE_FILLER::fillSingleZone(), FlipLayerMask(), ForbiddenFootprintLayers(), PCB_PARSER::init(), DIALOG_RULE_AREA_PROPERTIES::OnLayerSelection(), DIALOG_PAD_PROPERTIES::padValuesOK(), DRC_RULES_PARSER::parseLayer(), PCB_CONTROL::pruneItemLayers(), PANEL_SETUP_LAYERS::setCopperLayerCheckBoxes(), PANEL_SETUP_BOARD_STACKUP::showOnlyActiveLayers(), BOARD_STACKUP::StackupAllowedBrdLayers(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ Name()

const wxChar * LSET::Name ( PCB_LAYER_ID aLayerId )

static

Return the fixed name association with aLayerId.

NOTE: These names must not be translated or changed.

They are used as tokens in the board file format because the ordinal value of the PCB_LAYER_ID enum was not stable over time.

See also: LayerName() for what should be used to display the default name of a layer in the GUI.

Definition at line 82 of file lset.cpp.

References B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, Cmts_User, Dwgs_User, Eco1_User, Eco2_User, Edge_Cuts, F_Adhes, F_CrtYd, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, In10_Cu, In11_Cu, In12_Cu, In13_Cu, In14_Cu, In15_Cu, In16_Cu, In17_Cu, In18_Cu, In19_Cu, In1_Cu, In20_Cu, In21_Cu, In22_Cu, In23_Cu, In24_Cu, In25_Cu, In26_Cu, In27_Cu, In28_Cu, In29_Cu, In2_Cu, In30_Cu, In3_Cu, In4_Cu, In5_Cu, In6_Cu, In7_Cu, In8_Cu, In9_Cu, Margin, Rescue, User_1, User_2, User_3, User_4, User_5, User_6, User_7, User_8, and User_9.

Referenced by PANEL_SETUP_LAYERS::addUserDefinedLayer(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), CLI::EXPORT_PCB_BASE_COMMAND::EXPORT_PCB_BASE_COMMAND(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_PLUGIN::format(), PCB_PLUGIN::formatBoardLayers(), BOARD_STACKUP::FormatBoardStackup(), PCB_PLUGIN::formatLayer(), PCB_PLUGIN::formatLayers(), PCB_PARSER::init(), CADSTAR_PCB_ARCHIVE_LOADER::logBoardStackupMessage(), CADSTAR_PCB_ARCHIVE_LOADER::logBoardStackupWarning(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PCB_EDIT_FRAME::onBoardLoaded(), PCB_PARSER::parseLayer(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), TRACK_VIA_DESC::TRACK_VIA_DESC(), PCB_PROPERTIES_PANEL::updateLists(), PCB_EDIT_FRAME::UpdateUserInterface(), WriteDRCReport(), and ZONE_DESC::ZONE_DESC().

◆ ParseHex()

int LSET::ParseHex	(	const char *	aStart,
		int	aCount
	)

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: int - number of bytes consumed

Definition at line 359 of file lset.cpp.

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

◆ PhysicalLayersMask()

LSET LSET::PhysicalLayersMask ( )

static

Return a mask holding all layers which are physically realized.

Equivalent to the copper layers + the board tech mask.

Definition at line 870 of file lset.cpp.

References AllBoardTechMask(), and AllCuMask().

Referenced by BOARD_COMMIT::dirtyIntersectingZones(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), PCB_SELECTION_TOOL::Selectable(), PAD::ViewGetLOD(), and PCB_VIA::ViewGetLOD().

◆ Seq() [1/3]

LSEQ LSET::Seq ( ) const

Return a LSEQ from this LSET in ascending PCB_LAYER_ID order.

Each LSEQ element will be in the same sequence as in PCB_LAYER_ID and only present in the resultant LSEQ if present in this set. Therefore the sequence is subject to change, use it only when enumeration and not order is important.

Definition at line 459 of file lset.cpp.

Referenced by CuStack(), SeqStackupBottom2Top(), TechAndUserUIOrder(), and Users().

◆ Seq() [2/3]

LSEQ LSET::Seq ( const LSEQ & aSequence ) const

Definition at line 445 of file lset.cpp.

◆ Seq() [3/3]

LSEQ LSET::Seq	(	const PCB_LAYER_ID *	aWishListSequence,
		unsigned	aCount
	)		const

Return an LSEQ from the union of this LSET and a desired sequence.

The LSEQ element will be in the same sequence as aWishListSequence if they are present.

Parameters

aWishListSequence	establishes the order of the returned LSEQ, and the LSEQ will only contain PCB_LAYER_IDs which are present in this set.
aCount	is the length of aWishListSequence array.

Definition at line 411 of file lset.cpp.

Referenced by CN_CONNECTIVITY_ALGO::Add(), FOOTPRINT::CheckPads(), collidesWithArea(), BOARD_ADAPTER::createLayers(), CreatePadsShapesSection(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), APPEARANCE_CONTROLS::doApplyLayerPreset(), CLI::EXPORT_PCB_BASE_COMMAND::doPerform(), KIGFX::PCB_PAINTER::Draw(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawVia(), DIALOG_EXPORT_SVG::ExportSVGFile(), ZONE_FILLER::Fill(), PAD::FlashLayer(), PCB_VIA::FlashLayer(), PCB_PLUGIN::format(), PCB_PLUGIN::formatBoardLayers(), GENDRILL_WRITER_BASE::GenDrillReportFile(), ZONE::GetItemDescription(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), ZONE::GetMsgPanelInfo(), PANEL_SETUP_LAYERS::getNonRemovableLayers(), PAD::GetPrincipalLayer(), PANEL_SETUP_LAYERS::getRemovedLayersWithItems(), ZONE_SEARCH_HANDLER::GetResultCell(), ROUTER_TOOL::handleLayerSwitch(), ZONE::InitDataFromSrcInCopyCtor(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), PNS_KICAD_IFACE::IsItemVisible(), PCBNEW_JOBS_HANDLER::JobExportGerber(), CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols(), DIALOG_DRC::OnDRCItemSelected(), APPEARANCE_CONTROLS::OnLayerContextMenu(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), CN_VISITOR::operator()(), BOARD_ITEM::ptr_cmp::operator()(), KI_TEST::kitest_cmp_drawings::operator()(), FOOTPRINT::cmp_pads::operator()(), FOOTPRINT::cmp_zones::operator()(), PCB_PARSER::parsePAD(), PCB_PARSER::parsePCB_VIA(), PlotLayerOutlines(), PlotStandardLayer(), DRC_CACHE_GENERATOR::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SLIVER_CHECKER::Run(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::Run(), PCB_SELECTION_TOOL::Selectable(), BOARD_ITEM::SetLayerSet(), PCB_VIA::SetLayerSet(), ZONE::SetLayerSet(), GERBVIEW_PRINTOUT::setupViewLayers(), PCBNEW_PRINTOUT::setupViewLayers(), Technicals(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances(), DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), PCB_EDIT_FRAME::UpdateUserInterface(), RATSNEST_VIEW_ITEM::ViewDraw(), ZONE::ViewGetLayers(), and HYPERLYNX_EXPORTER::writeSinglePadStack().

◆ SeqStackupBottom2Top()

LSEQ LSET::SeqStackupBottom2Top ( ) const

Return the sequence that is typical for a bottom-to-top stack-up.

For instance, to plot multiple layers in a single image, the top layers output last.

Definition at line 475 of file lset.cpp.

References arrayDim(), B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, Cmts_User, Dwgs_User, Eco1_User, Eco2_User, Edge_Cuts, F_Adhes, F_CrtYd, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, In10_Cu, In11_Cu, In12_Cu, In13_Cu, In14_Cu, In15_Cu, In16_Cu, In17_Cu, In18_Cu, In19_Cu, In1_Cu, In20_Cu, In21_Cu, In22_Cu, In23_Cu, In24_Cu, In25_Cu, In26_Cu, In27_Cu, In28_Cu, In29_Cu, In2_Cu, In30_Cu, In3_Cu, In4_Cu, In5_Cu, In6_Cu, In7_Cu, In8_Cu, In9_Cu, Margin, Seq(), User_1, User_2, User_3, User_4, User_5, User_6, User_7, User_8, and User_9.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCB_PLOT_SVG::Plot(), and PlotLayerOutlines().

◆ SideSpecificMask()

LSET LSET::SideSpecificMask ( )

static

Definition at line 908 of file lset.cpp.

References AllCuMask(), BackTechMask(), and FrontTechMask().

Referenced by KIGFX::PCB_PAINTER::draw(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), and PCB_DIMENSION_BASE::Mirror().

◆ TechAndUserUIOrder()

LSEQ LSET::TechAndUserUIOrder ( ) const

Returns the technical and user layers in the order shown in layer widget.

Definition at line 261 of file lset.cpp.

References arrayDim(), B_Adhes, B_CrtYd, B_Fab, B_Mask, B_Paste, B_SilkS, Cmts_User, Dwgs_User, Eco1_User, Eco2_User, Edge_Cuts, F_Adhes, F_CrtYd, F_Fab, F_Mask, F_Paste, F_SilkS, Margin, Seq(), User_1, User_2, User_3, User_4, User_5, User_6, User_7, User_8, and User_9.

Referenced by UIOrder().

◆ Technicals()

LSEQ LSET::Technicals ( LSET aSubToOmit = LSET() ) const

Return a sequence of technical layers.

A sequence provides a certain order.

Parameters

aSubToOmit is the subset of the technical layers to omit, defaults to none.

Definition at line 212 of file lset.cpp.

References arrayDim(), B_Adhes, B_CrtYd, B_Fab, B_Mask, B_Paste, B_SilkS, F_Adhes, F_CrtYd, F_Fab, F_Mask, F_Paste, F_SilkS, and Seq().

◆ UIOrder()

◆ UserDefinedLayers()

LSET LSET::UserDefinedLayers ( )

static

Return a mask with all of the allowable user defined layers.

Definition at line 877 of file lset.cpp.

References User_1, User_2, User_3, User_4, User_5, User_6, User_7, User_8, and User_9.

Referenced by PANEL_SETUP_LAYERS::addUserDefinedLayer(), CADSTAR_PCB_ARCHIVE_LOADER::remapUnsureLayers(), PANEL_SETUP_LAYERS::setUserDefinedLayerCheckBoxes(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ UserMask()

LSET LSET::UserMask ( )

static

Definition at line 855 of file lset.cpp.

References Cmts_User, Dwgs_User, Eco1_User, Eco2_User, Edge_Cuts, and Margin.

Referenced by FABMASTER::loadLayers(), and CADSTAR_PCB_ARCHIVE_LOADER::remapUnsureLayers().

◆ Users()

LSEQ LSET::Users ( ) const

*_User layers.

Definition at line 236 of file lset.cpp.

References arrayDim(), Cmts_User, Dwgs_User, Eco1_User, Eco2_User, Edge_Cuts, Margin, Seq(), User_1, User_2, User_3, User_4, User_5, User_6, User_7, User_8, and User_9.

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ LSET() [1/6]

◆ LSET() [2/6]

◆ LSET() [3/6]

◆ LSET() [4/6]

◆ LSET() [5/6]

◆ LSET() [6/6]

Member Function Documentation

◆ AllBoardTechMask()

◆ AllCuMask()

◆ AllLayersMask()

◆ AllNonCuMask()

◆ AllTechMask()

◆ BackAssembly()

◆ BackBoardTechMask()

◆ BackMask()

◆ BackTechMask()

◆ Contains()

◆ CuStack()

◆ ExternalCuMask()

◆ ExtractLayer()

◆ FmtBin()

◆ FmtHex()

◆ ForbiddenFootprintLayers()

◆ FrontAssembly()

◆ FrontBoardTechMask()

◆ FrontMask()

◆ FrontTechMask()

◆ InternalCuMask()

◆ Name()

◆ ParseHex()

◆ PhysicalLayersMask()

◆ Seq() [1/3]

◆ Seq() [2/3]

◆ Seq() [3/3]

◆ SeqStackupBottom2Top()

◆ SideSpecificMask()

◆ TechAndUserUIOrder()

◆ Technicals()

◆ UIOrder()

◆ UserDefinedLayers()

◆ UserMask()

◆ Users()