LibrePCB Developers Documentation
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 std::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 std::optional< Length > &offset) noexcept
 

Private Member Functions

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

Private Attributes

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

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 std::optional< Length > &  offset 
)
privatenoexcept

Member Function Documentation

◆ isEnabled()

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

◆ getOffset()

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

◆ operator==()

bool operator== ( const MaskConfig rhs) const
noexcept

◆ operator!=()

bool operator!= ( const MaskConfig rhs) const
inlinenoexcept

◆ operator=()

MaskConfig & operator= ( const MaskConfig rhs)
noexcept

◆ 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 std::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

std::optional<Length> mOffset
private

nullopt means "from design rules"


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