LibrePCB Developers Documentation
Loading...
Searching...
No Matches
BomOutputJob Class Referencefinal

BOM output job. More...

#include <bomoutputjob.h>

+ Inheritance diagram for BomOutputJob:
+ Collaboration diagram for BomOutputJob:

Public Types

using BoardSet = ObjectSet< std::optional< Uuid > >
 
using AssemblyVariantSet = ObjectSet< Uuid >
 
- Public Types inherited from OutputJob
enum class  Event
 
typedef Slot< OutputJob, EventOnEditedSlot
 

Public Member Functions

 BomOutputJob () noexcept
 
 BomOutputJob (const BomOutputJob &other) noexcept
 
 BomOutputJob (const SExpression &node)
 
virtual ~BomOutputJob () noexcept
 
virtual QString getTypeTr () const noexcept override
 
virtual QIcon getTypeIcon () const noexcept override
 
const QStringList & getCustomAttributes () const noexcept
 
const BoardSetgetBoards () const noexcept
 
const AssemblyVariantSetgetAssemblyVariants () const noexcept
 
const QString & getOutputPath () const noexcept
 
void setCustomAttributes (const QStringList &attrs) noexcept
 
void setBoards (const BoardSet &boards) noexcept
 
void setAssemblyVariants (const AssemblyVariantSet &avs) noexcept
 
void setOutputPath (const QString &path) noexcept
 
virtual std::shared_ptr< OutputJobcloneShared () const noexcept override
 
BomOutputJoboperator= (const BomOutputJob &rhs)=delete
 
- Public Member Functions inherited from OutputJob
 OutputJob ()=delete
 
virtual ~OutputJob () noexcept
 
const QString & getType () const noexcept
 
const UuidgetUuid () const noexcept
 
const ElementNamegetName () const noexcept
 
virtual QSet< UuidgetDependencies () const noexcept
 
void setUuid (const Uuid &uuid) noexcept
 
void setName (const ElementName &name) noexcept
 
virtual void removeDependency (const Uuid &jobUuid)
 
virtual void serialize (SExpression &root) const
 Serialize into librepcb::SExpression node.
 
bool operator== (const OutputJob &rhs) const noexcept
 
bool operator!= (const OutputJob &rhs) const noexcept
 
OutputJoboperator= (const OutputJob &rhs)=delete
 

Static Public Member Functions

static QString getTypeName () noexcept
 
static QString getTypeTrStatic () noexcept
 

Private Member Functions

virtual void serializeDerived (SExpression &root) const override
 
virtual bool equals (const OutputJob &rhs) const noexcept override
 

Private Attributes

QStringList mCustomAttributes
 
BoardSet mBoards
 
AssemblyVariantSet mAssemblyVariants
 
QString mOutputPath
 

Additional Inherited Members

- Public Attributes inherited from OutputJob
Signal< OutputJob, EventonEdited
 
- Protected Member Functions inherited from OutputJob
 OutputJob (const OutputJob &other) noexcept
 
 OutputJob (const SExpression &node)
 
 OutputJob (const QString &type, const Uuid &uuid, const ElementName &name) noexcept
 
- Protected Attributes inherited from OutputJob
const QString mType
 
Uuid mUuid
 
ElementName mName
 
QMap< QString, QList< SExpression > > mOptions
 

Detailed Description

BOM output job.

Member Typedef Documentation

◆ BoardSet

using BoardSet = ObjectSet<std::optional<Uuid> >

◆ AssemblyVariantSet

Constructor & Destructor Documentation

◆ BomOutputJob() [1/3]

BomOutputJob ( )
noexcept

◆ BomOutputJob() [2/3]

BomOutputJob ( const BomOutputJob other)
noexcept

◆ BomOutputJob() [3/3]

BomOutputJob ( const SExpression node)
explicit

◆ ~BomOutputJob()

~BomOutputJob ( )
virtualnoexcept

Member Function Documentation

◆ getTypeTr()

QString getTypeTr ( ) const
overridevirtualnoexcept

Implements OutputJob.

◆ getTypeIcon()

QIcon getTypeIcon ( ) const
overridevirtualnoexcept

Implements OutputJob.

◆ getCustomAttributes()

const QStringList & getCustomAttributes ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getBoards()

const BoardSet & getBoards ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getAssemblyVariants()

const AssemblyVariantSet & getAssemblyVariants ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getOutputPath()

const QString & getOutputPath ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ setCustomAttributes()

void setCustomAttributes ( const QStringList &  attrs)
noexcept

◆ setBoards()

void setBoards ( const BoardSet boards)
noexcept

◆ setAssemblyVariants()

void setAssemblyVariants ( const AssemblyVariantSet avs)
noexcept

◆ setOutputPath()

void setOutputPath ( const QString &  path)
noexcept

◆ getTypeName()

static QString getTypeName ( )
inlinestaticnoexcept
+ Here is the caller graph for this function:

◆ getTypeTrStatic()

static QString getTypeTrStatic ( )
inlinestaticnoexcept

◆ cloneShared()

std::shared_ptr< OutputJob > cloneShared ( ) const
overridevirtualnoexcept

Implements OutputJob.

◆ operator=()

BomOutputJob & operator= ( const BomOutputJob rhs)
delete

◆ serializeDerived()

void serializeDerived ( SExpression root) const
overrideprivatevirtual

Implements OutputJob.

◆ equals()

bool equals ( const OutputJob rhs) const
overrideprivatevirtualnoexcept

Implements OutputJob.

Member Data Documentation

◆ mCustomAttributes

QStringList mCustomAttributes
private

◆ mBoards

BoardSet mBoards
private

◆ mAssemblyVariants

AssemblyVariantSet mAssemblyVariants
private

◆ mOutputPath

QString mOutputPath
private

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