KiCad PCB EDA Suite
Loading...
Searching...
No Matches
DRILL_SYMBOL_PROFILE Class Reference

Grouping rules and symbol assignments, shared by reference so a chart and its map can never disagree about which symbol means which hole. More...

#include <drill_symbol_profile.h>

Public Member Functions

 DRILL_SYMBOL_PROFILE ()
 
const KIIDUuid () const
 
void SetUuid (const KIID &aUuid)
 
const wxString & GetName () const
 
void SetName (const wxString &aName)
 
bool IsGroupedBy (DRILL_GROUP_KEY aKey) const
 
void SetGroupedBy (DRILL_GROUP_KEY aKey, bool aOn)
 
const std::set< DRILL_GROUP_KEY > & GroupKeys () const
 
DRILL_MARK_POLICY GetMarkPolicy () const
 
void SetMarkPolicy (DRILL_MARK_POLICY aPolicy)
 
int GetSymbolSize () const
 
void SetSymbolSize (int aSize)
 
int GetSymbolWidth () const
 
void SetSymbolWidth (int aWidth)
 
bool GetFreezeAssignments () const
 
void SetFreezeAssignments (bool aFreeze)
 
std::string GroupKeyString (const DRILL_OPERATION &aOperation) const
 Stable identity for a group under the currently enabled keys.
 
const std::map< std::string, DRILL_SYMBOL_ASSIGNMENT > & Assignments () const
 
const DRILL_SYMBOL_ASSIGNMENTGetAssignment (const std::string &aKey) const
 
void SetAssignment (const std::string &aKey, const DRILL_SYMBOL_ASSIGNMENT &aAssignment)
 
void ClearAssignments ()
 Assignments whose key no longer matches any hole are kept, so deleting and restoring a hole size does not shuffle the chart.
 
bool operator== (const DRILL_SYMBOL_PROFILE &aOther) const
 
uint64_t Fingerprint () const
 Cheap value used to notice an edit.
 

Private Attributes

KIID m_uuid
 
wxString m_name
 
std::set< DRILL_GROUP_KEYm_groupBy
 
DRILL_MARK_POLICY m_markPolicy
 
int m_symbolSize
 
int m_symbolWidth
 
bool m_freezeAssignments
 
std::map< std::string, DRILL_SYMBOL_ASSIGNMENTm_assignments
 

Detailed Description

Grouping rules and symbol assignments, shared by reference so a chart and its map can never disagree about which symbol means which hole.

Definition at line 85 of file drill_symbol_profile.h.

Constructor & Destructor Documentation

◆ DRILL_SYMBOL_PROFILE()

DRILL_SYMBOL_PROFILE::DRILL_SYMBOL_PROFILE ( )

Member Function Documentation

◆ Assignments()

const std::map< std::string, DRILL_SYMBOL_ASSIGNMENT > & DRILL_SYMBOL_PROFILE::Assignments ( ) const
inline

◆ ClearAssignments()

void DRILL_SYMBOL_PROFILE::ClearAssignments ( )
inline

Assignments whose key no longer matches any hole are kept, so deleting and restoring a hole size does not shuffle the chart.

Definition at line 130 of file drill_symbol_profile.h.

References m_assignments.

◆ Fingerprint()

uint64_t DRILL_SYMBOL_PROFILE::Fingerprint ( ) const

Cheap value used to notice an edit.

Not stored, so it need not be stable across builds.

Definition at line 116 of file drill_symbol_profile.cpp.

References m_assignments, m_freezeAssignments, m_groupBy, m_markPolicy, m_symbolSize, and m_symbolWidth.

Referenced by BOARD::DrillSymbolCache().

◆ GetAssignment()

const DRILL_SYMBOL_ASSIGNMENT * DRILL_SYMBOL_PROFILE::GetAssignment ( const std::string & aKey) const

◆ GetFreezeAssignments()

bool DRILL_SYMBOL_PROFILE::GetFreezeAssignments ( ) const
inline

◆ GetMarkPolicy()

DRILL_MARK_POLICY DRILL_SYMBOL_PROFILE::GetMarkPolicy ( ) const
inline

◆ GetName()

const wxString & DRILL_SYMBOL_PROFILE::GetName ( ) const
inline

◆ GetSymbolSize()

◆ GetSymbolWidth()

◆ GroupKeys()

const std::set< DRILL_GROUP_KEY > & DRILL_SYMBOL_PROFILE::GroupKeys ( ) const
inline

◆ GroupKeyString()

◆ IsGroupedBy()

bool DRILL_SYMBOL_PROFILE::IsGroupedBy ( DRILL_GROUP_KEY aKey) const
inline

Definition at line 96 of file drill_symbol_profile.h.

References m_groupBy.

Referenced by GroupKeyString(), and PANEL_SETUP_DRILL_CHART::loadSettings().

◆ operator==()

◆ SetAssignment()

void DRILL_SYMBOL_PROFILE::SetAssignment ( const std::string & aKey,
const DRILL_SYMBOL_ASSIGNMENT & aAssignment )

◆ SetFreezeAssignments()

void DRILL_SYMBOL_PROFILE::SetFreezeAssignments ( bool aFreeze)
inline

◆ SetGroupedBy()

◆ SetMarkPolicy()

void DRILL_SYMBOL_PROFILE::SetMarkPolicy ( DRILL_MARK_POLICY aPolicy)
inline

◆ SetName()

void DRILL_SYMBOL_PROFILE::SetName ( const wxString & aName)
inline

Definition at line 94 of file drill_symbol_profile.h.

References m_name.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::parseDrillSymbolProfile().

◆ SetSymbolSize()

void DRILL_SYMBOL_PROFILE::SetSymbolSize ( int aSize)
inline

◆ SetSymbolWidth()

void DRILL_SYMBOL_PROFILE::SetSymbolWidth ( int aWidth)
inline

◆ SetUuid()

void DRILL_SYMBOL_PROFILE::SetUuid ( const KIID & aUuid)
inline

Definition at line 91 of file drill_symbol_profile.h.

References m_uuid.

◆ Uuid()

const KIID & DRILL_SYMBOL_PROFILE::Uuid ( ) const
inline

Definition at line 90 of file drill_symbol_profile.h.

References m_uuid.

Member Data Documentation

◆ m_assignments

std::map<std::string, DRILL_SYMBOL_ASSIGNMENT> DRILL_SYMBOL_PROFILE::m_assignments
private

◆ m_freezeAssignments

bool DRILL_SYMBOL_PROFILE::m_freezeAssignments
private

◆ m_groupBy

std::set<DRILL_GROUP_KEY> DRILL_SYMBOL_PROFILE::m_groupBy
private

◆ m_markPolicy

DRILL_MARK_POLICY DRILL_SYMBOL_PROFILE::m_markPolicy
private

◆ m_name

wxString DRILL_SYMBOL_PROFILE::m_name
private

Definition at line 141 of file drill_symbol_profile.h.

Referenced by GetName(), operator==(), and SetName().

◆ m_symbolSize

int DRILL_SYMBOL_PROFILE::m_symbolSize
private

◆ m_symbolWidth

int DRILL_SYMBOL_PROFILE::m_symbolWidth
private

◆ m_uuid

KIID DRILL_SYMBOL_PROFILE::m_uuid
private

Definition at line 140 of file drill_symbol_profile.h.

Referenced by SetUuid(), and Uuid().


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