lset.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LSET_H
#define LSET_H
 
#include <layer_ids.h>
#include <base_set.h>
 
class LSEQ;
 
class KICOMMON_API LSET : public BASE_SET
{
public:
 
 // The constructor flavors are carefully chosen to prevent LSET( int ) from compiling.
 // That excludes "LSET s = 0;" and excludes "LSET s = -1;", etc.
 // LSET s = 0; needs to be removed from the code, this accomplishes that.
 // Remember LSET( PCB_LAYER_ID(0) ) sets bit 0, so "LSET s = 0;" is illegal
 // to prevent that surprise. Therefore LSET's constructor suite is significantly
 // different than the base class from which it is derived.
 
 // Other member functions (non-constructor functions) are identical to the base
 // class's and therefore are re-used from the base class.
 
 LSET() :
 BASE_SET(PCB_LAYER_ID_COUNT) // all bits are set to zero in BASE_SET()
 {
 }
 
 LSET( const BASE_SET& aOther ) :
 BASE_SET( aOther )
 {
 }
 
 LSET( PCB_LAYER_ID aLayer ) :
 BASE_SET(PCB_LAYER_ID_COUNT)
 {
 set( aLayer );
 }
 
 LSET( std::initializer_list<PCB_LAYER_ID> aList );
 
 LSET( const LSEQ& aSeq );
 
 LSET( unsigned long __val ) = delete;
 
 bool Contains( PCB_LAYER_ID aLayer )
 {
 try
 {
 return test( aLayer );
 }
 catch( std::out_of_range& )
 {
 return false;
 }
 }
 
 static const wxChar* Name( PCB_LAYER_ID aLayerId );
 
 static LSET InternalCuMask();
 
 static LSET FrontAssembly();
 
 static LSET BackAssembly();
 
 static LSET AllCuMask( int aCuLayerCount = MAX_CU_LAYERS );
 
 static LSET ExternalCuMask();
 
 static LSET AllNonCuMask();
 
 static LSET AllLayersMask();
 
 static LSET FrontTechMask();
 
 static LSET FrontBoardTechMask();
 
 static LSET BackTechMask();
 
 static LSET BackBoardTechMask();
 
 static LSET AllTechMask();
 
 static LSET AllBoardTechMask();
 
 static LSET FrontMask();
 
 static LSET BackMask();
 
 static LSET SideSpecificMask();
 
 static LSET UserMask();
 
 static LSET PhysicalLayersMask();
 
 static LSET UserDefinedLayers();
 
 static LSET ForbiddenFootprintLayers();
 
 LSEQ CuStack() const;
 
 LSEQ Technicals( LSET aSubToOmit = LSET() ) const;
 
 LSEQ Users() const;
 
 LSEQ TechAndUserUIOrder() const;
 
 LSEQ UIOrder() const;
 
 LSEQ Seq( const PCB_LAYER_ID* aWishListSequence, unsigned aCount ) const;
 
 LSEQ Seq( const LSEQ& aSequence ) const;
 
 LSEQ Seq() const;
 
 LSEQ SeqStackupTop2Bottom( PCB_LAYER_ID aSelectedLayer = UNDEFINED_LAYER ) const;
 
 LSEQ SeqStackupForPlotting() const;
 
 void RunOnLayers( const std::function<void( PCB_LAYER_ID )>& aFunction ) const
 {
 for( size_t ii = 0; ii < size(); ++ii )
 {
 if( test( ii ) )
 aFunction( PCB_LAYER_ID( ii ) );
 }
 }
 
 std::string FmtHex() const;
 
 int ParseHex( const char* aStart, int aCount );
 
 std::string FmtBin() const;
 
 PCB_LAYER_ID ExtractLayer() const;
 
 
 LSET& Flip( int aCopperLayersCount = 0 );
 
};
#endif // LSET_H