Device Class Reference

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 () noexcept
const Uuid &	getComponentUuid () const noexcept
const Uuid &	getPackageUuid () const noexcept
DevicePadSignalMap &	getPadSignalMap () noexcept
const DevicePadSignalMap &	getPadSignalMap () const noexcept
AttributeList &	getAttributes () noexcept
const AttributeList &	getAttributes () const noexcept
PartList &	getParts () noexcept
const PartList &	getParts () const noexcept
void	setComponentUuid (const Uuid &uuid) noexcept
void	setPackageUuid (const Uuid &uuid) noexcept
virtual RuleCheckMessageList	runChecks () const override
Device &	operator= (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 QString &shortElementName, const QString &longElementName, bool dirnameMustBeUuid, std::unique_ptr< TransactionalDirectory > directory, const SExpression &root)
virtual	~LibraryElement () noexcept
const QString &	getGeneratedBy () const noexcept
const QSet< Uuid > &	getCategories () const noexcept
const ResourceList &	getResources () const noexcept
void	setGeneratedBy (const QString &gen) noexcept
void	setCategories (const QSet< Uuid > &uuids) noexcept
void	setResources (const ResourceList &resources) noexcept
LibraryElement &	operator= (const LibraryElement &rhs)=delete
Public Member Functions inherited from LibraryBaseElement
	LibraryBaseElement ()=delete
	LibraryBaseElement (const LibraryBaseElement &other)=delete
	LibraryBaseElement (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 QString &shortElementName, const QString &longElementName, bool dirnameMustBeUuid, std::unique_ptr< TransactionalDirectory > directory, const SExpression &root)
virtual	~LibraryBaseElement () noexcept
const TransactionalDirectory &	getDirectory () const noexcept
TransactionalDirectory &	getDirectory () noexcept
const Uuid &	getUuid () const noexcept
const Version &	getVersion () const noexcept
const QString &	getAuthor () const noexcept
const QDateTime &	getCreated () const noexcept
bool	isDeprecated () const noexcept
const LocalizedNameMap &	getNames () const noexcept
const LocalizedDescriptionMap &	getDescriptions () const noexcept
const LocalizedKeywordsMap &	getKeywords () const noexcept
QStringList	getAllAvailableLocales () const noexcept
const QSet< SExpression > &	getMessageApprovals () 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
void	setMessageApprovals (const QSet< SExpression > &approvals) noexcept
bool	setMessageApproved (const SExpression &approval, bool approved) noexcept
virtual void	save ()
virtual void	saveTo (TransactionalDirectory &dest)
virtual void	moveTo (TransactionalDirectory &dest)
virtual void	saveIntoParentDirectory (TransactionalDirectory &dest)
virtual void	moveIntoParentDirectory (TransactionalDirectory &dest)
LibraryBaseElement &	operator= (const LibraryBaseElement &rhs)=delete

Static Public Member Functions
static std::unique_ptr< Device >	open (std::unique_ptr< TransactionalDirectory > directory, bool abortBeforeMigration=false)
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
template<typename ElementType >
static bool	isValidElementDirectory (const TransactionalDirectory &dir, const QString &path) noexcept

Protected Member Functions
virtual void	serialize (SExpression &root) const override
	Serialize into librepcb::SExpression node.
Protected Member Functions inherited from LibraryBaseElement
void	serializeMessageApprovals (SExpression &root) const
void	removeObsoleteMessageApprovals ()

Private Member Functions
	Device (std::unique_ptr< TransactionalDirectory > directory, const SExpression &root)

Private Attributes
Uuid	mComponentUuid
Uuid	mPackageUuid
DevicePadSignalMap	mPadSignalMap
AttributeList	mAttributes
PartList	mParts

Additional Inherited Members
Static Protected Member Functions inherited from LibraryBaseElement
static Version	readFileFormat (const TransactionalDirectory &directory, const QString &fileName)
Protected Attributes inherited from LibraryElement
QString	mGeneratedBy
	If not empty, the element is generated.
QSet< Uuid >	mCategories
ResourceList	mResources
Protected Attributes inherited from LibraryBaseElement
const QString	mShortElementName
	e.g. "lib", "cmpcat"
const QString	mLongElementName
	e.g. "library", "component_category"
std::unique_ptr< TransactionalDirectory >	mDirectory
Uuid	mUuid
Version	mVersion
QString	mAuthor
QDateTime	mCreated
bool	mIsDeprecated
LocalizedNameMap	mNames
LocalizedDescriptionMap	mDescriptions
LocalizedKeywordsMap	mKeywords
QSet< SExpression >	mMessageApprovals

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:

• UUID
• Component UUID
• Package UUID
• Pad-signal-mapping

Constructor & Destructor Documentation

Device() [1/4]

Device ( )

delete

Here is the caller graph for this function:

Device() [2/4]

Device ( const Device &  other )

delete

Device() [3/4]

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()

~Device ( )

noexcept

Device() [4/4]

Device ( std::unique_ptr< TransactionalDirectory >  directory, const SExpression &  root  )

private

Member Function Documentation

getComponentUuid()

const Uuid & getComponentUuid ( ) const

inlinenoexcept

Here is the caller graph for this function:

getPackageUuid()

const Uuid & getPackageUuid ( ) const

inlinenoexcept

Here is the caller graph for this function:

getPadSignalMap() [1/2]

DevicePadSignalMap & getPadSignalMap ( )

inlinenoexcept

Here is the caller graph for this function:

getPadSignalMap() [2/2]

const DevicePadSignalMap & getPadSignalMap ( ) const

inlinenoexcept

getAttributes() [1/2]

AttributeList & getAttributes ( )

inlinenoexcept

Here is the caller graph for this function:

getAttributes() [2/2]

const AttributeList & getAttributes ( ) const

inlinenoexcept

getParts() [1/2]

PartList & getParts ( )

inlinenoexcept

Here is the caller graph for this function:

getParts() [2/2]

const PartList & getParts ( ) const

inlinenoexcept

setComponentUuid()

void setComponentUuid ( const Uuid &  uuid )

noexcept

Here is the caller graph for this function:

setPackageUuid()

void setPackageUuid ( const Uuid &  uuid )

noexcept

Here is the caller graph for this function:

runChecks()

RuleCheckMessageList runChecks ( ) const

overridevirtual

Reimplemented from LibraryElement.

Here is the call graph for this function:

operator=()

Device & operator= ( const Device &  rhs )

delete

open()

std::unique_ptr< Device > open ( std::unique_ptr< TransactionalDirectory >  directory, bool  abortBeforeMigration = false  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

getShortElementName()

static QString getShortElementName ( )

inlinestaticnoexcept

Here is the caller graph for this function:

getLongElementName()

static QString getLongElementName ( )

inlinestaticnoexcept

Here is the caller graph for this function:

componentUuidChanged

void componentUuidChanged ( const Uuid &  uuid )

signal

packageUuidChanged

void packageUuidChanged ( const Uuid &  uuid )

signal

serialize()

void serialize ( SExpression &  root ) const

overrideprotectedvirtual

Serialize into librepcb::SExpression node.

Parameters

root	Root node to serialize into.

Reimplemented from LibraryElement.

Here is the call graph for this function:

Member Data Documentation

mComponentUuid

Uuid mComponentUuid

private

mPackageUuid

Uuid mPackageUuid

private

mPadSignalMap

DevicePadSignalMap mPadSignalMap

private

mAttributes

AttributeList mAttributes

private

mParts

PartList mParts

private

---

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

• /__w/1/s/libs/librepcb/core/library/dev/device.h
• /__w/1/s/libs/librepcb/core/library/dev/device.cpp