LibrePCB Developers Documentation
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
InteractiveHtmlBomOutputJob Class Referencefinal

Interactive HTML BOM output job. More...

#include <interactivehtmlbomoutputjob.h>

+ Inheritance diagram for InteractiveHtmlBomOutputJob:
+ Collaboration diagram for InteractiveHtmlBomOutputJob:

Public Types

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

Public Member Functions

 InteractiveHtmlBomOutputJob () noexcept
 
 InteractiveHtmlBomOutputJob (const InteractiveHtmlBomOutputJob &other) noexcept
 
 InteractiveHtmlBomOutputJob (const SExpression &node)
 
virtual ~InteractiveHtmlBomOutputJob () noexcept
 
virtual QString getTypeTr () const noexcept override
 
virtual QIcon getTypeIcon () const noexcept override
 
InteractiveHtmlBom::ViewMode getViewMode () const noexcept
 
InteractiveHtmlBom::HighlightPin1Mode getHighlightPin1 () const noexcept
 
bool getDarkMode () const noexcept
 
const Angle & getBoardRotation () const noexcept
 
bool getOffsetBackRotation () const noexcept
 
bool getShowSilkscreen () const noexcept
 
bool getShowFabrication () const noexcept
 
bool getShowPads () const noexcept
 
bool getShowTracks () const noexcept
 
bool getShowZones () const noexcept
 
const QStringList & getCheckBoxes () const noexcept
 
const QStringList & getComponentOrder () const noexcept
 
const QStringList & getCustomAttributes () const noexcept
 
const BoardSet & getBoards () const noexcept
 
const AssemblyVariantSet & getAssemblyVariants () const noexcept
 
const QString & getOutputPath () const noexcept
 
void setViewMode (InteractiveHtmlBom::ViewMode mode) noexcept
 
void setHighlightPin1 (InteractiveHtmlBom::HighlightPin1Mode mode) noexcept
 
void setDarkMode (bool dark) noexcept
 
void setBoardRotation (const Angle &rot) noexcept
 
void setOffsetBackRotation (bool offset) noexcept
 
void setShowSilkscreen (bool show) noexcept
 
void setShowFabrication (bool show) noexcept
 
void setShowPads (bool show) noexcept
 
void setShowTracks (bool show) noexcept
 
void setShowZones (bool show) noexcept
 
void setCheckBoxes (const QStringList &cbx) noexcept
 
void setComponentOrder (const QStringList &order) 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< OutputJob > cloneShared () const noexcept override
 
InteractiveHtmlBomOutputJob & operator= (const InteractiveHtmlBomOutputJob &rhs)=delete
 
- Public Member Functions inherited from OutputJob
 OutputJob ()=delete
 
virtual ~OutputJob () noexcept
 
const QString & getType () const noexcept
 
const Uuid & getUuid () const noexcept
 
const ElementName & getName () const noexcept
 
virtual QSet< Uuid > getDependencies () 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
 
OutputJob & operator= (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

InteractiveHtmlBom::ViewMode mViewMode
 
InteractiveHtmlBom::HighlightPin1Mode mHighlightPin1
 
bool mDarkMode
 
Angle mBoardRotation
 
bool mOffsetBackRotation
 
bool mShowSilkscreen
 
bool mShowFabrication
 
bool mShowPads
 
bool mShowTracks
 
bool mShowZones
 
QStringList mCheckBoxes
 
QStringList mComponentOrder
 
QStringList mCustomAttributes
 
BoardSet mBoards
 
AssemblyVariantSet mAssemblyVariants
 
QString mOutputPath
 

Additional Inherited Members

- Public Attributes inherited from OutputJob
Signal< OutputJob, Event > onEdited
 
- 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

Interactive HTML BOM output job.

Member Typedef Documentation

◆ BoardSet

using BoardSet = ObjectSet<Uuid>

◆ AssemblyVariantSet

using AssemblyVariantSet = ObjectSet<Uuid>

Constructor & Destructor Documentation

◆ InteractiveHtmlBomOutputJob() [1/3]

InteractiveHtmlBomOutputJob ( )
noexcept

◆ InteractiveHtmlBomOutputJob() [2/3]

InteractiveHtmlBomOutputJob ( const InteractiveHtmlBomOutputJob &  other)
noexcept

◆ InteractiveHtmlBomOutputJob() [3/3]

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

◆ ~InteractiveHtmlBomOutputJob()

~InteractiveHtmlBomOutputJob ( )
virtualnoexcept

Member Function Documentation

◆ getTypeTr()

QString getTypeTr ( ) const
overridevirtualnoexcept

Implements OutputJob.

+ Here is the call graph for this function:

◆ getTypeIcon()

QIcon getTypeIcon ( ) const
overridevirtualnoexcept

Implements OutputJob.

◆ getViewMode()

InteractiveHtmlBom::ViewMode getViewMode ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getHighlightPin1()

InteractiveHtmlBom::HighlightPin1Mode getHighlightPin1 ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getDarkMode()

bool getDarkMode ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getBoardRotation()

const Angle & getBoardRotation ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getOffsetBackRotation()

bool getOffsetBackRotation ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getShowSilkscreen()

bool getShowSilkscreen ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getShowFabrication()

bool getShowFabrication ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getShowPads()

bool getShowPads ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getShowTracks()

bool getShowTracks ( ) const
inlinenoexcept

◆ getShowZones()

bool getShowZones ( ) const
inlinenoexcept

◆ getCheckBoxes()

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

◆ getComponentOrder()

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

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

◆ setViewMode()

void setViewMode ( InteractiveHtmlBom::ViewMode  mode)
noexcept

◆ setHighlightPin1()

void setHighlightPin1 ( InteractiveHtmlBom::HighlightPin1Mode  mode)
noexcept

◆ setDarkMode()

void setDarkMode ( bool  dark)
noexcept

◆ setBoardRotation()

void setBoardRotation ( const Angle &  rot)
noexcept

◆ setOffsetBackRotation()

void setOffsetBackRotation ( bool  offset)
noexcept

◆ setShowSilkscreen()

void setShowSilkscreen ( bool  show)
noexcept

◆ setShowFabrication()

void setShowFabrication ( bool  show)
noexcept

◆ setShowPads()

void setShowPads ( bool  show)
noexcept

◆ setShowTracks()

void setShowTracks ( bool  show)
noexcept

◆ setShowZones()

void setShowZones ( bool  show)
noexcept

◆ setCheckBoxes()

void setCheckBoxes ( const QStringList &  cbx)
noexcept

◆ setComponentOrder()

void setComponentOrder ( const QStringList &  order)
noexcept

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

◆ cloneShared()

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

Implements OutputJob.

◆ operator=()

InteractiveHtmlBomOutputJob & operator= ( const InteractiveHtmlBomOutputJob &  rhs)
delete

◆ serializeDerived()

void serializeDerived ( SExpression &  root) const
overrideprivatevirtual

Implements OutputJob.

+ Here is the call graph for this function:

◆ equals()

bool equals ( const OutputJob &  rhs) const
overrideprivatevirtualnoexcept

Implements OutputJob.

Member Data Documentation

◆ mViewMode

InteractiveHtmlBom::ViewMode mViewMode
private

◆ mHighlightPin1

InteractiveHtmlBom::HighlightPin1Mode mHighlightPin1
private

◆ mDarkMode

bool mDarkMode
private

◆ mBoardRotation

Angle mBoardRotation
private

◆ mOffsetBackRotation

bool mOffsetBackRotation
private

◆ mShowSilkscreen

bool mShowSilkscreen
private

◆ mShowFabrication

bool mShowFabrication
private

◆ mShowPads

bool mShowPads
private

◆ mShowTracks

bool mShowTracks
private

◆ mShowZones

bool mShowZones
private

◆ mCheckBoxes

QStringList mCheckBoxes
private

◆ mComponentOrder

QStringList mComponentOrder
private

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