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

The PackagePad class represents one logical pad of a package. More...

#include <packagepad.h>

+ Inheritance diagram for PackagePad:
+ Collaboration diagram for PackagePad:

Public Member Functions

 PackagePad ()=delete
 
 PackagePad (const PackagePad &other) noexcept
 
 PackagePad (const Uuid &uuid, const CircuitIdentifier &name) noexcept
 
 PackagePad (const SExpression &node)
 
 ~PackagePad () noexcept
 
const UuidgetUuid () const noexcept
 
CircuitIdentifier getName () const noexcept
 
void setName (const CircuitIdentifier &name) noexcept
 
void serialize (SExpression &root) const override
 Serialize the object into an existing S-Expression node. More...
 
bool operator== (const PackagePad &rhs) const noexcept
 
bool operator!= (const PackagePad &rhs) const noexcept
 
PackagePadoperator= (const PackagePad &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...
 

Private Attributes

Uuid mUuid
 
CircuitIdentifier mName
 

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)
 

Detailed Description

The PackagePad class represents one logical pad of a package.

Following information is considered as the "interface" of a pad and must therefore never be changed:

  • UUID

Constructor & Destructor Documentation

PackagePad ( )
delete
PackagePad ( const PackagePad other)
noexcept
PackagePad ( const Uuid uuid,
const CircuitIdentifier name 
)
noexcept
PackagePad ( const SExpression node)
explicit
~PackagePad ( )
noexcept

Member Function Documentation

const Uuid& getUuid ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

CircuitIdentifier getName ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

void setName ( const CircuitIdentifier name)
noexcept

+ 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:

bool operator== ( const PackagePad rhs) const
noexcept
bool operator!= ( const PackagePad rhs) const
inlinenoexcept
PackagePad & operator= ( const PackagePad rhs)
noexcept

Member Data Documentation

Uuid mUuid
private
CircuitIdentifier mName
private

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