LibrePCB Developers Documentation
TraceAnchor Class Referencefinal

The TraceAnchor class. More...

#include <trace.h>

+ Inheritance diagram for TraceAnchor:
+ Collaboration diagram for TraceAnchor:

Classes

struct  PadAnchor
 

Public Member Functions

 TraceAnchor ()=delete
 
 TraceAnchor (const TraceAnchor &other) noexcept
 
 TraceAnchor (const SExpression &node)
 
 ~TraceAnchor () noexcept
 
const tl::optional< Uuid > & tryGetJunction () const noexcept
 
const tl::optional< Uuid > & tryGetVia () const noexcept
 
const tl::optional< PadAnchor > & tryGetPad () const noexcept
 
void serialize (SExpression &root) const override
 Serialize the object into an existing S-Expression node. More...
 
bool operator== (const TraceAnchor &rhs) const noexcept
 
bool operator!= (const TraceAnchor &rhs) const noexcept
 
TraceAnchoroperator= (const TraceAnchor &rhs) 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...
 

Static Public Member Functions

static TraceAnchor junction (const Uuid &junction) noexcept
 
static TraceAnchor via (const Uuid &via) noexcept
 
static TraceAnchor pad (const Uuid &device, const Uuid &pad) noexcept
 
- 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)
 

Private Member Functions

 TraceAnchor (const tl::optional< Uuid > &junction, const tl::optional< Uuid > &via, const tl::optional< PadAnchor > &pad) noexcept
 

Private Attributes

tl::optional< UuidmJunction
 
tl::optional< UuidmVia
 
tl::optional< PadAnchormPad
 

Detailed Description

The TraceAnchor class.

Constructor & Destructor Documentation

◆ TraceAnchor() [1/4]

TraceAnchor ( )
delete
+ Here is the caller graph for this function:

◆ TraceAnchor() [2/4]

TraceAnchor ( const TraceAnchor other)
noexcept

◆ TraceAnchor() [3/4]

TraceAnchor ( const SExpression node)
explicit
+ Here is the call graph for this function:

◆ ~TraceAnchor()

~TraceAnchor ( )
noexcept
+ Here is the caller graph for this function:

◆ TraceAnchor() [4/4]

TraceAnchor ( const tl::optional< Uuid > &  junction,
const tl::optional< Uuid > &  via,
const tl::optional< PadAnchor > &  pad 
)
privatenoexcept

Member Function Documentation

◆ tryGetJunction()

const tl::optional<Uuid>& tryGetJunction ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ tryGetVia()

const tl::optional<Uuid>& tryGetVia ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ tryGetPad()

const tl::optional<PadAnchor>& tryGetPad ( ) const
inlinenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ serialize()

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

◆ operator==()

bool operator== ( const TraceAnchor rhs) const
noexcept

◆ operator!=()

bool operator!= ( const TraceAnchor rhs) const
inlinenoexcept
+ Here is the call graph for this function:

◆ operator=()

TraceAnchor & operator= ( const TraceAnchor rhs)
noexcept
+ Here is the caller graph for this function:

◆ junction()

TraceAnchor junction ( const Uuid junction)
staticnoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ via()

TraceAnchor via ( const Uuid via)
staticnoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ pad()

TraceAnchor pad ( const Uuid device,
const Uuid pad 
)
staticnoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ mJunction

tl::optional<Uuid> mJunction
private

◆ mVia

tl::optional<Uuid> mVia
private

◆ mPad

tl::optional<PadAnchor> mPad
private

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