LibrePCB Developers Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
BoardDesignRules Class Referencefinal

The BoardDesignRules class. More...

#include <boarddesignrules.h>

+ Inheritance diagram for BoardDesignRules:
+ Collaboration diagram for BoardDesignRules:

Public Member Functions

 BoardDesignRules () noexcept
 
 BoardDesignRules (const BoardDesignRules &other)
 
 BoardDesignRules (const SExpression &node)
 
 ~BoardDesignRules () noexcept
 
const ElementNamegetName () const noexcept
 
const QString & getDescription () const noexcept
 
const UnsignedRatiogetStopMaskClearanceRatio () const noexcept
 
const UnsignedLengthgetStopMaskClearanceMin () const noexcept
 
const UnsignedLengthgetStopMaskClearanceMax () const noexcept
 
const UnsignedLengthgetStopMaskMaxViaDiameter () const noexcept
 
const UnsignedRatiogetCreamMaskClearanceRatio () const noexcept
 
const UnsignedLengthgetCreamMaskClearanceMin () const noexcept
 
const UnsignedLengthgetCreamMaskClearanceMax () const noexcept
 
const UnsignedRatiogetRestringPadRatio () const noexcept
 
const UnsignedLengthgetRestringPadMin () const noexcept
 
const UnsignedLengthgetRestringPadMax () const noexcept
 
const UnsignedRatiogetRestringViaRatio () const noexcept
 
const UnsignedLengthgetRestringViaMin () const noexcept
 
const UnsignedLengthgetRestringViaMax () const noexcept
 
void setName (const ElementName &name) noexcept
 
void setDescription (const QString &desc) noexcept
 
void setStopMaskClearanceRatio (const UnsignedRatio &ratio) noexcept
 
void setStopMaskClearanceBounds (const UnsignedLength &min, const UnsignedLength &max)
 
void setStopMaskMaxViaDiameter (const UnsignedLength &dia) noexcept
 
void setCreamMaskClearanceRatio (const UnsignedRatio &ratio) noexcept
 
void setCreamMaskClearanceBounds (const UnsignedLength &min, const UnsignedLength &max)
 
void setRestringPadRatio (const UnsignedRatio &ratio) noexcept
 
void setRestringPadBounds (const UnsignedLength &min, const UnsignedLength &max)
 
void setRestringViaRatio (const UnsignedRatio &ratio) noexcept
 
void setRestringViaBounds (const UnsignedLength &min, const UnsignedLength &max)
 
void restoreDefaults () noexcept
 
void serialize (SExpression &root) const override
 Serialize the object into an existing S-Expression node. More...
 
bool doesViaRequireStopMask (const Length &drillDia) const noexcept
 
UnsignedLength calcStopMaskClearance (const Length &padSize) const noexcept
 
UnsignedLength calcCreamMaskClearance (const Length &padSize) const noexcept
 
UnsignedLength calcPadRestring (const Length &drillDia) const noexcept
 
UnsignedLength calcViaRestring (const Length &drillDia) const noexcept
 
BoardDesignRulesoperator= (const BoardDesignRules &rhs) noexcept
 
- Public Member Functions inherited from SerializableObject
 SerializableObject () noexcept
 
virtual ~SerializableObject () noexcept
 
SExpression serializeToDomElement (const QString &name) const
 Serialize the object to a new S-Expression node. More...
 

Private Attributes

ElementName mName
 
QString mDescription
 
UnsignedRatio mStopMaskClearanceRatio
 
UnsignedLength mStopMaskClearanceMin
 
UnsignedLength mStopMaskClearanceMax
 
UnsignedLength mStopMaskMaxViaDrillDiameter
 
UnsignedRatio mCreamMaskClearanceRatio
 
UnsignedLength mCreamMaskClearanceMin
 
UnsignedLength mCreamMaskClearanceMax
 
UnsignedRatio mRestringPadRatio
 
UnsignedLength mRestringPadMin
 
UnsignedLength mRestringPadMax
 
UnsignedRatio mRestringViaRatio
 
UnsignedLength mRestringViaMin
 
UnsignedLength mRestringViaMax
 

Additional Inherited Members

- Static Public Member Functions inherited from SerializableObject
template<typename T >
static void serializeObjectContainer (SExpression &root, const T &container, const QString &itemName)
 
template<typename T >
static void serializePointerContainer (SExpression &root, const T &container, const QString &itemName)
 
template<typename T >
static void serializePointerContainerUuidSorted (SExpression &root, const T &container, const QString &itemName)
 

Detailed Description

The BoardDesignRules class.

Author
ubruhin
Date
2016-04-01

Constructor & Destructor Documentation

BoardDesignRules ( )
noexcept

+ Here is the caller graph for this function:

BoardDesignRules ( const BoardDesignRules other)
BoardDesignRules ( const SExpression node)
explicit

+ Here is the call graph for this function:

~BoardDesignRules ( )
noexcept

Member Function Documentation

const ElementName& getName ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const QString& getDescription ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const UnsignedRatio& getStopMaskClearanceRatio ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const UnsignedLength& getStopMaskClearanceMin ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const UnsignedLength& getStopMaskClearanceMax ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const UnsignedLength& getStopMaskMaxViaDiameter ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const UnsignedRatio& getCreamMaskClearanceRatio ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const UnsignedLength& getCreamMaskClearanceMin ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const UnsignedLength& getCreamMaskClearanceMax ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const UnsignedRatio& getRestringPadRatio ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const UnsignedLength& getRestringPadMin ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const UnsignedLength& getRestringPadMax ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const UnsignedRatio& getRestringViaRatio ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const UnsignedLength& getRestringViaMin ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const UnsignedLength& getRestringViaMax ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

void setName ( const ElementName name)
inlinenoexcept

+ Here is the caller graph for this function:

void setDescription ( const QString &  desc)
inlinenoexcept

+ Here is the caller graph for this function:

void setStopMaskClearanceRatio ( const UnsignedRatio ratio)
inlinenoexcept

+ Here is the caller graph for this function:

void setStopMaskClearanceBounds ( const UnsignedLength min,
const UnsignedLength max 
)

+ Here is the caller graph for this function:

void setStopMaskMaxViaDiameter ( const UnsignedLength dia)
inlinenoexcept

+ Here is the caller graph for this function:

void setCreamMaskClearanceRatio ( const UnsignedRatio ratio)
inlinenoexcept

+ Here is the caller graph for this function:

void setCreamMaskClearanceBounds ( const UnsignedLength min,
const UnsignedLength max 
)

+ Here is the caller graph for this function:

void setRestringPadRatio ( const UnsignedRatio ratio)
inlinenoexcept

+ Here is the caller graph for this function:

void setRestringPadBounds ( const UnsignedLength min,
const UnsignedLength max 
)

+ Here is the caller graph for this function:

void setRestringViaRatio ( const UnsignedRatio ratio)
inlinenoexcept

+ Here is the caller graph for this function:

void setRestringViaBounds ( const UnsignedLength min,
const UnsignedLength max 
)

+ Here is the caller graph for this function:

void restoreDefaults ( )
noexcept

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void serialize ( SExpression root) const
overridevirtual

Serialize the object into an existing S-Expression node.

This method inserts/appends all attributes and childs of the object to an existing S-Expression node. The content which already exists in the given S-Expression node will not be removed.

Note
The generated S-Expression node has always the format of the application's major version (it's not possible to generate DOMs of older versions).
Parameters
rootThe target DOM root node
Exceptions
ExceptionThis method throws an exception if an error occurs.

Implements SerializableObject.

+ Here is the call graph for this function:

bool doesViaRequireStopMask ( const Length drillDia) const
noexcept

+ Here is the caller graph for this function:

UnsignedLength calcStopMaskClearance ( const Length padSize) const
noexcept

+ Here is the caller graph for this function:

UnsignedLength calcCreamMaskClearance ( const Length padSize) const
noexcept

+ Here is the caller graph for this function:

UnsignedLength calcPadRestring ( const Length drillDia) const
noexcept
UnsignedLength calcViaRestring ( const Length drillDia) const
noexcept
BoardDesignRules & operator= ( const BoardDesignRules rhs)
noexcept

Member Data Documentation

ElementName mName
private
QString mDescription
private
UnsignedRatio mStopMaskClearanceRatio
private
UnsignedLength mStopMaskClearanceMin
private
UnsignedLength mStopMaskClearanceMax
private
UnsignedLength mStopMaskMaxViaDrillDiameter
private
UnsignedRatio mCreamMaskClearanceRatio
private
UnsignedLength mCreamMaskClearanceMin
private
UnsignedLength mCreamMaskClearanceMax
private
UnsignedRatio mRestringPadRatio
private
UnsignedLength mRestringPadMin
private
UnsignedLength mRestringPadMax
private
UnsignedRatio mRestringViaRatio
private
UnsignedLength mRestringViaMin
private
UnsignedLength mRestringViaMax
private

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