LibrePCB Developers Documentation
BoardSelectionQuery Class Referencefinal

The BoardSelectionQuery class. More...

#include <boardselectionquery.h>

Inherits QObject.

+ Collaboration diagram for BoardSelectionQuery:

Classes

struct  NetSegmentItems
 

Public Member Functions

 BoardSelectionQuery ()=delete
 
 BoardSelectionQuery (const BoardSelectionQuery &other)=delete
 
 BoardSelectionQuery (BoardGraphicsScene &scene, bool includeLockedItems, QObject *parent=nullptr)
 
 ~BoardSelectionQuery () noexcept
 
const QSet< BI_Device * > & getDeviceInstances () const noexcept
 
const QSet< BI_NetPoint * > & getNetPoints () const noexcept
 
const QSet< BI_NetLine * > & getNetLines () const noexcept
 
const QSet< BI_Via * > & getVias () const noexcept
 
const QSet< BI_Plane * > & getPlanes () const noexcept
 
const QSet< BI_Zone * > & getZones () const noexcept
 
const QSet< BI_Polygon * > & getPolygons () const noexcept
 
const QSet< BI_StrokeText * > & getStrokeTexts () const noexcept
 
const QSet< BI_Hole * > & getHoles () const noexcept
 
QHash< BI_NetSegment *, NetSegmentItemsgetNetSegmentItems () const noexcept
 Get vias, net points and net lines grouped by net segment. More...
 
int getResultCount () const noexcept
 
bool isResultEmpty () const noexcept
 
void addDeviceInstancesOfSelectedFootprints () noexcept
 
void addSelectedVias () noexcept
 
void addSelectedNetPoints () noexcept
 
void addSelectedNetLines () noexcept
 
void addSelectedPlanes () noexcept
 
void addSelectedZones () noexcept
 
void addSelectedPolygons () noexcept
 
void addSelectedBoardStrokeTexts () noexcept
 
void addSelectedFootprintStrokeTexts () noexcept
 
void addSelectedHoles () noexcept
 
void addNetPointsOfNetLines (bool onlyIfAllNetLinesSelected=false) noexcept
 Add net points of the selected net lines. More...
 
BoardSelectionQueryoperator= (const BoardSelectionQuery &rhs)=delete
 

Private Attributes

BoardGraphicsScenemScene
 
const bool mIncludeLockedItems
 
QSet< BI_Device * > mResultDeviceInstances
 
QSet< BI_NetPoint * > mResultNetPoints
 
QSet< BI_NetLine * > mResultNetLines
 
QSet< BI_Via * > mResultVias
 
QSet< BI_Plane * > mResultPlanes
 
QSet< BI_Zone * > mResultZones
 
QSet< BI_Polygon * > mResultPolygons
 
QSet< BI_StrokeText * > mResultStrokeTexts
 
QSet< BI_Hole * > mResultHoles
 

Detailed Description

Constructor & Destructor Documentation

◆ BoardSelectionQuery() [1/3]

BoardSelectionQuery ( )
delete

◆ BoardSelectionQuery() [2/3]

BoardSelectionQuery ( const BoardSelectionQuery other)
delete

◆ BoardSelectionQuery() [3/3]

BoardSelectionQuery ( BoardGraphicsScene scene,
bool  includeLockedItems,
QObject *  parent = nullptr 
)
explicit

◆ ~BoardSelectionQuery()

~BoardSelectionQuery ( )
noexcept

Member Function Documentation

◆ getDeviceInstances()

const QSet< BI_Device * > & getDeviceInstances ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getNetPoints()

const QSet< BI_NetPoint * > & getNetPoints ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getNetLines()

const QSet< BI_NetLine * > & getNetLines ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getVias()

const QSet< BI_Via * > & getVias ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getPlanes()

const QSet< BI_Plane * > & getPlanes ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getZones()

const QSet< BI_Zone * > & getZones ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getPolygons()

const QSet< BI_Polygon * > & getPolygons ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getStrokeTexts()

const QSet< BI_StrokeText * > & getStrokeTexts ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getHoles()

const QSet< BI_Hole * > & getHoles ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getNetSegmentItems()

QHash< BI_NetSegment *, BoardSelectionQuery::NetSegmentItems > getNetSegmentItems ( ) const
noexcept

Get vias, net points and net lines grouped by net segment.

Same as getVias(), getNetPoints() and getNetLines(), but grouped by their corresponding net segments. Only net segments containing selected items are returned.

Returns
List of net segments containing the selected items
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getResultCount()

int getResultCount ( ) const
noexcept
+ Here is the caller graph for this function:

◆ isResultEmpty()

bool isResultEmpty ( ) const
inlinenoexcept
+ Here is the call graph for this function:

◆ addDeviceInstancesOfSelectedFootprints()

void addDeviceInstancesOfSelectedFootprints ( )
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addSelectedVias()

void addSelectedVias ( )
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addSelectedNetPoints()

void addSelectedNetPoints ( )
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addSelectedNetLines()

void addSelectedNetLines ( )
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addSelectedPlanes()

void addSelectedPlanes ( )
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addSelectedZones()

void addSelectedZones ( )
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addSelectedPolygons()

void addSelectedPolygons ( )
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addSelectedBoardStrokeTexts()

void addSelectedBoardStrokeTexts ( )
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addSelectedFootprintStrokeTexts()

void addSelectedFootprintStrokeTexts ( )
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addSelectedHoles()

void addSelectedHoles ( )
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addNetPointsOfNetLines()

void addNetPointsOfNetLines ( bool  onlyIfAllNetLinesSelected = false)
noexcept

Add net points of the selected net lines.

Parameters
onlyIfAllNetLinesSelectedIf true, net points are added only if all connected net lines are selected. If false, net points are added if at least one of the connected net lines is selected.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator=()

BoardSelectionQuery & operator= ( const BoardSelectionQuery rhs)
delete

Member Data Documentation

◆ mScene

BoardGraphicsScene& mScene
private

◆ mIncludeLockedItems

const bool mIncludeLockedItems
private

◆ mResultDeviceInstances

QSet<BI_Device*> mResultDeviceInstances
private

◆ mResultNetPoints

QSet<BI_NetPoint*> mResultNetPoints
private

◆ mResultNetLines

QSet<BI_NetLine*> mResultNetLines
private

◆ mResultVias

QSet<BI_Via*> mResultVias
private

◆ mResultPlanes

QSet<BI_Plane*> mResultPlanes
private

◆ mResultZones

QSet<BI_Zone*> mResultZones
private

◆ mResultPolygons

QSet<BI_Polygon*> mResultPolygons
private

◆ mResultStrokeTexts

QSet<BI_StrokeText*> mResultStrokeTexts
private

◆ mResultHoles

QSet<BI_Hole*> mResultHoles
private

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