BI_Hole Class Reference

The BI_Hole class. More...

#include <bi_hole.h>

Inheritance diagram for BI_Hole:

Collaboration diagram for BI_Hole:

Public Types
enum class	Event
typedef Slot< BI_Hole, Event >	OnEditedSlot

Public Member Functions
	BI_Hole ()=delete
	BI_Hole (const BI_Hole &other)=delete
	BI_Hole (Board &board, const BoardHoleData &data)
	~BI_Hole () noexcept
const BoardHoleData &	getData () const noexcept
const std::optional< Length > &	getStopMaskOffset () const 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	addToBoard () override
void	removeFromBoard () override
BI_Hole &	operator= (const BI_Hole &rhs)=delete
Public Member Functions inherited from BI_Base
	BI_Base ()=delete
	BI_Base (const BI_Base &other)=delete
	BI_Base (Board &board) noexcept
virtual	~BI_Base () noexcept
Project &	getProject () const noexcept
Circuit &	getCircuit () const noexcept
Board &	getBoard () const noexcept
virtual bool	isAddedToBoard () const noexcept
BI_Base &	operator= (const BI_Base &rhs)=delete

Public Attributes
Signal< BI_Hole, Event >	onEdited

Private Member Functions
void	updateStopMaskOffset () noexcept

Private Attributes
BoardHoleData	mData
std::optional< Length >	mStopMaskOffset

Additional Inherited Members
Protected Attributes inherited from BI_Base
Board &	mBoard

Detailed Description

The BI_Hole class.

Member Typedef Documentation

OnEditedSlot

typedef Slot<BI_Hole, Event> OnEditedSlot

Member Enumeration Documentation

Event

enum class Event

strong

Enumerator
DiameterChanged
PathChanged
StopMaskOffsetChanged

Constructor & Destructor Documentation

BI_Hole() [1/3]

BI_Hole ( )

delete

BI_Hole() [2/3]

BI_Hole ( const BI_Hole &  other )

delete

BI_Hole() [3/3]

BI_Hole	(	Board &	board,
		const BoardHoleData &	data
	)

Here is the call graph for this function:

~BI_Hole()

~BI_Hole ( )

noexcept

Member Function Documentation

getData()

const BoardHoleData & getData ( ) const

inlinenoexcept

Here is the caller graph for this function:

getStopMaskOffset()

const std::optional< Length > & getStopMaskOffset ( ) const

inlinenoexcept

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:

setLocked()

bool setLocked ( bool  locked )

noexcept

Here is the caller graph for this function:

addToBoard()

void addToBoard ( )

overridevirtual

Reimplemented from BI_Base.

Here is the call graph for this function:

Here is the caller graph for this function:

removeFromBoard()

void removeFromBoard ( )

overridevirtual

Reimplemented from BI_Base.

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

BI_Hole & operator= ( const BI_Hole &  rhs )

delete

updateStopMaskOffset()

void updateStopMaskOffset ( )

privatenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

onEdited

Signal<BI_Hole, Event> onEdited

mData

BoardHoleData mData

private

mStopMaskOffset

std::optional<Length> mStopMaskOffset

private

---

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

• /__w/1/s/libs/librepcb/core/project/board/items/bi_hole.h
• /__w/1/s/libs/librepcb/core/project/board/items/bi_hole.cpp