LibrePCB Developers Documentation
PickPlaceCsvWriter Class Referencefinal

The PickPlaceCsvWriter class. More...

#include <pickplacecsvwriter.h>

+ Collaboration diagram for PickPlaceCsvWriter:

Public Types

enum class  BoardSide
 

Public Member Functions

 PickPlaceCsvWriter ()=delete
 
 PickPlaceCsvWriter (const PickPlaceCsvWriter &other)=delete
 
 PickPlaceCsvWriter (const PickPlaceData &data) noexcept
 
 ~PickPlaceCsvWriter () noexcept
 
void setBoardSide (BoardSide side) noexcept
 
void setTypeFilter (const QSet< PickPlaceDataItem::Type > &filter) noexcept
 
void setIncludeMetadataComment (bool include) noexcept
 
void setIncludeNonMountedParts (bool include) noexcept
 
std::shared_ptr< CsvFilegenerateCsv () const
 
PickPlaceCsvWriteroperator= (const PickPlaceCsvWriter &rhs)=delete
 

Static Private Member Functions

static bool isOnBoardSide (const PickPlaceDataItem &item, BoardSide side) noexcept
 
static QString boardSideToString (BoardSide side) noexcept
 

Private Attributes

const PickPlaceDatamData
 
BoardSide mBoardSide
 
QSet< PickPlaceDataItem::TypemTypeFilter
 
bool mIncludeMetadataComment
 
bool mIncludeNonMountedParts
 

Detailed Description

The PickPlaceCsvWriter class.

Member Enumeration Documentation

◆ BoardSide

enum class BoardSide
strong
Enumerator
Top 
Bottom 
Both 

Constructor & Destructor Documentation

◆ PickPlaceCsvWriter() [1/3]

PickPlaceCsvWriter ( )
delete

◆ PickPlaceCsvWriter() [2/3]

PickPlaceCsvWriter ( const PickPlaceCsvWriter other)
delete

◆ PickPlaceCsvWriter() [3/3]

PickPlaceCsvWriter ( const PickPlaceData data)
explicitnoexcept

◆ ~PickPlaceCsvWriter()

~PickPlaceCsvWriter ( )
noexcept

Member Function Documentation

◆ setBoardSide()

void setBoardSide ( BoardSide  side)
inlinenoexcept
+ Here is the caller graph for this function:

◆ setTypeFilter()

void setTypeFilter ( const QSet< PickPlaceDataItem::Type > &  filter)
inlinenoexcept
+ Here is the caller graph for this function:

◆ setIncludeMetadataComment()

void setIncludeMetadataComment ( bool  include)
inlinenoexcept
+ Here is the caller graph for this function:

◆ setIncludeNonMountedParts()

void setIncludeNonMountedParts ( bool  include)
inlinenoexcept
+ Here is the caller graph for this function:

◆ generateCsv()

std::shared_ptr< CsvFile > generateCsv ( ) const
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator=()

PickPlaceCsvWriter & operator= ( const PickPlaceCsvWriter rhs)
delete

◆ isOnBoardSide()

bool isOnBoardSide ( const PickPlaceDataItem item,
BoardSide  side 
)
staticprivatenoexcept
+ Here is the caller graph for this function:

◆ boardSideToString()

QString boardSideToString ( BoardSide  side)
staticprivatenoexcept
+ Here is the caller graph for this function:

Member Data Documentation

◆ mData

const PickPlaceData& mData
private

◆ mBoardSide

BoardSide mBoardSide
private

◆ mTypeFilter

QSet<PickPlaceDataItem::Type> mTypeFilter
private

◆ mIncludeMetadataComment

bool mIncludeMetadataComment
private

◆ mIncludeNonMountedParts

bool mIncludeNonMountedParts
private

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