LibrePCB Developers Documentation
MaskConfig Class Referencefinal

The MaskConfig class defines how to add automatic stop mask or solder paste. More...

#include <maskconfig.h>

+ Collaboration diagram for MaskConfig:

Public Member Functions

 MaskConfig ()=delete
 
 MaskConfig (const MaskConfig &other) noexcept
 
 ~MaskConfig () noexcept
 
bool isEnabled () const noexcept
 
const tl::optional< Length > & getOffset () const noexcept
 
bool operator== (const MaskConfig &rhs) const noexcept
 
bool operator!= (const MaskConfig &rhs) const noexcept
 
MaskConfigoperator= (const MaskConfig &rhs) noexcept
 

Static Public Member Functions

static MaskConfig off () noexcept
 
static MaskConfig automatic () noexcept
 
static MaskConfig manual (const Length &offset) noexcept
 
static MaskConfig maybe (const tl::optional< Length > &offset) noexcept
 

Private Member Functions

 MaskConfig (bool enabled, const tl::optional< Length > &offset) noexcept
 

Private Attributes

bool mEnabled
 Whether an automatic mask is added or not. More...
 
tl::optional< LengthmOffset
 nullopt means "from design rules" More...
 

Detailed Description

The MaskConfig class defines how to add automatic stop mask or solder paste.

Constructor & Destructor Documentation

◆ MaskConfig() [1/3]

MaskConfig ( )
delete
+ Here is the caller graph for this function:

◆ MaskConfig() [2/3]

MaskConfig ( const MaskConfig other)
noexcept

◆ ~MaskConfig()

~MaskConfig ( )
noexcept

◆ MaskConfig() [3/3]

MaskConfig ( bool  enabled,
const tl::optional< Length > &  offset 
)
privatenoexcept

Member Function Documentation

◆ isEnabled()

bool isEnabled ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getOffset()

const tl::optional<Length>& getOffset ( ) const
inlinenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator==()

bool operator== ( const MaskConfig rhs) const
noexcept
+ Here is the caller graph for this function:

◆ operator!=()

bool operator!= ( const MaskConfig rhs) const
inlinenoexcept
+ Here is the call graph for this function:

◆ operator=()

MaskConfig & operator= ( const MaskConfig rhs)
noexcept
+ Here is the caller graph for this function:

◆ off()

static MaskConfig off ( )
inlinestaticnoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ automatic()

static MaskConfig automatic ( )
inlinestaticnoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ manual()

static MaskConfig manual ( const Length offset)
inlinestaticnoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ maybe()

static MaskConfig maybe ( const tl::optional< Length > &  offset)
inlinestaticnoexcept
+ Here is the call graph for this function:

Member Data Documentation

◆ mEnabled

bool mEnabled
private

Whether an automatic mask is added or not.

◆ mOffset

tl::optional<Length> mOffset
private

nullopt means "from design rules"


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