LibrePCB Developers Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
BI_Via Class Referencefinal

The BI_Via class. More...

#include <bi_via.h>

+ Inheritance diagram for BI_Via:
+ Collaboration diagram for BI_Via:

Public Types

enum  Shape
 
- Public Types inherited from BI_Base
enum  Type_t
 

Public Member Functions

 BI_Via ()=delete
 
 BI_Via (const BI_Via &other)=delete
 
 BI_Via (BI_NetSegment &netsegment, const BI_Via &other)
 
 BI_Via (BI_NetSegment &netsegment, const SExpression &node)
 
 BI_Via (BI_NetSegment &netsegment, const Point &position, BI_Via::Shape shape, const PositiveLength &size, const PositiveLength &drillDiameter)
 
 ~BI_Via () noexcept
 
BI_NetSegmentgetNetSegment () const noexcept
 
NetSignalgetNetSignalOfNetSegment () const noexcept
 
const UuidgetUuid () const noexcept
 
Shape getShape () const noexcept
 
const PositiveLengthgetDrillDiameter () const noexcept
 
const PositiveLengthgetSize () const noexcept
 
bool isUsed () const noexcept
 
bool isOnLayer (const QString &layerName) const noexcept
 
bool isSelectable () const noexceptoverride
 
Path getOutline (const Length &expansion=Length(0)) const noexcept
 
Path getSceneOutline (const Length &expansion=Length(0)) const noexcept
 
QPainterPath toQPainterPathPx (const Length &expansion=Length(0)) const noexcept
 
void setPosition (const Point &position) noexcept
 
void setShape (Shape shape) noexcept
 
void setSize (const PositiveLength &size) noexcept
 
void setDrillDiameter (const PositiveLength &diameter) noexcept
 
void addToBoard () override
 
void removeFromBoard () override
 
void serialize (SExpression &root) const override
 Serialize the object into an existing S-Expression node. More...
 
Type_t getType () const noexceptoverride
 
const PointgetPosition () const noexceptoverride
 
bool getIsMirrored () const noexceptoverride
 
QPainterPath getGrabAreaScenePx () const noexceptoverride
 
void setSelected (bool selected) noexceptoverride
 
void registerNetLine (BI_NetLine &netline) override
 
void unregisterNetLine (BI_NetLine &netline) override
 
const QSet< BI_NetLine * > & getNetLines () const noexceptoverride
 
BI_Viaoperator= (const BI_Via &rhs)=delete
 
bool operator== (const BI_Via &rhs) noexcept
 
bool operator!= (const BI_Via &rhs) noexcept
 
- 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
 
ProjectgetProject () const noexcept
 
CircuitgetCircuit () const noexcept
 
BoardgetBoard () const noexcept
 
virtual bool isAddedToBoard () const noexcept
 
virtual bool isSelected () const noexcept
 
BI_Baseoperator= (const BI_Base &rhs)=delete
 
- Public Member Functions inherited from BI_NetLineAnchor
 BI_NetLineAnchor () noexcept=default
 
virtual ~BI_NetLineAnchor () noexcept=default
 
std::vector< PositiveLengthgetLineWidths () const noexcept
 
UnsignedLength getMaxLineWidth () const noexcept
 
UnsignedLength getMedianLineWidth () const noexcept
 
BI_NetSegmentgetNetSegmentOfLines () const noexcept
 
- Public Member Functions inherited from SerializableObject
 SerializableObject () noexcept
 
virtual ~SerializableObject () noexcept
 
SExpression serializeToDomElement (const QString &name) const
 Serialize the object to a new S-Expression node. More...
 

Private Member Functions

void init ()
 
void boardAttributesChanged ()
 

Private Attributes

BI_NetSegmentmNetSegment
 
QScopedPointer< BGI_ViamGraphicsItem
 
QMetaObject::Connection mHighlightChangedConnection
 
Uuid mUuid
 
Point mPosition
 
Shape mShape
 
PositiveLength mSize
 
PositiveLength mDrillDiameter
 
QSet< BI_NetLine * > mRegisteredNetLines
 

Additional Inherited Members

- Static Public Member Functions inherited from SerializableObject
template<typename T >
static void serializeObjectContainer (SExpression &root, const T &container, const QString &itemName)
 
template<typename T >
static void serializePointerContainer (SExpression &root, const T &container, const QString &itemName)
 
template<typename T >
static void serializePointerContainerUuidSorted (SExpression &root, const T &container, const QString &itemName)
 
- Protected Member Functions inherited from BI_Base
void addToBoard (QGraphicsItem *item) noexcept
 
void removeFromBoard (QGraphicsItem *item) noexcept
 
- Protected Attributes inherited from BI_Base
BoardmBoard
 

Detailed Description

The BI_Via class.

Member Enumeration Documentation

enum Shape
strong
Enumerator
Round 
Square 
Octagon 

Constructor & Destructor Documentation

BI_Via ( )
delete
BI_Via ( const BI_Via other)
delete
BI_Via ( BI_NetSegment netsegment,
const BI_Via other 
)

+ Here is the call graph for this function:

BI_Via ( BI_NetSegment netsegment,
const SExpression node 
)

+ Here is the call graph for this function:

BI_Via ( BI_NetSegment netsegment,
const Point position,
BI_Via::Shape  shape,
const PositiveLength size,
const PositiveLength drillDiameter 
)

+ Here is the call graph for this function:

~BI_Via ( )
noexcept

Member Function Documentation

BI_NetSegment& getNetSegment ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

NetSignal & getNetSignalOfNetSegment ( ) const
noexcept

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

const Uuid& getUuid ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

Shape getShape ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const PositiveLength& getDrillDiameter ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const PositiveLength& getSize ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

bool isUsed ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

bool isOnLayer ( const QString &  layerName) const
noexcept

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool isSelectable ( ) const
overridevirtualnoexcept

Implements BI_Base.

+ Here is the caller graph for this function:

Path getOutline ( const Length expansion = Length(0)) const
noexcept

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Path getSceneOutline ( const Length expansion = Length(0)) const
noexcept

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

QPainterPath toQPainterPathPx ( const Length expansion = Length(0)) const
noexcept

+ Here is the caller graph for this function:

void setPosition ( const Point position)
noexcept

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setShape ( Shape  shape)
noexcept

+ Here is the caller graph for this function:

void setSize ( const PositiveLength size)
noexcept

+ Here is the caller graph for this function:

void setDrillDiameter ( const PositiveLength diameter)
noexcept

+ Here is the caller graph for this function:

void addToBoard ( )
overridevirtual

Implements BI_Base.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void removeFromBoard ( )
overridevirtual

Implements BI_Base.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void serialize ( SExpression root) const
overridevirtual

Serialize the object into an existing S-Expression node.

This method inserts/appends all attributes and childs of the object to an existing S-Expression node. The content which already exists in the given S-Expression node will not be removed.

Note
The generated S-Expression node has always the format of the application's major version (it's not possible to generate DOMs of older versions).
Parameters
rootThe target DOM root node
Exceptions
ExceptionThis method throws an exception if an error occurs.

Implements SerializableObject.

+ Here is the call graph for this function:

Type_t getType ( ) const
inlineoverridevirtualnoexcept

Implements BI_Base.

const Point& getPosition ( ) const
inlineoverridevirtualnoexcept

Implements BI_Base.

+ Here is the caller graph for this function:

bool getIsMirrored ( ) const
inlineoverridevirtualnoexcept

Implements BI_Base.

QPainterPath getGrabAreaScenePx ( ) const
overridevirtualnoexcept

Implements BI_Base.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void setSelected ( bool  selected)
overridevirtualnoexcept

Reimplemented from BI_Base.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void registerNetLine ( BI_NetLine netline)
overridevirtual

Implements BI_NetLineAnchor.

+ Here is the call graph for this function:

void unregisterNetLine ( BI_NetLine netline)
overridevirtual

Implements BI_NetLineAnchor.

+ Here is the call graph for this function:

const QSet<BI_NetLine*>& getNetLines ( ) const
inlineoverridevirtualnoexcept

Implements BI_NetLineAnchor.

+ Here is the caller graph for this function:

BI_Via& operator= ( const BI_Via rhs)
delete
bool operator== ( const BI_Via rhs)
inlinenoexcept
bool operator!= ( const BI_Via rhs)
inlinenoexcept
void init ( )
private

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void boardAttributesChanged ( )
private

+ Here is the caller graph for this function:

Member Data Documentation

BI_NetSegment& mNetSegment
private
QScopedPointer<BGI_Via> mGraphicsItem
private
QMetaObject::Connection mHighlightChangedConnection
private
Uuid mUuid
private
Point mPosition
private
Shape mShape
private
PositiveLength mSize
private
PositiveLength mDrillDiameter
private
QSet<BI_NetLine*> mRegisteredNetLines
private

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