LibrePCB Developers Documentation
Hole Class Referencefinal

The Hole class. More...

#include <hole.h>

+ Collaboration diagram for Hole:

Public Types

enum class  Event
 
typedef Slot< Hole, EventOnEditedSlot
 

Public Member Functions

 Hole ()=delete
 
 Hole (const Hole &other) noexcept
 
 Hole (const Uuid &uuid, const Hole &other) noexcept
 
 Hole (const Uuid &uuid, const PositiveLength &diameter, const NonEmptyPath &path, const MaskConfig &stopMaskConfig) noexcept
 
 Hole (const SExpression &node)
 
 ~Hole () noexcept
 
const UuidgetUuid () const noexcept
 
const PositiveLengthgetDiameter () const noexcept
 
const NonEmptyPathgetPath () const noexcept
 
const MaskConfiggetStopMaskConfig () const noexcept
 
bool isSlot () const noexcept
 
bool isMultiSegmentSlot () const noexcept
 
bool isCurvedSlot () const noexcept
 
tl::optional< LengthgetPreviewStopMaskOffset () const noexcept
 
bool setDiameter (const PositiveLength &diameter) noexcept
 
bool setPath (const NonEmptyPath &path) noexcept
 
bool setStopMaskConfig (const MaskConfig &config) noexcept
 
void serialize (SExpression &root) const
 Serialize into librepcb::SExpression node. More...
 
bool operator== (const Hole &rhs) const noexcept
 
bool operator!= (const Hole &rhs) const noexcept
 
Holeoperator= (const Hole &rhs) noexcept
 

Public Attributes

Signal< Hole, EventonEdited
 

Private Attributes

Uuid mUuid
 
PositiveLength mDiameter
 
NonEmptyPath mPath
 
MaskConfig mStopMaskConfig
 

Detailed Description

The Hole class.

Member Typedef Documentation

◆ OnEditedSlot

Member Enumeration Documentation

◆ Event

enum class Event
strong
Enumerator
UuidChanged 
DiameterChanged 
PathChanged 
StopMaskConfigChanged 

Constructor & Destructor Documentation

◆ Hole() [1/5]

Hole ( )
delete

◆ Hole() [2/5]

Hole ( const Hole other)
noexcept

◆ Hole() [3/5]

Hole ( const Uuid uuid,
const Hole other 
)
noexcept

◆ Hole() [4/5]

Hole ( const Uuid uuid,
const PositiveLength diameter,
const NonEmptyPath path,
const MaskConfig stopMaskConfig 
)
noexcept

◆ Hole() [5/5]

Hole ( const SExpression node)
explicit

◆ ~Hole()

~Hole ( )
noexcept

Member Function Documentation

◆ getUuid()

const Uuid & getUuid ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getDiameter()

const PositiveLength & getDiameter ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getPath()

const NonEmptyPath & getPath ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getStopMaskConfig()

const MaskConfig & getStopMaskConfig ( ) const
inlinenoexcept

◆ isSlot()

bool isSlot ( ) const
noexcept

◆ isMultiSegmentSlot()

bool isMultiSegmentSlot ( ) const
noexcept

◆ isCurvedSlot()

bool isCurvedSlot ( ) const
noexcept

◆ getPreviewStopMaskOffset()

tl::optional< Length > getPreviewStopMaskOffset ( ) const
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setDiameter()

bool setDiameter ( const PositiveLength diameter)
noexcept
+ Here is the caller graph for this function:

◆ setPath()

bool setPath ( const NonEmptyPath path)
noexcept
+ Here is the caller graph for this function:

◆ setStopMaskConfig()

bool setStopMaskConfig ( const MaskConfig config)
noexcept
+ Here is the caller graph for this function:

◆ serialize()

void serialize ( SExpression root) const

Serialize into librepcb::SExpression node.

Parameters
rootRoot node to serialize into.
+ Here is the call graph for this function:

◆ operator==()

bool operator== ( const Hole rhs) const
noexcept

◆ operator!=()

bool operator!= ( const Hole rhs) const
inlinenoexcept

◆ operator=()

Hole & operator= ( const Hole rhs)
noexcept

Member Data Documentation

◆ onEdited

Signal<Hole, Event> onEdited

◆ mUuid

Uuid mUuid
private

◆ mDiameter

PositiveLength mDiameter
private

◆ mPath

NonEmptyPath mPath
private

◆ mStopMaskConfig

MaskConfig mStopMaskConfig
private

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