Board Class Reference

The Board class represents a PCB of a project and is always part of a circuit. More...

#include <board.h>

Inherits QObject.

Collaboration diagram for Board:

Signals
void	attributesChanged ()
void	designRulesModified ()
void	innerLayerCountChanged ()
void	deviceAdded (BI_Device &device)
void	deviceRemoved (BI_Device &device)
void	netSegmentAdded (BI_NetSegment &netSegment)
void	netSegmentRemoved (BI_NetSegment &netSegment)
void	planeAdded (BI_Plane &plane)
void	planeRemoved (BI_Plane &plane)
void	zoneAdded (BI_Zone &zone)
void	zoneRemoved (BI_Zone &zone)
void	polygonAdded (BI_Polygon &polygon)
void	polygonRemoved (BI_Polygon &polygon)
void	strokeTextAdded (BI_StrokeText &strokeText)
void	strokeTextRemoved (BI_StrokeText &strokeText)
void	holeAdded (BI_Hole &hole)
void	holeRemoved (BI_Hole &hole)
void	airWireAdded (BI_AirWire &airWire)
void	airWireRemoved (BI_AirWire &airWire)

Public Member Functions
	Board ()=delete
	Board (const Board &other)=delete
	Board (Project &project, std::unique_ptr< TransactionalDirectory > directory, const QString &directoryName, const Uuid &uuid, const ElementName &name)
	~Board () noexcept
Project &	getProject () const noexcept
const QString &	getDirectoryName () const noexcept
TransactionalDirectory &	getDirectory () noexcept
const BoardDesignRules &	getDesignRules () const noexcept
const BoardDesignRuleCheckSettings &	getDrcSettings () const noexcept
BoardFabricationOutputSettings &	getFabricationOutputSettings () noexcept
const BoardFabricationOutputSettings &	getFabricationOutputSettings () const noexcept
bool	isEmpty () const noexcept
QList< BI_Base * >	getAllItems () const noexcept
std::shared_ptr< SceneData3D >	buildScene3D (const std::optional< Uuid > &assemblyVariant) const noexcept
const Uuid &	getUuid () const noexcept
const ElementName &	getName () const noexcept
const QString &	getDefaultFontName () const noexcept
const PositiveLength &	getGridInterval () const noexcept
const LengthUnit &	getGridUnit () const noexcept
int	getInnerLayerCount () const noexcept
const QSet< const Layer * >	getCopperLayers () const noexcept
const PositiveLength &	getPcbThickness () const noexcept
const PcbColor *	getSolderResist () const noexcept
const PcbColor &	getSilkscreenColor () const noexcept
const PcbColor *	getSilkscreenColorTop () const noexcept
const PcbColor *	getSilkscreenColorBot () const noexcept
const QVector< const Layer * > &	getSilkscreenLayersTop () const noexcept
const QVector< const Layer * > &	getSilkscreenLayersBot () const noexcept
const QMap< QString, bool > &	getLayersVisibility () const noexcept
void	setName (const ElementName &name) noexcept
void	setDefaultFontName (const QString &name) noexcept
void	setGridInterval (const PositiveLength &interval) noexcept
void	setGridUnit (const LengthUnit &unit) noexcept
void	setInnerLayerCount (int count) noexcept
void	setPcbThickness (const PositiveLength &t) noexcept
void	setSolderResist (const PcbColor *c) noexcept
void	setSilkscreenColor (const PcbColor &c) noexcept
void	setSilkscreenLayersTop (const QVector< const Layer * > &l) noexcept
void	setSilkscreenLayersBot (const QVector< const Layer * > &l) noexcept
void	setLayersVisibility (const QMap< QString, bool > &visibility) noexcept
void	setDesignRules (const BoardDesignRules &rules) noexcept
void	setDrcSettings (const BoardDesignRuleCheckSettings &settings) noexcept
const QSet< SExpression > &	getDrcMessageApprovals () const noexcept
void	loadDrcMessageApprovals (const Version &version, const QSet< SExpression > &approvals) noexcept
bool	updateDrcMessageApprovals (QSet< SExpression > approvals, bool partialRun) noexcept
void	setDrcMessageApproved (const SExpression &approval, bool approved) noexcept
const QMap< Uuid, BI_Device * > &	getDeviceInstances () const noexcept
BI_Device *	getDeviceInstanceByComponentUuid (const Uuid &uuid) const noexcept
void	addDeviceInstance (BI_Device &instance)
void	removeDeviceInstance (BI_Device &instance)
const QMap< Uuid, BI_NetSegment * > &	getNetSegments () const noexcept
void	addNetSegment (BI_NetSegment &netsegment)
void	removeNetSegment (BI_NetSegment &netsegment)
const QMap< Uuid, BI_Plane * > &	getPlanes () const noexcept
void	addPlane (BI_Plane &plane)
void	removePlane (BI_Plane &plane)
void	invalidatePlanes (const Layer *layer=nullptr) noexcept
void	invalidatePlanes (const QSet< const Layer * > &layers) noexcept
QSet< const Layer * >	takeScheduledLayersForPlanesRebuild (const QSet< const Layer * > &layers) noexcept
const QMap< Uuid, BI_Zone * > &	getZones () const noexcept
void	addZone (BI_Zone &zone)
void	removeZone (BI_Zone &zone)
const QMap< Uuid, BI_Polygon * > &	getPolygons () const noexcept
void	addPolygon (BI_Polygon &polygon)
void	removePolygon (BI_Polygon &polygon)
const QMap< Uuid, BI_StrokeText * > &	getStrokeTexts () const noexcept
void	addStrokeText (BI_StrokeText &text)
void	removeStrokeText (BI_StrokeText &text)
const QMap< Uuid, BI_Hole * > &	getHoles () const noexcept
void	addHole (BI_Hole &hole)
void	removeHole (BI_Hole &hole)
QList< BI_AirWire * >	getAirWires () const noexcept
void	scheduleAirWiresRebuild (NetSignal *netsignal) noexcept
void	triggerAirWiresRebuild () noexcept
void	forceAirWiresRebuild () noexcept
std::optional< std::pair< Point, Point > >	calculateBoundingRect () const noexcept
void	addDefaultContent ()
void	copyFrom (const Board &other)
void	addToProject ()
void	removeFromProject ()
void	save ()
Board &	operator= (const Board &rhs)=delete
bool	operator== (const Board &rhs) const noexcept
bool	operator!= (const Board &rhs) const noexcept

Private Attributes
Project &	mProject
	A reference to the Project object (from the ctor)
const QString	mDirectoryName
std::unique_ptr< TransactionalDirectory >	mDirectory
bool	mIsAddedToProject
QScopedPointer< BoardDesignRules >	mDesignRules
QScopedPointer< BoardDesignRuleCheckSettings >	mDrcSettings
QScopedPointer< BoardFabricationOutputSettings >	mFabricationOutputSettings
QSet< NetSignal * >	mScheduledNetSignalsForAirWireRebuild
QSet< const Layer * >	mScheduledLayersForPlanesRebuild
Uuid	mUuid
ElementName	mName
QString	mDefaultFontFileName
PositiveLength	mGridInterval
LengthUnit	mGridUnit
int	mInnerLayerCount
QSet< const Layer * >	mCopperLayers
	Derived from mInnerLayerCount.
PositiveLength	mPcbThickness
	Total PCB thickness (all layers)
const PcbColor *	mSolderResist
	nullptr means no solder resist!
const PcbColor *	mSilkscreenColor
	Must never be nullptr!
QVector< const Layer * >	mSilkscreenLayersTop
QVector< const Layer * >	mSilkscreenLayersBot
QMap< QString, bool >	mLayersVisibility
Version	mDrcMessageApprovalsVersion
QSet< SExpression >	mDrcMessageApprovals
QSet< SExpression >	mSupportedDrcMessageApprovals
QMap< Uuid, BI_Device * >	mDeviceInstances
QMap< Uuid, BI_NetSegment * >	mNetSegments
QMap< Uuid, BI_Plane * >	mPlanes
QMap< Uuid, BI_Zone * >	mZones
QMap< Uuid, BI_Polygon * >	mPolygons
QMap< Uuid, BI_StrokeText * >	mStrokeTexts
QMap< Uuid, BI_Hole * >	mHoles
QMultiHash< NetSignal *, BI_AirWire * >	mAirWires

Detailed Description

The Board class represents a PCB of a project and is always part of a circuit.

Constructor & Destructor Documentation

Board() [1/3]

Board ( )

delete

Board() [2/3]

Board ( const Board &  other )

delete

Board() [3/3]

Board	(	Project &	project,
		std::unique_ptr< TransactionalDirectory >	directory,
		const QString &	directoryName,
		const Uuid &	uuid,
		const ElementName &	name
	)

Here is the call graph for this function:

~Board()

~Board ( )

noexcept

Member Function Documentation

getProject()

Project & getProject ( ) const

inlinenoexcept

Here is the caller graph for this function:

getDirectoryName()

const QString & getDirectoryName ( ) const

inlinenoexcept

Here is the caller graph for this function:

getDirectory()

TransactionalDirectory & getDirectory ( )

inlinenoexcept

Here is the caller graph for this function:

getDesignRules()

const BoardDesignRules & getDesignRules ( ) const

inlinenoexcept

Here is the caller graph for this function:

getDrcSettings()

const BoardDesignRuleCheckSettings & getDrcSettings ( ) const

inlinenoexcept

Here is the caller graph for this function:

getFabricationOutputSettings() [1/2]

BoardFabricationOutputSettings & getFabricationOutputSettings ( )

inlinenoexcept

Here is the caller graph for this function:

getFabricationOutputSettings() [2/2]

const BoardFabricationOutputSettings & getFabricationOutputSettings ( ) const

inlinenoexcept

isEmpty()

bool isEmpty ( ) const

noexcept

getAllItems()

QList< BI_Base * > getAllItems ( ) const

noexcept

Here is the caller graph for this function:

buildScene3D()

std::shared_ptr< SceneData3D > buildScene3D ( const std::optional< Uuid > &  assemblyVariant ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

getUuid()

const Uuid & getUuid ( ) const

inlinenoexcept

Here is the caller graph for this function:

getName()

const ElementName & getName ( ) const

inlinenoexcept

Here is the caller graph for this function:

getDefaultFontName()

const QString & getDefaultFontName ( ) const

inlinenoexcept

Here is the caller graph for this function:

getGridInterval()

const PositiveLength & getGridInterval ( ) const

inlinenoexcept

Here is the caller graph for this function:

getGridUnit()

const LengthUnit & getGridUnit ( ) const

inlinenoexcept

Here is the caller graph for this function:

getInnerLayerCount()

int getInnerLayerCount ( ) const

inlinenoexcept

Here is the caller graph for this function:

getCopperLayers()

const QSet< const Layer * > getCopperLayers ( ) const

inlinenoexcept

Here is the caller graph for this function:

getPcbThickness()

const PositiveLength & getPcbThickness ( ) const

inlinenoexcept

Here is the caller graph for this function:

getSolderResist()

const PcbColor * getSolderResist ( ) const

inlinenoexcept

Here is the caller graph for this function:

getSilkscreenColor()

const PcbColor & getSilkscreenColor ( ) const

inlinenoexcept

Here is the caller graph for this function:

getSilkscreenColorTop()

const PcbColor * getSilkscreenColorTop ( ) const

inlinenoexcept

Here is the caller graph for this function:

getSilkscreenColorBot()

const PcbColor * getSilkscreenColorBot ( ) const

inlinenoexcept

Here is the caller graph for this function:

getSilkscreenLayersTop()

const QVector< const Layer * > & getSilkscreenLayersTop ( ) const

inlinenoexcept

Here is the caller graph for this function:

getSilkscreenLayersBot()

const QVector< const Layer * > & getSilkscreenLayersBot ( ) const

inlinenoexcept

Here is the caller graph for this function:

getLayersVisibility()

const QMap< QString, bool > & getLayersVisibility ( ) const

inlinenoexcept

setName()

void setName ( const ElementName &  name )

inlinenoexcept

Here is the caller graph for this function:

setDefaultFontName()

void setDefaultFontName ( const QString &  name )

inlinenoexcept

Here is the caller graph for this function:

setGridInterval()

void setGridInterval ( const PositiveLength &  interval )

inlinenoexcept

Here is the caller graph for this function:

setGridUnit()

void setGridUnit ( const LengthUnit &  unit )

inlinenoexcept

Here is the caller graph for this function:

setInnerLayerCount()

void setInnerLayerCount ( int  count )

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

setPcbThickness()

void setPcbThickness ( const PositiveLength &  t )

inlinenoexcept

Here is the caller graph for this function:

setSolderResist()

void setSolderResist ( const PcbColor *  c )

inlinenoexcept

Here is the caller graph for this function:

setSilkscreenColor()

void setSilkscreenColor ( const PcbColor &  c )

inlinenoexcept

Here is the caller graph for this function:

setSilkscreenLayersTop()

void setSilkscreenLayersTop ( const QVector< const Layer * > &  l )

inlinenoexcept

Here is the caller graph for this function:

setSilkscreenLayersBot()

void setSilkscreenLayersBot ( const QVector< const Layer * > &  l )

inlinenoexcept

Here is the caller graph for this function:

setLayersVisibility()

void setLayersVisibility ( const QMap< QString, bool > &  visibility )

inlinenoexcept

Here is the caller graph for this function:

setDesignRules()

void setDesignRules ( const BoardDesignRules &  rules )

noexcept

Here is the caller graph for this function:

setDrcSettings()

void setDrcSettings ( const BoardDesignRuleCheckSettings &  settings )

noexcept

Here is the caller graph for this function:

getDrcMessageApprovals()

const QSet< SExpression > & getDrcMessageApprovals ( ) const

inlinenoexcept

Here is the caller graph for this function:

loadDrcMessageApprovals()

void loadDrcMessageApprovals ( const Version &  version, const QSet< SExpression > &  approvals  )

noexcept

Here is the caller graph for this function:

updateDrcMessageApprovals()

bool updateDrcMessageApprovals ( QSet< SExpression >  approvals, bool  partialRun  )

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

setDrcMessageApproved()

void setDrcMessageApproved ( const SExpression &  approval, bool  approved  )

noexcept

getDeviceInstances()

const QMap< Uuid, BI_Device * > & getDeviceInstances ( ) const

inlinenoexcept

Here is the caller graph for this function:

getDeviceInstanceByComponentUuid()

BI_Device * getDeviceInstanceByComponentUuid ( const Uuid &  uuid ) const

noexcept

Here is the caller graph for this function:

addDeviceInstance()

void addDeviceInstance

(

BI_Device &

instance

)

Here is the call graph for this function:

Here is the caller graph for this function:

removeDeviceInstance()

void removeDeviceInstance

(

BI_Device &

instance

)

Here is the call graph for this function:

Here is the caller graph for this function:

getNetSegments()

const QMap< Uuid, BI_NetSegment * > & getNetSegments ( ) const

inlinenoexcept

Here is the caller graph for this function:

addNetSegment()

void addNetSegment

(

BI_NetSegment &

netsegment

)

Here is the call graph for this function:

Here is the caller graph for this function:

removeNetSegment()

void removeNetSegment

(

BI_NetSegment &

netsegment

)

Here is the call graph for this function:

Here is the caller graph for this function:

getPlanes()

const QMap< Uuid, BI_Plane * > & getPlanes ( ) const

inlinenoexcept

Here is the caller graph for this function:

addPlane()

void addPlane

(

BI_Plane &

plane

)

Here is the call graph for this function:

Here is the caller graph for this function:

removePlane()

void removePlane

(

BI_Plane &

plane

)

Here is the call graph for this function:

Here is the caller graph for this function:

invalidatePlanes() [1/2]

void invalidatePlanes ( const Layer *  layer = nullptr )

noexcept

Here is the caller graph for this function:

invalidatePlanes() [2/2]

void invalidatePlanes ( const QSet< const Layer * > &  layers )

noexcept

Here is the call graph for this function:

takeScheduledLayersForPlanesRebuild()

QSet< const Layer * > takeScheduledLayersForPlanesRebuild ( const QSet< const Layer * > &  layers )

noexcept

getZones()

const QMap< Uuid, BI_Zone * > & getZones ( ) const

inlinenoexcept

Here is the caller graph for this function:

addZone()

void addZone

(

BI_Zone &

zone

)

Here is the call graph for this function:

Here is the caller graph for this function:

removeZone()

void removeZone

(

BI_Zone &

zone

)

Here is the call graph for this function:

Here is the caller graph for this function:

getPolygons()

const QMap< Uuid, BI_Polygon * > & getPolygons ( ) const

inlinenoexcept

Here is the caller graph for this function:

addPolygon()

void addPolygon

(

BI_Polygon &

polygon

)

Here is the call graph for this function:

Here is the caller graph for this function:

removePolygon()

void removePolygon

(

BI_Polygon &

polygon

)

Here is the call graph for this function:

Here is the caller graph for this function:

getStrokeTexts()

const QMap< Uuid, BI_StrokeText * > & getStrokeTexts ( ) const

inlinenoexcept

Here is the caller graph for this function:

addStrokeText()

void addStrokeText

(

BI_StrokeText &

text

)

Here is the call graph for this function:

Here is the caller graph for this function:

removeStrokeText()

void removeStrokeText

(

BI_StrokeText &

text

)

Here is the call graph for this function:

Here is the caller graph for this function:

getHoles()

const QMap< Uuid, BI_Hole * > & getHoles ( ) const

inlinenoexcept

Here is the caller graph for this function:

addHole()

void addHole

(

BI_Hole &

hole

)

Here is the call graph for this function:

Here is the caller graph for this function:

removeHole()

void removeHole

(

BI_Hole &

hole

)

Here is the call graph for this function:

Here is the caller graph for this function:

getAirWires()

QList< BI_AirWire * > getAirWires ( ) const

inlinenoexcept

scheduleAirWiresRebuild()

void scheduleAirWiresRebuild ( NetSignal *  netsignal )

inlinenoexcept

Here is the caller graph for this function:

triggerAirWiresRebuild()

void triggerAirWiresRebuild ( )

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

forceAirWiresRebuild()

void forceAirWiresRebuild ( )

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

calculateBoundingRect()

std::optional< std::pair< Point, Point > > calculateBoundingRect ( ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

addDefaultContent()

void addDefaultContent

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

copyFrom()

void copyFrom

(

const Board &

other

)

Here is the call graph for this function:

Here is the caller graph for this function:

addToProject()

void addToProject

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

removeFromProject()

void removeFromProject

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

save()

void save

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

Board & operator= ( const Board &  rhs )

delete

operator==()

bool operator== ( const Board &  rhs ) const

inlinenoexcept

operator!=()

bool operator!= ( const Board &  rhs ) const

inlinenoexcept

attributesChanged

void attributesChanged ( )

signal

Here is the caller graph for this function:

designRulesModified

void designRulesModified ( )

signal

Here is the caller graph for this function:

innerLayerCountChanged

void innerLayerCountChanged ( )

signal

Here is the caller graph for this function:

deviceAdded

void deviceAdded ( BI_Device &  device )

signal

Here is the caller graph for this function:

deviceRemoved

void deviceRemoved ( BI_Device &  device )

signal

Here is the caller graph for this function:

netSegmentAdded

void netSegmentAdded ( BI_NetSegment &  netSegment )

signal

Here is the caller graph for this function:

netSegmentRemoved

void netSegmentRemoved ( BI_NetSegment &  netSegment )

signal

Here is the caller graph for this function:

planeAdded

void planeAdded ( BI_Plane &  plane )

signal

Here is the caller graph for this function:

planeRemoved

void planeRemoved ( BI_Plane &  plane )

signal

Here is the caller graph for this function:

zoneAdded

void zoneAdded ( BI_Zone &  zone )

signal

Here is the caller graph for this function:

zoneRemoved

void zoneRemoved ( BI_Zone &  zone )

signal

Here is the caller graph for this function:

polygonAdded

void polygonAdded ( BI_Polygon &  polygon )

signal

Here is the caller graph for this function:

polygonRemoved

void polygonRemoved ( BI_Polygon &  polygon )

signal

Here is the caller graph for this function:

strokeTextAdded

void strokeTextAdded ( BI_StrokeText &  strokeText )

signal

Here is the caller graph for this function:

strokeTextRemoved

void strokeTextRemoved ( BI_StrokeText &  strokeText )

signal

Here is the caller graph for this function:

holeAdded

void holeAdded ( BI_Hole &  hole )

signal

Here is the caller graph for this function:

holeRemoved

void holeRemoved ( BI_Hole &  hole )

signal

Here is the caller graph for this function:

airWireAdded

void airWireAdded ( BI_AirWire &  airWire )

signal

Here is the caller graph for this function:

airWireRemoved

void airWireRemoved ( BI_AirWire &  airWire )

signal

Here is the caller graph for this function:

Member Data Documentation

mProject

Project& mProject

private

A reference to the Project object (from the ctor)

mDirectoryName

const QString mDirectoryName

private

mDirectory

std::unique_ptr<TransactionalDirectory> mDirectory

private

mIsAddedToProject

bool mIsAddedToProject

private

mDesignRules

QScopedPointer<BoardDesignRules> mDesignRules

private

mDrcSettings

QScopedPointer<BoardDesignRuleCheckSettings> mDrcSettings

private

mFabricationOutputSettings

QScopedPointer<BoardFabricationOutputSettings> mFabricationOutputSettings

private

mScheduledNetSignalsForAirWireRebuild

QSet<NetSignal*> mScheduledNetSignalsForAirWireRebuild

private

mScheduledLayersForPlanesRebuild

QSet<const Layer*> mScheduledLayersForPlanesRebuild

private

mUuid

Uuid mUuid

private

mName

ElementName mName

private

mDefaultFontFileName

QString mDefaultFontFileName

private

mGridInterval

PositiveLength mGridInterval

private

mGridUnit

LengthUnit mGridUnit

private

mInnerLayerCount

int mInnerLayerCount

private

mCopperLayers

QSet<const Layer*> mCopperLayers

private

Derived from mInnerLayerCount.

mPcbThickness

PositiveLength mPcbThickness

private

Total PCB thickness (all layers)

mSolderResist

const PcbColor* mSolderResist

private

nullptr means no solder resist!

mSilkscreenColor

const PcbColor* mSilkscreenColor

private

Must never be nullptr!

mSilkscreenLayersTop

QVector<const Layer*> mSilkscreenLayersTop

private

mSilkscreenLayersBot

QVector<const Layer*> mSilkscreenLayersBot

private

mLayersVisibility

QMap<QString, bool> mLayersVisibility

private

mDrcMessageApprovalsVersion

Version mDrcMessageApprovalsVersion

private

mDrcMessageApprovals

QSet<SExpression> mDrcMessageApprovals

private

mSupportedDrcMessageApprovals

QSet<SExpression> mSupportedDrcMessageApprovals

private

mDeviceInstances

QMap<Uuid, BI_Device*> mDeviceInstances

private

mNetSegments

QMap<Uuid, BI_NetSegment*> mNetSegments

private

mPlanes

QMap<Uuid, BI_Plane*> mPlanes

private

mZones

QMap<Uuid, BI_Zone*> mZones

private

mPolygons

QMap<Uuid, BI_Polygon*> mPolygons

private

mStrokeTexts

QMap<Uuid, BI_StrokeText*> mStrokeTexts

private

mHoles

QMap<Uuid, BI_Hole*> mHoles

private

mAirWires

QMultiHash<NetSignal*, BI_AirWire*> mAirWires

private

---

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

• /__w/1/s/libs/librepcb/core/project/board/board.h
• /__w/1/s/libs/librepcb/core/project/board/board.cpp