BoardDesignRules Class Reference

The BoardDesignRules class. More...

#include <boarddesignrules.h>

Collaboration diagram for BoardDesignRules:

Public Member Functions
	BoardDesignRules () noexcept
	BoardDesignRules (const BoardDesignRules &other)
	BoardDesignRules (const SExpression &node)
	~BoardDesignRules () noexcept
const UnsignedLength &	getStopMaskMaxViaDiameter () const noexcept
const BoundedUnsignedRatio &	getStopMaskClearance () const noexcept
const BoundedUnsignedRatio &	getSolderPasteClearance () const noexcept
bool	getPadCmpSideAutoAnnularRing () const noexcept
bool	getPadInnerAutoAnnularRing () const noexcept
const BoundedUnsignedRatio &	getPadAnnularRing () const noexcept
const BoundedUnsignedRatio &	getViaAnnularRing () const noexcept
void	setStopMaskMaxViaDiameter (const UnsignedLength &dia) noexcept
void	setStopMaskClearance (const BoundedUnsignedRatio &value) noexcept
void	setSolderPasteClearance (const BoundedUnsignedRatio &value) noexcept
void	setPadCmpSideAutoAnnularRing (bool enabled) noexcept
void	setPadInnerAutoAnnularRing (bool enabled) noexcept
void	setPadAnnularRing (const BoundedUnsignedRatio &value)
void	setViaAnnularRing (const BoundedUnsignedRatio &value)
void	restoreDefaults () noexcept
void	serialize (SExpression &root) const
	Serialize into librepcb::SExpression node.
bool	doesViaRequireStopMaskOpening (const Length &drillDia) const noexcept
BoardDesignRules &	operator= (const BoardDesignRules &rhs) noexcept
bool	operator== (const BoardDesignRules &rhs) const noexcept
bool	operator!= (const BoardDesignRules &rhs) const noexcept

Static Private Member Functions
static bool	parsePadAutoAnnular (const SExpression &node)

Private Attributes
UnsignedLength	mStopMaskMaxViaDrillDiameter
BoundedUnsignedRatio	mStopMaskClearance
BoundedUnsignedRatio	mSolderPasteClearance
bool	mPadCmpSideAutoAnnularRing
bool	mPadInnerAutoAnnularRing
BoundedUnsignedRatio	mPadAnnularRing
BoundedUnsignedRatio	mViaAnnularRing
	Percentage of the drill diameter.

Detailed Description

The BoardDesignRules class.

Constructor & Destructor Documentation

BoardDesignRules() [1/3]

BoardDesignRules ( )

noexcept

Here is the caller graph for this function:

BoardDesignRules() [2/3]

BoardDesignRules

(

const BoardDesignRules &

other

)

BoardDesignRules() [3/3]

BoardDesignRules ( const SExpression &  node )

explicit

~BoardDesignRules()

~BoardDesignRules ( )

noexcept

Member Function Documentation

getStopMaskMaxViaDiameter()

const UnsignedLength & getStopMaskMaxViaDiameter ( ) const

inlinenoexcept

Here is the caller graph for this function:

getStopMaskClearance()

const BoundedUnsignedRatio & getStopMaskClearance ( ) const

inlinenoexcept

Here is the caller graph for this function:

getSolderPasteClearance()

const BoundedUnsignedRatio & getSolderPasteClearance ( ) const

inlinenoexcept

Here is the caller graph for this function:

getPadCmpSideAutoAnnularRing()

bool getPadCmpSideAutoAnnularRing ( ) const

inlinenoexcept

Here is the caller graph for this function:

getPadInnerAutoAnnularRing()

bool getPadInnerAutoAnnularRing ( ) const

inlinenoexcept

Here is the caller graph for this function:

getPadAnnularRing()

const BoundedUnsignedRatio & getPadAnnularRing ( ) const

inlinenoexcept

Here is the caller graph for this function:

getViaAnnularRing()

const BoundedUnsignedRatio & getViaAnnularRing ( ) const

inlinenoexcept

Here is the caller graph for this function:

setStopMaskMaxViaDiameter()

void setStopMaskMaxViaDiameter ( const UnsignedLength &  dia )

inlinenoexcept

Here is the caller graph for this function:

setStopMaskClearance()

void setStopMaskClearance ( const BoundedUnsignedRatio &  value )

inlinenoexcept

Here is the caller graph for this function:

setSolderPasteClearance()

void setSolderPasteClearance ( const BoundedUnsignedRatio &  value )

inlinenoexcept

Here is the caller graph for this function:

setPadCmpSideAutoAnnularRing()

void setPadCmpSideAutoAnnularRing ( bool  enabled )

inlinenoexcept

Here is the caller graph for this function:

setPadInnerAutoAnnularRing()

void setPadInnerAutoAnnularRing ( bool  enabled )

inlinenoexcept

Here is the caller graph for this function:

setPadAnnularRing()

void setPadAnnularRing ( const BoundedUnsignedRatio &  value )

inline

Here is the caller graph for this function:

setViaAnnularRing()

void setViaAnnularRing ( const BoundedUnsignedRatio &  value )

inline

Here is the caller graph for this function:

restoreDefaults()

void restoreDefaults ( )

noexcept

Here is the call graph for this function:

serialize()

void serialize

(

SExpression &

root

)

const

Serialize into librepcb::SExpression node.

Parameters

root	Root node to serialize into.

Here is the call graph for this function:

doesViaRequireStopMaskOpening()

bool doesViaRequireStopMaskOpening ( const Length &  drillDia ) const

noexcept

Here is the caller graph for this function:

operator=()

BoardDesignRules & operator= ( const BoardDesignRules &  rhs )

noexcept

operator==()

bool operator== ( const BoardDesignRules &  rhs ) const

noexcept

operator!=()

bool operator!= ( const BoardDesignRules &  rhs ) const

inlinenoexcept

parsePadAutoAnnular()

bool parsePadAutoAnnular ( const SExpression &  node )

staticprivate

Here is the call graph for this function:

Member Data Documentation

mStopMaskMaxViaDrillDiameter

UnsignedLength mStopMaskMaxViaDrillDiameter

private

mStopMaskClearance

BoundedUnsignedRatio mStopMaskClearance

private

mSolderPasteClearance

BoundedUnsignedRatio mSolderPasteClearance

private

mPadCmpSideAutoAnnularRing

bool mPadCmpSideAutoAnnularRing

private

mPadInnerAutoAnnularRing

bool mPadInnerAutoAnnularRing

private

mPadAnnularRing

BoundedUnsignedRatio mPadAnnularRing

private

mViaAnnularRing

BoundedUnsignedRatio mViaAnnularRing

private

Percentage of the drill diameter.

---

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

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