LibrePCB Developers Documentation
BoardHoleData Class Referencefinal

The BoardHoleData class. More...

#include <boardholedata.h>

+ Collaboration diagram for BoardHoleData:

Public Member Functions

 BoardHoleData ()=delete
 
 BoardHoleData (const BoardHoleData &other) noexcept
 
 BoardHoleData (const Uuid &uuid, const BoardHoleData &other) noexcept
 
 BoardHoleData (const Uuid &uuid, const PositiveLength &diameter, const NonEmptyPath &path, const MaskConfig &stopMaskConfig, bool locked)
 
 BoardHoleData (const SExpression &node)
 
 ~BoardHoleData () noexcept
 
const UuidgetUuid () const noexcept
 
const PositiveLengthgetDiameter () const noexcept
 
const NonEmptyPathgetPath () const noexcept
 
const MaskConfiggetStopMaskConfig () const noexcept
 
bool isLocked () const noexcept
 
bool isSlot () const noexcept
 
bool isMultiSegmentSlot () const noexcept
 
bool isCurvedSlot () const noexcept
 
bool setUuid (const Uuid &uuid) noexcept
 
bool setDiameter (const PositiveLength &diameter) noexcept
 
bool setPath (const NonEmptyPath &path) noexcept
 
bool setStopMaskConfig (const MaskConfig &config) noexcept
 
bool setLocked (bool locked) noexcept
 
void serialize (SExpression &root) const
 Serialize into librepcb::SExpression node. More...
 
bool operator== (const BoardHoleData &rhs) const noexcept
 
bool operator!= (const BoardHoleData &rhs) const noexcept
 
BoardHoleDataoperator= (const BoardHoleData &rhs)=default
 

Private Attributes

Uuid mUuid
 
PositiveLength mDiameter
 
NonEmptyPath mPath
 
MaskConfig mStopMaskConfig
 
bool mLocked
 

Detailed Description

The BoardHoleData class.

Constructor & Destructor Documentation

◆ BoardHoleData() [1/5]

BoardHoleData ( )
delete

◆ BoardHoleData() [2/5]

BoardHoleData ( const BoardHoleData other)
noexcept

◆ BoardHoleData() [3/5]

BoardHoleData ( const Uuid uuid,
const BoardHoleData other 
)
noexcept

◆ BoardHoleData() [4/5]

BoardHoleData ( const Uuid uuid,
const PositiveLength diameter,
const NonEmptyPath path,
const MaskConfig stopMaskConfig,
bool  locked 
)

◆ BoardHoleData() [5/5]

BoardHoleData ( const SExpression node)
explicit

◆ ~BoardHoleData()

~BoardHoleData ( )
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
+ Here is the caller graph for this function:

◆ isLocked()

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

◆ isSlot()

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

◆ isMultiSegmentSlot()

bool isMultiSegmentSlot ( ) const
inlinenoexcept

◆ isCurvedSlot()

bool isCurvedSlot ( ) const
inlinenoexcept

◆ setUuid()

bool setUuid ( const Uuid uuid)
noexcept

◆ setDiameter()

bool setDiameter ( const PositiveLength diameter)
noexcept

◆ setPath()

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

◆ setStopMaskConfig()

bool setStopMaskConfig ( const MaskConfig config)
noexcept

◆ setLocked()

bool setLocked ( bool  locked)
noexcept

◆ 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 BoardHoleData rhs) const
noexcept

◆ operator!=()

bool operator!= ( const BoardHoleData rhs) const
inlinenoexcept

◆ operator=()

BoardHoleData & operator= ( const BoardHoleData rhs)
default

Member Data Documentation

◆ mUuid

Uuid mUuid
private

◆ mDiameter

PositiveLength mDiameter
private

◆ mPath

NonEmptyPath mPath
private

◆ mStopMaskConfig

MaskConfig mStopMaskConfig
private

◆ mLocked

bool mLocked
private

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