KiCad PCB EDA Suite
Loading...
Searching...
No Matches
LSEQ Class Reference

LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs. More...

#include <layer_ids.h>

Inheritance diagram for LSEQ:

Public Member Functions

 LSEQ ()
 
template<class InputIterator >
 LSEQ (InputIterator aStart, InputIterator aEnd)
 
 LSEQ (std::initializer_list< PCB_LAYER_ID > aLayers)
 
void Rewind ()
 
void operator++ ()
 
void operator++ (int)
 
 operator bool ()
 
PCB_LAYER_ID operator* () const
 
int TestLayers (PCB_LAYER_ID aRhs, PCB_LAYER_ID aLhs) const
 

Public Attributes

PCB_LAYER_ID elements
 STL member. More...
 

Private Attributes

unsigned m_index
 

Detailed Description

LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.

A sequence provides a certain order.

It can also be used as an iterator:

 for( LSEQ cu_stack = aSet.CuStack();  cu_stack;  ++cu_stack )
 {
     layer_id = *cu_stack;
     :
     things to do with layer_id;
 }

Definition at line 518 of file layer_ids.h.

Constructor & Destructor Documentation

◆ LSEQ() [1/3]

LSEQ::LSEQ ( )
inline

Definition at line 524 of file layer_ids.h.

◆ LSEQ() [2/3]

template<class InputIterator >
LSEQ::LSEQ ( InputIterator  aStart,
InputIterator  aEnd 
)
inline

Definition at line 529 of file layer_ids.h.

◆ LSEQ() [3/3]

LSEQ::LSEQ ( std::initializer_list< PCB_LAYER_ID aLayers)
inline

Definition at line 533 of file layer_ids.h.

Member Function Documentation

◆ operator bool()

LSEQ::operator bool ( )
inline

Definition at line 543 of file layer_ids.h.

◆ operator*()

PCB_LAYER_ID LSEQ::operator* ( ) const
inline

Definition at line 545 of file layer_ids.h.

◆ operator++() [1/2]

void LSEQ::operator++ ( )
inline

Definition at line 539 of file layer_ids.h.

◆ operator++() [2/2]

void LSEQ::operator++ ( int  )
inline

Definition at line 541 of file layer_ids.h.

◆ Rewind()

void LSEQ::Rewind ( )
inline

Definition at line 537 of file layer_ids.h.

◆ TestLayers()

int LSEQ::TestLayers ( PCB_LAYER_ID  aRhs,
PCB_LAYER_ID  aLhs 
) const
inline

Definition at line 550 of file layer_ids.h.

Referenced by BOOST_AUTO_TEST_CASE().

Member Data Documentation

◆ elements

PCB_LAYER_ID std::vector< PCB_LAYER_ID >::elements
inherited

STL member.

◆ m_index

unsigned LSEQ::m_index
private

Definition at line 520 of file layer_ids.h.


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