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

The Device class represents an instance of a component (a "real" component) More...

#include <device.h>

+ Inheritance diagram for Device:
+ Collaboration diagram for Device:

Signals

void componentUuidChanged (const Uuid &uuid)
 
void packageUuidChanged (const Uuid &uuid)
 

Public Member Functions

 Device ()=delete
 
 Device (const Device &other)=delete
 
 Device (const Uuid &uuid, const Version &version, const QString &author, const ElementName &name_en_US, const QString &description_en_US, const QString &keywords_en_US, const Uuid &component, const Uuid &package)
 
 Device (const FilePath &elementDirectory, bool readOnly)
 
 ~Device () noexcept
 
const UuidgetComponentUuid () const noexcept
 
const UuidgetPackageUuid () const noexcept
 
const AttributeListgetAttributes () const noexcept
 
DevicePadSignalMapgetPadSignalMap () noexcept
 
const DevicePadSignalMapgetPadSignalMap () const noexcept
 
void setComponentUuid (const Uuid &uuid) noexcept
 
void setPackageUuid (const Uuid &uuid) noexcept
 
Deviceoperator= (const Device &rhs)=delete
 
- Public Member Functions inherited from LibraryElement
 LibraryElement ()=delete
 
 LibraryElement (const LibraryElement &other)=delete
 
 LibraryElement (const QString &shortElementName, const QString &longElementName, const Uuid &uuid, const Version &version, const QString &author, const ElementName &name_en_US, const QString &description_en_US, const QString &keywords_en_US)
 
 LibraryElement (const FilePath &elementDirectory, const QString &shortElementName, const QString &longElementName, bool readOnly)
 
virtual ~LibraryElement () noexcept
 
const QSet< Uuid > & getCategories () const noexcept
 
void setCategories (const QSet< Uuid > &uuids) noexcept
 
virtual
LibraryElementCheckMessageList 
runChecks () const override
 
LibraryElementoperator= (const LibraryElement &rhs)=delete
 
- Public Member Functions inherited from LibraryBaseElement
 LibraryBaseElement ()=delete
 
 LibraryBaseElement (const LibraryBaseElement &other)=delete
 
 LibraryBaseElement (bool dirnameMustBeUuid, const QString &shortElementName, const QString &longElementName, const Uuid &uuid, const Version &version, const QString &author, const ElementName &name_en_US, const QString &description_en_US, const QString &keywords_en_US)
 
 LibraryBaseElement (const FilePath &elementDirectory, bool dirnameMustBeUuid, const QString &shortElementName, const QString &longElementName, bool readOnly)
 
virtual ~LibraryBaseElement () noexcept
 
const FilePathgetFilePath () const noexcept
 
const QString & getShortElementName () const noexcept
 
const QString & getLongElementName () const noexcept
 
bool isOpenedReadOnly () const noexcept
 
const UuidgetUuid () const noexcept
 
const VersiongetVersion () const noexcept
 
const QString & getAuthor () const noexcept
 
const QDateTime & getCreated () const noexcept
 
bool isDeprecated () const noexcept
 
const LocalizedNameMapgetNames () const noexcept
 
const LocalizedDescriptionMapgetDescriptions () const noexcept
 
const LocalizedKeywordsMapgetKeywords () const noexcept
 
QStringList getAllAvailableLocales () const noexcept
 
void setVersion (const Version &version) noexcept
 
void setAuthor (const QString &author) noexcept
 
void setDeprecated (bool deprecated) noexcept
 
void setNames (const LocalizedNameMap &names) noexcept
 
void setDescriptions (const LocalizedDescriptionMap &descriptions) noexcept
 
void setKeywords (const LocalizedKeywordsMap &keywords) noexcept
 
virtual void save ()
 
virtual void saveTo (const FilePath &destination)
 
virtual void saveIntoParentDirectory (const FilePath &parentDir)
 
virtual void moveTo (const FilePath &destination)
 
virtual void moveIntoParentDirectory (const FilePath &parentDir)
 
LibraryBaseElementoperator= (const LibraryBaseElement &rhs)=delete
 
- 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 QString getShortElementName () noexcept
 
static QString getLongElementName () noexcept
 
- Static Public Member Functions inherited from LibraryBaseElement
template<typename ElementType >
static bool isValidElementDirectory (const FilePath &dir) 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

void serialize (SExpression &root) const override
 Serialize the object into an existing S-Expression node. More...
 

Private Attributes

Uuid mComponentUuid
 
Uuid mPackageUuid
 
AttributeList mAttributes
 not yet used, but already specified in file format More...
 
DevicePadSignalMap mPadSignalMap
 

Additional Inherited Members

- Protected Member Functions inherited from LibraryBaseElement
virtual void cleanupAfterLoadingElementFromFile () noexcept
 
virtual void copyTo (const FilePath &destination, bool removeSource)
 
- Protected Attributes inherited from LibraryElement
QSet< UuidmCategories
 
- Protected Attributes inherited from LibraryBaseElement
FilePath mDirectory
 
bool mDirectoryIsTemporary
 
bool mOpenedReadOnly
 
bool mDirectoryNameMustBeUuid
 
QString mShortElementName
 e.g. "lib", "cmpcat", "sym" More...
 
QString mLongElementName
 e.g. "library", "component_category", "symbol" More...
 
SExpression mLoadingFileDocument
 
Uuid mUuid
 
Version mVersion
 
QString mAuthor
 
QDateTime mCreated
 
bool mIsDeprecated
 
LocalizedNameMap mNames
 
LocalizedDescriptionMap mDescriptions
 
LocalizedKeywordsMap mKeywords
 

Detailed Description

The Device class represents an instance of a component (a "real" component)

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

Constructor & Destructor Documentation

Device ( )
delete
Device ( const Device other)
delete
Device ( const Uuid uuid,
const Version version,
const QString &  author,
const ElementName name_en_US,
const QString &  description_en_US,
const QString &  keywords_en_US,
const Uuid component,
const Uuid package 
)
Device ( const FilePath elementDirectory,
bool  readOnly 
)

+ Here is the call graph for this function:

~Device ( )
noexcept

Member Function Documentation

const Uuid& getComponentUuid ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const Uuid& getPackageUuid ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const AttributeList& getAttributes ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

DevicePadSignalMap& getPadSignalMap ( )
inlinenoexcept

+ Here is the caller graph for this function:

const DevicePadSignalMap& getPadSignalMap ( ) const
inlinenoexcept
void setComponentUuid ( const Uuid uuid)
noexcept

+ Here is the caller graph for this function:

void setPackageUuid ( const Uuid uuid)
noexcept

+ Here is the caller graph for this function:

Device& operator= ( const Device rhs)
delete
static QString getShortElementName ( )
inlinestaticnoexcept
static QString getLongElementName ( )
inlinestaticnoexcept
void componentUuidChanged ( const Uuid uuid)
signal

+ Here is the caller graph for this function:

void packageUuidChanged ( const Uuid uuid)
signal

+ Here is the caller graph for this function:

void serialize ( SExpression root) const
overrideprivatevirtual

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.

Reimplemented from LibraryElement.

+ Here is the call graph for this function:

Member Data Documentation

Uuid mComponentUuid
private
Uuid mPackageUuid
private
AttributeList mAttributes
private

not yet used, but already specified in file format

DevicePadSignalMap mPadSignalMap
private

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