Container for design settings for a BOARD object. More...

#include <board_design_settings.h>

Inheritance diagram for BOARD_DESIGN_SETTINGS:

Classes
struct	VALIDATION_ERROR

Public Member Functions
	BOARD_DESIGN_SETTINGS (JSON_SETTINGS *aParent, const std::string &aPath)

virtual	~BOARD_DESIGN_SETTINGS ()

bool	operator== (const BOARD_DESIGN_SETTINGS &aOther) const

bool	operator!= (const BOARD_DESIGN_SETTINGS &aOther) const

	BOARD_DESIGN_SETTINGS (const BOARD_DESIGN_SETTINGS &aOther)

BOARD_DESIGN_SETTINGS &	operator= (const BOARD_DESIGN_SETTINGS &aOther)

bool	LoadFromFile (const wxString &aDirectory="") override
	Loads the backing file from disk and then calls Load()

BOARD_STACKUP &	GetStackupDescriptor ()

const BOARD_STACKUP &	GetStackupDescriptor () const

DRILL_SYMBOL_PROFILE &	GetDrillSymbolProfile ()

const DRILL_SYMBOL_PROFILE &	GetDrillSymbolProfile () const

TEARDROP_PARAMETERS_LIST *	GetTeadropParamsList ()

SEVERITY	GetSeverity (int aDRCErrorCode)

bool	Ignore (int aDRCErrorCode)
	Return true if the DRC error code's severity is SEVERITY_IGNORE.

std::vector< VALIDATION_ERROR >	ValidateDesignRules (std::optional< EDA_UNITS > aUnits=std::nullopt) const
	Validate design settings values and return per-field errors.

ZONE_SETTINGS &	GetDefaultZoneSettings ()

void	SetDefaultZoneSettings (const ZONE_SETTINGS &aSettings)

const wxString &	GetCurrentNetClassName () const

bool	UseNetClassTrack () const
	Return true if netclass values should be used to obtain appropriate track width.

bool	UseNetClassVia () const
	Return true if netclass values should be used to obtain appropriate via size.

bool	UseNetClassDiffPair () const
	Return true if netclass values should be used to obtain appropriate diff pair dimensions.

int	GetBiggestClearanceValue () const

int	GetSmallestClearanceValue () const

int	GetTrackWidthIndex () const

void	SetTrackWidthIndex (int aIndex)
	Set the current track width list index to aIndex.

int	GetNextTrackWidthIndex (int aIndex, bool aForward) const
	Compute the next track width list index when cycling predefined sizes, skipping the index-0 netclass placeholder on roll-over so the sequence stays monotonic.

int	GetCurrentTrackWidth () const

void	SetCustomTrackWidth (int aWidth)
	Sets custom width for track (i.e.

int	GetCustomTrackWidth () const

int	GetViaSizeIndex () const

int	GetViaStackIndex () const

void	SetViaStackIndex (int aIndex)
	Set the current via stack preset index to aIndex.

void	SetViaSizeIndex (int aIndex)
	Set the current via size list index to aIndex.

int	GetNextViaSizeIndex (int aIndex, bool aForward) const
	Compute the next via size list index when cycling predefined sizes, skipping the index-0 netclass placeholder on roll-over so the sequence stays monotonic.

int	GetCurrentViaSize () const

void	SetCustomViaSize (int aSize)
	Set custom size for via diameter (i.e.

int	GetCustomViaSize () const

int	GetCurrentViaDrill () const

void	SetCustomViaDrill (int aDrill)
	Sets custom size for via drill (i.e.

int	GetCustomViaDrill () const

void	UseCustomTrackViaSize (bool aEnabled)
	Enables/disables custom track/via size settings.

bool	UseCustomTrackViaSize () const

int	GetDiffPairIndex () const

void	SetDiffPairIndex (int aIndex)

int	GetNextDiffPairIndex (int aIndex, bool aForward) const
	Compute the next diff pair dimensions list index when cycling predefined sizes, skipping the index-0 netclass placeholder on roll-over so the sequence stays monotonic.

void	SetCustomDiffPairWidth (int aWidth)
	Sets custom track width for differential pairs (i.e.

int	GetCustomDiffPairWidth ()

void	SetCustomDiffPairGap (int aGap)
	Sets custom gap for differential pairs (i.e.

int	GetCustomDiffPairGap ()

void	SetCustomDiffPairViaGap (int aGap)
	Sets custom via gap for differential pairs (i.e.

int	GetCustomDiffPairViaGap ()

void	UseCustomDiffPairDimensions (bool aEnabled)
	Enables/disables custom differential pair dimensions.

bool	UseCustomDiffPairDimensions () const

int	GetCurrentDiffPairWidth () const

int	GetCurrentDiffPairGap () const

int	GetCurrentDiffPairViaGap () const

const LSET &	GetEnabledLayers () const
	Return a bit-mask of all the layers that are enabled.

void	SetEnabledLayers (const LSET &aMask)
	Change the bit-mask of enabled layers to aMask.

bool	IsLayerEnabled (PCB_LAYER_ID aLayerId) const
	Test whether a given layer aLayerId is enabled.

int	GetCopperLayerCount () const

void	SetCopperLayerCount (int aNewLayerCount)
	Set the copper layer count to aNewLayerCount.

int	GetUserDefinedLayerCount () const

void	SetUserDefinedLayerCount (int aNewLayerCount)
	Set the number of user defined layers to aNewLayerCount.

int	GetBoardThickness () const
	The full thickness of the board including copper and masks.

void	SetBoardThickness (int aThickness)

int	GetDRCEpsilon () const
	Return an epsilon which accounts for rounding errors, etc.

int	GetHolePlatingThickness () const
	Pad & via drills are finish size.

int	GetLineThickness (PCB_LAYER_ID aLayer) const
	Return the default graphic segment thickness from the layer class for the given layer.

VECTOR2I	GetTextSize (PCB_LAYER_ID aLayer) const
	Return the default text size from the layer class for the given layer.

int	GetTextThickness (PCB_LAYER_ID aLayer) const
	Return the default text thickness from the layer class for the given layer.

bool	GetTextItalic (PCB_LAYER_ID aLayer) const

bool	GetTextUpright (PCB_LAYER_ID aLayer) const

int	GetLayerClass (PCB_LAYER_ID aLayer) const

void	SetAuxOrigin (const VECTOR2I &aOrigin)

const VECTOR2I &	GetAuxOrigin () const

void	SetGridOrigin (const VECTOR2I &aOrigin)

const VECTOR2I &	GetGridOrigin () const

void	SetDefaultMasterPad ()

bool	SaveToFile (const wxString &aDirectory="", bool aForce=false) override
	Calls Store() and then saves the JSON document contents into the parent JSON_SETTINGS.

void	SetParent (JSON_SETTINGS *aParent, bool aLoadFromFile=true)

JSON_SETTINGS *	GetParent ()

wxString	GetFilename () const

wxString	GetFullFilename () const

void	SetFilename (const wxString &aFilename)

void	SetLocation (SETTINGS_LOC aLocation)

SETTINGS_LOC	GetLocation () const

virtual const PROJECT *	GetOwningProject () const
	Project-located settings override this to report the project they belong to so their save path is resolved against that project rather than the active one.

void	SetLegacyFilename (const wxString &aFilename)

bool	IsReadOnly () const

void	SetReadOnly (bool aReadOnly)

bool	ResetsParamsIfMissing () const

nlohmann::json &	At (const std::string &aPath)
	Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these functions take a string that is passed to PointerFromString internally.

bool	Contains (const std::string &aPath) const

JSON_SETTINGS_INTERNALS *	Internals ()

virtual void	Load ()
	Updates the parameters of this object based on the current JSON document contents.

virtual bool	Store ()
	Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER.

bool	IsFileSynced () const

void	ResetToDefaults ()
	Resets all parameters to default values.

std::optional< nlohmann::json >	GetJson (const std::string &aPath) const
	Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects.

template<typename ValueType>
std::optional< ValueType >	Get (const std::string &aPath) const
	Fetches a value from within the JSON document.

template<>
std::optional< wxString >	Get (const std::string &aPath) const

template<>
KICOMMON_API std::optional< wxString >	Get (const std::string &aPath) const

template<typename ValueType>
void	Set (const std::string &aPath, ValueType aVal)
	Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle.

template<>
void	Set (const std::string &aPath, wxString aVal)

template<>
KICOMMON_API void	Set (const std::string &aPath, wxString aVal)

virtual std::map< std::string, nlohmann::json >	GetFileHistories ()

bool	Migrate ()
	Migrates the schema of this settings from the version in the file to the latest version.

virtual bool	MigrateFromLegacy (wxConfigBase *aLegacyConfig)
	Migrates from wxConfig to JSON-based configuration.

void	AddNestedSettings (NESTED_SETTINGS *aSettings)
	Transfers ownership of a given NESTED_SETTINGS to this object.

void	ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
	Saves and frees a nested settings object, if it exists within this one.

void	SetManager (SETTINGS_MANAGER *aManager)

const std::string	FormatAsString ()

bool	LoadFromRawFile (const wxString &aPath)

Static Public Member Functions
static bool	SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
	Sets the given string if the given key/path is present.

static bool	SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, bool &aTarget)
	Sets the given bool if the given key/path is present.

static bool	SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, int &aTarget)
	Sets the given int if the given key/path is present.

static bool	SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, unsigned int &aTarget)
	Sets the given unsigned int if the given key/path is present.

Public Attributes
std::vector< int >	m_TrackWidthList

std::vector< VIA_DIMENSION >	m_ViasDimensionsList

std::vector< VIA_STACK_PRESET >	m_ViaStackPresets

std::vector< DIFF_PAIR_DIMENSION >	m_DiffPairDimensionsList

TEARDROP_PARAMETERS_LIST	m_TeardropParamsList
	The parameters of teardrops for the different teardrop targets (via/pad, track end).

PNS::MEANDER_SETTINGS	m_SingleTrackMeanderSettings

PNS::MEANDER_SETTINGS	m_DiffPairMeanderSettings

PNS::MEANDER_SETTINGS	m_SkewMeanderSettings

VIATYPE	m_CurrentViaType
	(VIA_BLIND_BURIED, VIA_THROUGH, VIA_MICROVIA)

bool	m_UseConnectedTrackWidth

bool	m_TempOverrideTrackWidth

int	m_MinClearance

int	m_MinGrooveWidth

int	m_MinConn

int	m_TrackMinWidth

int	m_ViasMinAnnularWidth

int	m_ViasMinSize

int	m_MinThroughDrill

int	m_MicroViasMinSize

int	m_MicroViasMinDrill

int	m_CopperEdgeClearance

int	m_HoleClearance

int	m_HoleToHoleMin

int	m_SilkClearance

int	m_MinResolvedSpokes

int	m_MinSilkTextHeight

int	m_MinSilkTextThickness

std::shared_ptr< DRC_ENGINE >	m_DRCEngine

std::map< int, SEVERITY >	m_DRCSeverities

std::set< DRC_EXCLUSION, DRC_EXCLUSION_COMPARE >	m_DrcExclusions

bool	m_ZoneKeepExternalFillets

int	m_MaxError

int	m_SolderMaskExpansion

int	m_SolderMaskMinWidth

int	m_SolderMaskToCopperClearance

int	m_SolderPasteMargin

double	m_SolderPasteMarginRatio

bool	m_AllowSoldermaskBridgesInFPs

bool	m_TentViasFront

bool	m_TentViasBack

bool	m_CoverViasFront

bool	m_CoverViasBack

bool	m_PlugViasFront

bool	m_PlugViasBack

bool	m_CapVias

bool	m_FillVias

std::shared_ptr< NET_SETTINGS >	m_NetSettings

std::vector< TEXT_ITEM_INFO >	m_DefaultFPTextItems

std::map< std::string, wxString >	m_UserLayerNames

std::map< PCB_LAYER_ID, ZONE_LAYER_PROPERTIES >	m_ZoneLayerProperties

int	m_LineThickness [LAYER_CLASS_COUNT]

VECTOR2I	m_TextSize [LAYER_CLASS_COUNT]

int	m_TextThickness [LAYER_CLASS_COUNT]

bool	m_TextItalic [LAYER_CLASS_COUNT]

bool	m_TextUpright [LAYER_CLASS_COUNT]

DIM_UNITS_MODE	m_DimensionUnitsMode

DIM_PRECISION	m_DimensionPrecision
	Number of digits after the decimal.

DIM_UNITS_FORMAT	m_DimensionUnitsFormat

bool	m_DimensionSuppressZeroes

DIM_TEXT_POSITION	m_DimensionTextPosition

bool	m_DimensionKeepTextAligned

int	m_DimensionArrowLength

int	m_DimensionExtensionOffset

bool	m_StyleFPFields

bool	m_StyleFPText

bool	m_StyleFPShapes

bool	m_StyleFPDimensions

bool	m_StyleFPBarcodes

std::unique_ptr< PAD >	m_Pad_Master

bool	m_HasStackup

bool	m_UseHeightForLengthCalcs
	Enable inclusion of stackup height in track length measurements and length tuning.

wxString	m_BomExportFileName

BOM_PRESET	m_BomSettings
	List of stored BOM presets.

std::vector< BOM_PRESET >	m_BomPresets

BOM_FMT_PRESET	m_BomFmtSettings
	List of stored BOM format presets.

std::vector< BOM_FMT_PRESET >	m_BomFmtPresets

Protected Member Functions
void	registerMigration (int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
	Registers a migration from one schema version to another.

template<typename ValueType>
bool	fromLegacy (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
	Translates a legacy wxConfig value to a given JSON pointer value.

bool	fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
	Translates a legacy wxConfig string value to a given JSON pointer value.

bool	fromLegacyColor (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
	Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value.

bool	flushToStore ()
	Flushes nested settings and parameters into the JSON store.

std::string	formatFileContents ()
	Overlays the current store on the original file contents.

virtual wxString	getFileExt () const

virtual wxString	getLegacyFileExt () const

Static Protected Member Functions
template<typename ResultType>
static ResultType	fetchOrDefault (const nlohmann::json &aJson, const std::string &aKey, ResultType aDefault=ResultType())
	Helper to retrieve a value from a JSON object (dictionary) as a certain result type.

Protected Attributes
JSON_SETTINGS *	m_parent
	A pointer to the parent object to load and store from.

std::string	m_path
	The path (in pointer format) of where to store this document in the parent.

wxString	m_filename
	The filename (not including path) of this settings file (inicode)

wxString	m_legacy_filename
	The filename of the wxConfig legacy file (if different from m_filename)

SETTINGS_LOC	m_location
	The location of this settings file (.

std::vector< PARAM_BASE * >	m_params
	The list of parameters (owned by this object)

std::vector< NESTED_SETTINGS * >	m_nested_settings
	Nested settings files that live inside this one, if any.

bool	m_createIfMissing
	Whether or not the backing store file should be created it if doesn't exist.

bool	m_createIfDefault
	Whether or not the backing store file should be created if all parameters are still at their default values.

bool	m_writeFile
	Whether or not the backing store file should be written.

bool	m_modified
	True if the JSON data store has been written to since the last file write.

bool	m_fileSynced
	True once the store has been synchronized with an on-disk file (loaded or saved)

bool	m_deleteLegacyAfterMigration
	Whether or not to delete legacy file after migration.

bool	m_resetParamsIfMissing
	Whether or not to set parameters to their default value if missing from JSON on Load()

int	m_schemaVersion
	Version of this settings schema.

bool	m_isFutureFormat
	Set to true if this settings is loaded from a file with a newer schema version than is known.

SETTINGS_MANAGER *	m_manager
	A pointer to the settings manager managing this file (may be null)

std::map< int, std::pair< int, std::function< bool()> > >	m_migrators
	A map of starting schema version to a pair of <ending version, migrator function>

std::unique_ptr< JSON_SETTINGS_INTERNALS >	m_internals

Private Member Functions
void	initFromOther (const BOARD_DESIGN_SETTINGS &aOther)

bool	migrateSchema0to1 ()

bool	migrateSchema2to3 ()

Private Attributes
VECTOR2I	m_auxOrigin
	origin for plot exports

VECTOR2I	m_gridOrigin
	origin for grid offsets

int	m_trackWidthIndex

int	m_viaSizeIndex

int	m_diffPairIndex

int	m_viaStackIndex

bool	m_useCustomTrackVia

int	m_customTrackWidth

VIA_DIMENSION	m_customViaSize

bool	m_useCustomDiffPair

DIFF_PAIR_DIMENSION	m_customDiffPair

int	m_copperLayerCount
	Number of copper layers for this design.

int	m_userDefinedLayerCount
	Number of user defined layers for this design.

LSET	m_enabledLayers
	Bit-mask for layer enabling.

int	m_boardThickness
	Board thickness for 3D viewer.

wxString	m_currentNetClassName
	Current net class name used to display netclass info.

BOARD_STACKUP	m_stackup
	The description of layers stackup, for board fabrication only physical layers are in layers stackup.

DRILL_SYMBOL_PROFILE	m_drillSymbolProfile
	Grouping rules and symbol assignments shared by every drill chart and map on the board.

ZONE_SETTINGS	m_defaultZoneSettings
	The default settings that will be used for new zones.

Detailed Description

Container for design settings for a BOARD object.

Definition at line 277 of file board_design_settings.h.

Constructor & Destructor Documentation

◆ BOARD_DESIGN_SETTINGS() [1/2]

BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS	(	JSON_SETTINGS *	aParent,
		const std::string &	aPath )

Definition at line 42 of file board_design_settings.cpp.

Referenced by BOARD_DESIGN_SETTINGS(), initFromOther(), operator!=(), operator=(), and operator==().

◆ ~BOARD_DESIGN_SETTINGS()

BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS ( )

virtual

Definition at line 1211 of file board_design_settings.cpp.

References NESTED_SETTINGS::m_parent.

◆ BOARD_DESIGN_SETTINGS() [2/2]

BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS ( const BOARD_DESIGN_SETTINGS & aOther )

Definition at line 1221 of file board_design_settings.cpp.

References bdsSchemaVersion, BOARD_DESIGN_SETTINGS(), initFromOther(), m_Pad_Master, NESTED_SETTINGS::m_parent, NESTED_SETTINGS::m_path, and NESTED_SETTINGS::NESTED_SETTINGS().

Member Function Documentation

◆ AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings ( NESTED_SETTINGS * aSettings )

inherited

Transfers ownership of a given NESTED_SETTINGS to this object.

Can be used to construct a NESTED_SETTINGS without the parent object needing to know about the implementation of the nested object;

Parameters

aSettings is the settings object to take ownership of

Definition at line 934 of file json_settings.cpp.

References GetFilename(), m_nested_settings, NESTED_SETTINGS, and traceSettings.

◆ At()

nlohmann::json & JSON_SETTINGS::At ( const std::string & aPath )

inherited

Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these functions take a string that is passed to PointerFromString internally.

Definition at line 126 of file json_settings.cpp.

References m_internals.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::migrateBomSettings(), EESCHEMA_SETTINGS::migrateFieldNameTemplates(), GERBVIEW_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), and PCBNEW_SETTINGS::PCBNEW_SETTINGS().

◆ Contains()

bool JSON_SETTINGS::Contains ( const std::string & aPath ) const

inherited

Definition at line 132 of file json_settings.cpp.

References m_internals, and JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), GERBVIEW_SETTINGS::GetFileHistories(), GetFileHistories(), BOARD_DESIGN_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::migrateBomSettings(), EESCHEMA_SETTINGS::migrateFieldNameTemplates(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COMMON_SETTINGS::migrateSchema5to6(), COMMON_SETTINGS::migrateSchema6to7(), and SETTINGS_MANAGER::SaveColorSettings().

◆ fetchOrDefault()

template<typename ResultType>

template KICOMMON_API bool JSON_SETTINGS::fetchOrDefault	(	const nlohmann::json &	aJson,
		const std::string &	aKey,
		ResultType	aDefault = ResultType() )

staticprotectedinherited

Helper to retrieve a value from a JSON object (dictionary) as a certain result type.

Template Parameters

ResultType is the type of the retrieved value.

Parameters

aJson	is the object to act on .
aKey	is the object key to retrieve the value for.
aDefault	is the default result type.

Returns: the result, or aDefault if aKey is not found.

Definition at line 987 of file json_settings.cpp.

◆ flushToStore()

bool JSON_SETTINGS::flushToStore ( )

protectedinherited

Flushes nested settings and parameters into the JSON store.

Returns: true if the store holds changes not yet written to the file

Definition at line 543 of file json_settings.cpp.

References m_nested_settings, NESTED_SETTINGS, and Store().

Referenced by SaveToFile(), and PROJECT_FILE::SerializeToString().

◆ FormatAsString()

const std::string JSON_SETTINGS::FormatAsString ( )

inherited

Definition at line 582 of file json_settings.cpp.

References dummy, m_internals, and Store().

◆ formatFileContents()

std::string JSON_SETTINGS::formatFileContents ( )

protectedinherited

Overlays the current store on the original file contents.

May throw a JSON exception.

Returns: the serialized bytes in the on-disk format

Definition at line 560 of file json_settings.cpp.

References dummy, m_internals, m_params, and JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by SaveToFile(), and PROJECT_FILE::SerializeToString().

◆ fromLegacy()

template<typename ValueType>

template KICOMMON_API bool JSON_SETTINGS::fromLegacy< bool >	(	wxConfigBase *	aConfig,
		const std::string &	aKey,
		const std::string &	aDest )

protectedinherited

Translates a legacy wxConfig value to a given JSON pointer value.

Template Parameters

ValueType is the basic type of the value

Parameters

aConfig	is the legacy config to read from
aKey	is the key (within the current path) to read
aDest	is a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 849 of file json_settings.cpp.

◆ fromLegacyColor()

bool JSON_SETTINGS::fromLegacyColor	(	wxConfigBase *	aConfig,
		const std::string &	aKey,
		const std::string &	aDest )

protectedinherited

Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value.

Parameters

aConfig	is the legacy config to read from
aKey	is the key (within the current path) to read
aDest	is a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 907 of file json_settings.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::COLOR4D::g, KIGFX::COLOR4D::r, and KIGFX::COLOR4D::SetFromWxString().

◆ fromLegacyString()

bool JSON_SETTINGS::fromLegacyString	(	wxConfigBase *	aConfig,
		const std::string &	aKey,
		const std::string &	aDest )

protectedinherited

Translates a legacy wxConfig string value to a given JSON pointer value.

Parameters

aConfig	is the legacy config to read from
aKey	is the key (within the current path) to read
aDest	is a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 884 of file json_settings.cpp.

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy(), BITMAP2CMP_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().

◆ Get() [1/3]

template<>

std::optional< wxString > JSON_SETTINGS::Get ( const std::string & aPath ) const

inherited

Definition at line 970 of file json_settings.cpp.

References GetJson().

◆ Get() [2/3]

template<typename ValueType>

template KICOMMON_API std::optional< wxAuiPaneInfo > JSON_SETTINGS::Get< wxAuiPaneInfo > ( const std::string & aPath ) const

inherited

Fetches a value from within the JSON document.

Will return an empty optional if the value is not found or a mismatching type.

Template Parameters

ValueType is the type to cast to

Parameters

aPath is the path within the document to retrieve

Returns: a value from within this document

Definition at line 646 of file json_settings.cpp.

References GetJson().

Referenced by BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), JSON_SETTINGS::Get< KIGFX::COLOR4D >(), JSON_SETTINGS::Get< KIGFX::CROSS_HAIR_MODE >(), JSON_SETTINGS::Get< nlohmann::json >(), JSON_SETTINGS::Get< std::string >(), COLOR_MAP_PARAM::Load(), PARAM< ValueType >::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< ValueType >::Load(), PARAM_SCALED< ValueType >::Load(), COLOR_MAP_PARAM::MatchesFile(), PARAM< ValueType >::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), EESCHEMA_SETTINGS::migrateBomSettings(), EESCHEMA_SETTINGS::migrateFieldNameTemplates(), COMMON_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::SaveAs(), and SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ Get() [3/3]

template<>

template std::optional< wxAuiPaneInfo > JSON_SETTINGS::Get< wxAuiPaneInfo > ( const std::string & aPath ) const

inherited

References KICOMMON_API.

◆ GetAuxOrigin()

const VECTOR2I & BOARD_DESIGN_SETTINGS::GetAuxOrigin ( ) const

inline

Definition at line 688 of file board_design_settings.h.

References m_auxOrigin.

Referenced by AddGerberX2Header(), IPC356D_WRITER::appendPadRecords(), appendViaRecords(), PCB_IO_EAGLE::centerBoard(), checkImportedOriginOffset(), PCB_IO_ODBPP::ConfigureExport(), PCB_IO_KICAD_SEXPR::formatSetup(), API_HANDLER_PCB::handleGetBoardOrigin(), initializePlotter(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportGencad(), and ALTIUM_PCB::Parse().

◆ GetBiggestClearanceValue()

int BOARD_DESIGN_SETTINGS::GetBiggestClearanceValue ( ) const

Returns: the biggest clearance value found in NetClasses list.

Definition at line 1802 of file board_design_settings.cpp.

References CLEARANCE_CONSTRAINT, EDGE_CLEARANCE_CONSTRAINT, HOLE_CLEARANCE_CONSTRAINT, HOLE_TO_HOLE_CONSTRAINT, m_CopperEdgeClearance, m_DRCEngine, m_HoleClearance, m_HoleToHoleMin, m_MinClearance, MAXIMUM_CLEARANCE, MINOPTMAX< T >::Min(), PHYSICAL_CLEARANCE_CONSTRAINT, PHYSICAL_HOLE_CLEARANCE_CONSTRAINT, and DRC_CONSTRAINT::Value().

Referenced by BOOST_AUTO_TEST_CASE(), and ZONE_FILLER::buildThermalSpokes().

◆ GetBoardThickness()

int BOARD_DESIGN_SETTINGS::GetBoardThickness ( ) const

inline

The full thickness of the board including copper and masks.

Returns

Definition at line 649 of file board_design_settings.h.

References m_boardThickness.

Referenced by KICAD_DIFF::PCB_MERGE_APPLIER::Apply(), BOOST_AUTO_TEST_CASE(), BOARD_STACKUP::BuildDefaultStackupList(), KICAD_DIFF::PCB_DIFFER::Diff(), PCB_IO_KICAD_SEXPR::formatGeneral(), DIALOG_MIGRATE_3D_MODELS::initPreviewBoard(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), and PANEL_PREVIEW_3D_MODEL::View3DSettings().

◆ GetCopperLayerCount()

int BOARD_DESIGN_SETTINGS::GetCopperLayerCount ( ) const

inline

Returns: the number of enabled copper layers.

Definition at line 624 of file board_design_settings.h.

References m_copperLayerCount.

Referenced by Build_Board_Characteristics_Table(), BOARD_STACKUP::BuildDefaultStackupList(), BOARD::GetCopperLayerCount(), and ROUTER_TOOL::handleLayerSwitch().

◆ GetCurrentDiffPairGap()

int BOARD_DESIGN_SETTINGS::GetCurrentDiffPairGap ( ) const

Returns: the current diff pair gap, according to the selected options ( using the default netclass value or a preset/custom value )

Definition at line 1973 of file board_design_settings.cpp.

References m_customDiffPair, m_DiffPairDimensionsList, m_diffPairIndex, m_NetSettings, and m_useCustomDiffPair.

Referenced by GetCurrentDiffPairViaGap(), and PNS_KICAD_IFACE_BASE::ImportSizes().

◆ GetCurrentDiffPairViaGap()

int BOARD_DESIGN_SETTINGS::GetCurrentDiffPairViaGap ( ) const

Returns: the current diff pair via gap, according to the selected options ( using the default netclass value or a preset/custom value ) the default netclass is always in m_DiffPairDimensionsList[0].

Definition at line 1993 of file board_design_settings.cpp.

References GetCurrentDiffPairGap(), m_customDiffPair, m_DiffPairDimensionsList, m_diffPairIndex, m_NetSettings, and m_useCustomDiffPair.

Referenced by PNS_KICAD_IFACE_BASE::ImportSizes().

◆ GetCurrentDiffPairWidth()

int BOARD_DESIGN_SETTINGS::GetCurrentDiffPairWidth ( ) const

Returns: the current diff pair track width, according to the selected options ( using the default netclass value or a preset/custom value )

Definition at line 1953 of file board_design_settings.cpp.

References m_customDiffPair, m_DiffPairDimensionsList, m_diffPairIndex, m_NetSettings, and m_useCustomDiffPair.

Referenced by PNS_KICAD_IFACE_BASE::ImportSizes().

◆ GetCurrentNetClassName()

const wxString & BOARD_DESIGN_SETTINGS::GetCurrentNetClassName ( ) const

inline

Returns: the current net class name.

Definition at line 340 of file board_design_settings.h.

References m_currentNetClassName.

◆ GetCurrentTrackWidth()

int BOARD_DESIGN_SETTINGS::GetCurrentTrackWidth ( ) const

Returns: the current track width according to the selected options ( using the default netclass value or a preset/custom value ) the default netclass is always in m_TrackWidthList[0]

Definition at line 1927 of file board_design_settings.cpp.

References m_customTrackWidth, m_NetSettings, m_trackWidthIndex, m_TrackWidthList, and m_useCustomTrackVia.

Referenced by BOOST_AUTO_TEST_CASE(), DIALOG_VIA_STITCH_PROPERTIES::buildGuardPreview(), PCB_VIA_STACK::BuildMembers(), MICROWAVE_TOOL::createBaseFootprint(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createInductorBetween(), PNS_KICAD_IFACE_BASE::ImportSizes(), and PCB_EDIT_FRAME::SetTrackSegmentWidth().

◆ GetCurrentViaDrill()

int BOARD_DESIGN_SETTINGS::GetCurrentViaDrill ( ) const

Returns: the current via size, according to the selected options ( using the default netclass value or a preset/custom value ) the default netclass is always in m_TrackWidthList[0].

Definition at line 1897 of file board_design_settings.cpp.

References m_customViaSize, m_NetSettings, m_useCustomTrackVia, m_ViasDimensionsList, and m_viaSizeIndex.

Referenced by PCB_VIA_STACK::BuildMembers(), PCB_VIA_STITCH::defaultViaDrill(), DRAWING_TOOL::DrawVia(), PCB_VIA_STACK::GetNetclassViaSize(), ROUTER_TOOL::handleLayerSwitch(), PNS_KICAD_IFACE_BASE::ImportSizes(), ROUTER_TOOL::onViaStackCommand(), and PCB_EDIT_FRAME::SetTrackSegmentWidth().

◆ GetCurrentViaSize()

int BOARD_DESIGN_SETTINGS::GetCurrentViaSize ( ) const

Returns: the current via size, according to the selected options ( using the default netclass value or a preset/custom value ) the default netclass is always in m_TrackWidthList[0]

Definition at line 1886 of file board_design_settings.cpp.

References m_customViaSize, m_NetSettings, m_useCustomTrackVia, m_ViasDimensionsList, and m_viaSizeIndex.

Referenced by PCB_VIA_STACK::BuildMembers(), PCB_VIA_STITCH::defaultViaSize(), DRAWING_TOOL::DrawVia(), PCB_VIA_STACK::GetNetclassViaSize(), ROUTER_TOOL::handleLayerSwitch(), PNS_KICAD_IFACE_BASE::ImportSizes(), ROUTER_TOOL::onViaStackCommand(), and PCB_EDIT_FRAME::SetTrackSegmentWidth().

◆ GetCustomDiffPairGap()

int BOARD_DESIGN_SETTINGS::GetCustomDiffPairGap ( )

inline

Returns: Current custom gap width for differential pairs.

Definition at line 544 of file board_design_settings.h.

References m_customDiffPair.

Referenced by BOARD::SynchronizeNetsAndNetClasses().

◆ GetCustomDiffPairViaGap()

int BOARD_DESIGN_SETTINGS::GetCustomDiffPairViaGap ( )

inline

Returns: Current custom via gap width for differential pairs.

Definition at line 557 of file board_design_settings.h.

References m_customDiffPair.

◆ GetCustomDiffPairWidth()

int BOARD_DESIGN_SETTINGS::GetCustomDiffPairWidth ( )

inline

Returns: Current custom track width for differential pairs.

Definition at line 532 of file board_design_settings.h.

References m_customDiffPair.

◆ GetCustomTrackWidth()

int BOARD_DESIGN_SETTINGS::GetCustomTrackWidth ( ) const

inline

Definition at line 410 of file board_design_settings.h.

References m_customTrackWidth.

◆ GetCustomViaDrill()

int BOARD_DESIGN_SETTINGS::GetCustomViaDrill ( ) const

inline

Returns: Current custom size for the via drill.

Definition at line 485 of file board_design_settings.h.

References m_customViaSize.

◆ GetCustomViaSize()

int BOARD_DESIGN_SETTINGS::GetCustomViaSize ( ) const

inline

Returns: Current custom size for the via diameter.

Definition at line 463 of file board_design_settings.h.

References m_customViaSize.

◆ GetDefaultZoneSettings()

ZONE_SETTINGS & BOARD_DESIGN_SETTINGS::GetDefaultZoneSettings ( )

inline

Definition at line 327 of file board_design_settings.h.

References m_defaultZoneSettings.

Referenced by CONVERT_TOOL::CreatePolys(), PANEL_SETUP_ZONES::ImportSettingsFrom(), PCB_IO_KICAD_LEGACY::loadSETUP(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_EASYEDAPRO_V3_PARSER::ParseBoard(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), and ZONE::ZONE().

◆ GetDiffPairIndex()

int BOARD_DESIGN_SETTINGS::GetDiffPairIndex ( ) const

inline

Returns: the current diff pair dimension list index.

Definition at line 505 of file board_design_settings.h.

References m_diffPairIndex.

Referenced by BOOST_AUTO_TEST_CASE(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), and DIFF_PAIR_MENU::update().

◆ GetDRCEpsilon()

int BOARD_DESIGN_SETTINGS::GetDRCEpsilon ( ) const

Return an epsilon which accounts for rounding errors, etc.

While currently an advanced cfg, going through this API allows us to easily change it to board-specific if so desired.

Definition at line 2077 of file board_design_settings.cpp.

References ADVANCED_CFG::GetCfg(), and pcbIUScale.

Referenced by BOOST_FIXTURE_TEST_CASE(), DRAWING_TOOL::DrawVia(), PCB_TUNING_PATTERN::EditFinish(), getDeflatedZoneOutline(), DRC_ENGINE::IsNetTieExclusion(), TEARDROP_MANAGER::pairClearance(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), and PCB_TUNING_PATTERN::Update().

◆ GetDrillSymbolProfile() [1/2]

DRILL_SYMBOL_PROFILE & BOARD_DESIGN_SETTINGS::GetDrillSymbolProfile ( )

inline

◆ GetDrillSymbolProfile() [2/2]

const DRILL_SYMBOL_PROFILE & BOARD_DESIGN_SETTINGS::GetDrillSymbolProfile ( ) const

inline

Definition at line 306 of file board_design_settings.h.

References m_drillSymbolProfile.

◆ GetEnabledLayers()

const LSET & BOARD_DESIGN_SETTINGS::GetEnabledLayers ( ) const

inline

Return a bit-mask of all the layers that are enabled.

Returns: the enabled layers in bit-mapped form.

Definition at line 598 of file board_design_settings.h.

References m_enabledLayers.

Referenced by BOARD_STACKUP::BuildDefaultStackupList(), LENGTH_DELAY_CALCULATION_ITEM::CalculateViaLayers(), BOARD::GetEnabledLayers(), and PCB_IO_GEDA::loadBoard().

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const

inlineprotectedvirtualinherited

Reimplemented in DATABASE_LIB_SETTINGS, HTTP_LIB_SETTINGS, JOBSET, PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 326 of file json_settings.h.

Referenced by GetFullFilename(), LoadFromFile(), and SaveToFile().

◆ GetFileHistories()

std::map< std::string, nlohmann::json > JSON_SETTINGS::GetFileHistories ( )

virtualinherited

Reimplemented in GERBVIEW_SETTINGS.

Definition at line 406 of file json_settings.cpp.

References Contains(), and GetJson().

Referenced by GERBVIEW_SETTINGS::GetFileHistories().

◆ GetFilename()

wxString JSON_SETTINGS::GetFilename ( ) const

inlineinherited

Definition at line 88 of file json_settings.h.

References m_filename.

Referenced by AddNestedSettings(), SETTINGS_MANAGER::loadAllColorSettings(), SETTINGS_MANAGER::loadColorSettingsByName(), NESTED_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PANEL_GERBVIEW_COLOR_SETTINGS::PANEL_GERBVIEW_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), PCB_PLOTTER::PlotJobToPlotOpts(), DIALOG_PLOT_SCHEMATIC::plotSchematic(), PROJECT_FILE::SaveAs(), SETTINGS_MANAGER::SaveColorSettings(), DIALOG_PRINT::SavePrintOptions(), DIALOG_PRINT_PCBNEW::saveSettings(), NESTED_SETTINGS::SaveToFile(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), and PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow().

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const

inherited

Definition at line 117 of file json_settings.cpp.

References getFileExt(), and m_filename.

Referenced by JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), SaveToFile(), and PROJECT_FILE::SerializeToString().

◆ GetGridOrigin()

const VECTOR2I & BOARD_DESIGN_SETTINGS::GetGridOrigin ( ) const

inline

Definition at line 691 of file board_design_settings.h.

References m_gridOrigin.

Referenced by PCB_IO_EAGLE::centerBoard(), checkImportedOriginOffset(), PCB_IO_ODBPP::ConfigureExport(), PCB_IO_KICAD_SEXPR::formatSetup(), DIALOG_POSITION_RELATIVE::getAnchorPos(), API_HANDLER_PCB::handleGetBoardOrigin(), ALTIUM_PCB::Parse(), and PCB_BASE_EDIT_FRAME::SetBoard().

◆ GetHolePlatingThickness()

int BOARD_DESIGN_SETTINGS::GetHolePlatingThickness ( ) const

Pad & via drills are finish size.

Adding the hole plating thickness gives you the actual hole size.

Definition at line 2083 of file board_design_settings.cpp.

References ADVANCED_CFG::GetCfg(), and pcbIUScale.

Referenced by KIGFX::PCB_PAINTER::Draw().

◆ GetJson()

std::optional< nlohmann::json > JSON_SETTINGS::GetJson ( const std::string & aPath ) const

inherited

Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects.

Parameters

aPath is a string containing one or more keys separated by '.'

Returns: a JSON object from within this one

Definition at line 626 of file json_settings.cpp.

References m_internals.

Referenced by BOOST_AUTO_TEST_CASE(), Get(), GERBVIEW_SETTINGS::GetFileHistories(), GetFileHistories(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< Type >::Load(), PARAM_MAP< Value >::Load(), PARAM_SET< Type >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< Type >::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_SET< Type >::MatchesFile(), PARAM_WXSTRING_MAP::MatchesFile(), PROJECT_FILE::migrateSchema3To4(), SETTINGS_MANAGER::SaveColorSettings(), and PROJECT_FILE::Store().

◆ GetLayerClass()

int BOARD_DESIGN_SETTINGS::GetLayerClass ( PCB_LAYER_ID aLayer ) const

Definition at line 2060 of file board_design_settings.cpp.

References B_CrtYd, B_Fab, B_SilkS, Edge_Cuts, F_CrtYd, F_Fab, F_SilkS, IsCopperLayer(), LAYER_CLASS_COPPER, LAYER_CLASS_COURTYARD, LAYER_CLASS_EDGES, LAYER_CLASS_FAB, LAYER_CLASS_OTHERS, and LAYER_CLASS_SILK.

Referenced by CONVERT_TOOL::CreatePolys(), GetLineThickness(), GetTextItalic(), GetTextSize(), GetTextThickness(), and GetTextUpright().

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const

inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 331 of file json_settings.h.

Referenced by LoadFromFile().

◆ GetLineThickness()

int BOARD_DESIGN_SETTINGS::GetLineThickness ( PCB_LAYER_ID aLayer ) const

Return the default graphic segment thickness from the layer class for the given layer.

Definition at line 2089 of file board_design_settings.cpp.

References GetLayerClass(), and m_LineThickness.

Referenced by ZONE_CREATE_HELPER::commitZone(), FABMASTER::createBoardItems(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), PCB_IO_EAGLE::loadPlain(), FABMASTER::loadPolygon(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), DIALOG_TEXTBOX_PROPERTIES::onBorderChecked(), DIALOG_TABLE_PROPERTIES::onHeaderChecked(), DIALOG_OUTSET_ITEMS::OnLayerDefaultClick(), PCB_IO_EAGLE::packageWire(), DIALOG_PLOT::Plot(), DRAWING_TOOL::Reset(), PCB_DIMENSION_BASE::StyleFromSettings(), and PCB_SHAPE::StyleFromSettings().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const

inlineinherited

Definition at line 95 of file json_settings.h.

References m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile(), and COLOR_SETTINGS::migrateSchema0to1().

◆ GetNextDiffPairIndex()

int BOARD_DESIGN_SETTINGS::GetNextDiffPairIndex	(	int	aIndex,
		bool	aForward ) const

Compute the next diff pair dimensions list index when cycling predefined sizes, skipping the index-0 netclass placeholder on roll-over so the sequence stays monotonic.

Parameters

aIndex	is the index of the next differential pair.
aForward	steps larger when true, smaller when false.

Definition at line 1947 of file board_design_settings.cpp.

References m_DiffPairDimensionsList, and nextPredefinedIndex().

Referenced by BOOST_AUTO_TEST_CASE(), BOARD_EDITOR_CONTROL::TrackWidthDec(), and BOARD_EDITOR_CONTROL::TrackWidthInc().

◆ GetNextTrackWidthIndex()

int BOARD_DESIGN_SETTINGS::GetNextTrackWidthIndex	(	int	aIndex,
		bool	aForward ) const

Compute the next track width list index when cycling predefined sizes, skipping the index-0 netclass placeholder on roll-over so the sequence stays monotonic.

Parameters

aIndex	is the start index track width buffer.
aForward	steps larger when true, smaller when false.

Definition at line 1921 of file board_design_settings.cpp.

References m_TrackWidthList, and nextPredefinedIndex().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOARD_EDITOR_CONTROL::TrackWidthDec(), and BOARD_EDITOR_CONTROL::TrackWidthInc().

◆ GetNextViaSizeIndex()

int BOARD_DESIGN_SETTINGS::GetNextViaSizeIndex	(	int	aIndex,
		bool	aForward ) const

Compute the next via size list index when cycling predefined sizes, skipping the index-0 netclass placeholder on roll-over so the sequence stays monotonic.

Parameters

aIndex	is the via size list index.
aForward	steps larger when true, smaller when false.

Definition at line 1880 of file board_design_settings.cpp.

References m_ViasDimensionsList, and nextPredefinedIndex().

Referenced by BOOST_AUTO_TEST_CASE(), BOARD_EDITOR_CONTROL::ViaSizeDec(), and BOARD_EDITOR_CONTROL::ViaSizeInc().

◆ GetOwningProject()

virtual const PROJECT * JSON_SETTINGS::GetOwningProject ( ) const

inlinevirtualinherited

Project-located settings override this to report the project they belong to so their save path is resolved against that project rather than the active one.

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 101 of file json_settings.h.

References PROJECT.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ GetParent()

JSON_SETTINGS * NESTED_SETTINGS::GetParent ( )

inlineinherited

Definition at line 55 of file nested_settings.h.

References JSON_SETTINGS::JSON_SETTINGS(), and m_parent.

Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile().

◆ GetSeverity()

SEVERITY BOARD_DESIGN_SETTINGS::GetSeverity ( int aDRCErrorCode )

Definition at line 1626 of file board_design_settings.cpp.

References m_DRCSeverities.

◆ GetSmallestClearanceValue()

int BOARD_DESIGN_SETTINGS::GetSmallestClearanceValue ( ) const

Returns: the smallest clearance value found in NetClasses list.

Definition at line 1836 of file board_design_settings.cpp.

References clearance, m_NetSettings, and name.

Referenced by DIALOG_PLOT::TransferDataToWindow().

◆ GetStackupDescriptor() [1/2]

BOARD_STACKUP & BOARD_DESIGN_SETTINGS::GetStackupDescriptor ( )

inline

Definition at line 302 of file board_design_settings.h.

References m_stackup.

◆ GetStackupDescriptor() [2/2]

const BOARD_STACKUP & BOARD_DESIGN_SETTINGS::GetStackupDescriptor ( ) const

inline

Definition at line 303 of file board_design_settings.h.

References m_stackup.

◆ GetTeadropParamsList()

TEARDROP_PARAMETERS_LIST * BOARD_DESIGN_SETTINGS::GetTeadropParamsList ( )

inline

Definition at line 308 of file board_design_settings.h.

References m_TeardropParamsList.

Referenced by DIALOG_GLOBAL_EDIT_TEARDROPS::processItem().

◆ GetTextItalic()

bool BOARD_DESIGN_SETTINGS::GetTextItalic ( PCB_LAYER_ID aLayer ) const

Definition at line 2107 of file board_design_settings.cpp.

References GetLayerClass(), and m_TextItalic.

Referenced by PCB_BASE_FRAME::CreateNewFootprint(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::Reset(), PCB_TEXT::StyleFromSettings(), and PCB_TEXTBOX::StyleFromSettings().

◆ GetTextSize()

VECTOR2I BOARD_DESIGN_SETTINGS::GetTextSize ( PCB_LAYER_ID aLayer ) const

Return the default text size from the layer class for the given layer.

Definition at line 2095 of file board_design_settings.cpp.

References GetLayerClass(), and m_TextSize.

Referenced by PCB_BASE_FRAME::CreateNewFootprint(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), PCB_IO_EAGLE::loadPlain(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::Reset(), PCB_BARCODE::StyleFromSettings(), PCB_TEXT::StyleFromSettings(), and PCB_TEXTBOX::StyleFromSettings().

◆ GetTextThickness()

int BOARD_DESIGN_SETTINGS::GetTextThickness ( PCB_LAYER_ID aLayer ) const

Return the default text thickness from the layer class for the given layer.

Definition at line 2101 of file board_design_settings.cpp.

References GetLayerClass(), and m_TextThickness.

Referenced by PCB_BASE_FRAME::CreateNewFootprint(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::Reset(), PCB_TEXT::StyleFromSettings(), and PCB_TEXTBOX::StyleFromSettings().

◆ GetTextUpright()

bool BOARD_DESIGN_SETTINGS::GetTextUpright ( PCB_LAYER_ID aLayer ) const

Definition at line 2113 of file board_design_settings.cpp.

References GetLayerClass(), and m_TextUpright.

Referenced by PCB_BASE_FRAME::CreateNewFootprint(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::Reset(), PCB_TEXT::StyleFromSettings(), and PCB_TEXTBOX::StyleFromSettings().

◆ GetTrackWidthIndex()

int BOARD_DESIGN_SETTINGS::GetTrackWidthIndex ( ) const

inline

Returns: the current track width list index.

Definition at line 376 of file board_design_settings.h.

References m_trackWidthIndex.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_EDIT_FRAME::OnUpdateSelectTrackWidth(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), and TRACK_WIDTH_MENU::update().

◆ GetUserDefinedLayerCount()

int BOARD_DESIGN_SETTINGS::GetUserDefinedLayerCount ( ) const

inline

Returns: the number of enabled user defined layers.

Definition at line 636 of file board_design_settings.h.

References m_userDefinedLayerCount.

Referenced by BOARD::GetUserDefinedLayerCount(), and PANEL_FP_USER_LAYER_NAMES::loadFPSettings().

◆ GetViaSizeIndex()

int BOARD_DESIGN_SETTINGS::GetViaSizeIndex ( ) const

inline

Returns: the current via size list index.

Definition at line 415 of file board_design_settings.h.

References m_viaSizeIndex.

Referenced by BOOST_AUTO_TEST_CASE(), PCB_EDIT_FRAME::OnUpdateSelectViaSize(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), TRACK_WIDTH_MENU::update(), VIA_SIZE_MENU::update(), BOARD_EDITOR_CONTROL::ViaSizeDec(), and BOARD_EDITOR_CONTROL::ViaSizeInc().

◆ GetViaStackIndex()

int BOARD_DESIGN_SETTINGS::GetViaStackIndex ( ) const

inline

Returns: the currently selected via stack preset index (into m_ViaStackPresets).

Definition at line 420 of file board_design_settings.h.

References m_viaStackIndex.

Referenced by PANEL_SETUP_VIA_STACKS::loadFrom(), ROUTER_TOOL::onViaStackCommand(), and PCB_EDIT_FRAME::UpdateViaStackSelectBox().

◆ Ignore()

bool BOARD_DESIGN_SETTINGS::Ignore ( int aDRCErrorCode )

Return true if the DRC error code's severity is SEVERITY_IGNORE.

Definition at line 1632 of file board_design_settings.cpp.

References m_DRCSeverities, and RPT_SEVERITY_IGNORE.

Referenced by DRC_REPORT::WriteJsonReport(), and DRC_REPORT::WriteTextReport().

◆ initFromOther()

void BOARD_DESIGN_SETTINGS::initFromOther ( const BOARD_DESIGN_SETTINGS & aOther )

private

Definition at line 1237 of file board_design_settings.cpp.

References BOARD_DESIGN_SETTINGS(), m_AllowSoldermaskBridgesInFPs, m_auxOrigin, m_boardThickness, FIELDS_TABLE_BOM_SETTINGS::m_BomExportFileName, FIELDS_TABLE_BOM_SETTINGS::m_BomFmtPresets, FIELDS_TABLE_BOM_SETTINGS::m_BomFmtSettings, FIELDS_TABLE_BOM_SETTINGS::m_BomPresets, FIELDS_TABLE_BOM_SETTINGS::m_BomSettings, m_CapVias, m_CopperEdgeClearance, m_copperLayerCount, m_CoverViasBack, m_CoverViasFront, m_currentNetClassName, m_CurrentViaType, m_customDiffPair, m_customTrackWidth, m_customViaSize, m_DefaultFPTextItems, m_defaultZoneSettings, m_DiffPairDimensionsList, m_diffPairIndex, m_DimensionArrowLength, m_DimensionExtensionOffset, m_DimensionKeepTextAligned, m_DimensionPrecision, m_DimensionSuppressZeroes, m_DimensionTextPosition, m_DimensionUnitsFormat, m_DimensionUnitsMode, m_DrcExclusions, m_DRCSeverities, m_enabledLayers, m_FillVias, m_gridOrigin, m_HasStackup, m_HoleClearance, m_HoleToHoleMin, m_LineThickness, m_MaxError, m_MicroViasMinDrill, m_MicroViasMinSize, m_MinClearance, m_MinConn, m_MinGrooveWidth, m_MinResolvedSpokes, m_MinSilkTextHeight, m_MinSilkTextThickness, m_MinThroughDrill, m_NetSettings, m_Pad_Master, m_PlugViasBack, m_PlugViasFront, m_SilkClearance, m_SolderMaskExpansion, m_SolderMaskMinWidth, m_SolderMaskToCopperClearance, m_SolderPasteMargin, m_SolderPasteMarginRatio, m_stackup, m_StyleFPBarcodes, m_StyleFPDimensions, m_StyleFPFields, m_StyleFPShapes, m_StyleFPText, m_TempOverrideTrackWidth, m_TentViasBack, m_TentViasFront, m_TextItalic, m_TextSize, m_TextThickness, m_TextUpright, m_TrackMinWidth, m_trackWidthIndex, m_TrackWidthList, m_UseConnectedTrackWidth, m_useCustomDiffPair, m_useCustomTrackVia, m_UseHeightForLengthCalcs, m_userDefinedLayerCount, m_UserLayerNames, m_ViasDimensionsList, m_viaSizeIndex, m_ViasMinAnnularWidth, m_ViasMinSize, m_viaStackIndex, m_ViaStackPresets, and m_ZoneKeepExternalFillets.

Referenced by BOARD_DESIGN_SETTINGS(), and operator=().

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )

inherited

Definition at line 138 of file json_settings.cpp.

References m_internals.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), NET_SETTINGS::CopyFrom(), COLOR_SETTINGS::migrateSchema0to1(), PCBNEW_JOBS_HANDLER::runPcbMerge(), EESCHEMA_JOBS_HANDLER::runSchMerge(), and SETTINGS_MANAGER::SaveColorSettings().

◆ IsFileSynced()

bool JSON_SETTINGS::IsFileSynced ( ) const

inlineinherited

Returns: true once the in-memory store has been synchronized with an on-disk file, either by loading an existing file or by a successful save

Definition at line 157 of file json_settings.h.

References m_fileSynced.

Referenced by reloadFromFile().

◆ IsLayerEnabled()

bool BOARD_DESIGN_SETTINGS::IsLayerEnabled ( PCB_LAYER_ID aLayerId ) const

inline

Test whether a given layer aLayerId is enabled.

Parameters

aLayerId The layer to be tested.

Returns: true if the layer is enabled.

Definition at line 613 of file board_design_settings.h.

References m_enabledLayers, and PCB_LAYER_ID_COUNT.

Referenced by BOARD::IsLayerEnabled(), and BOARD::IsLayerVisible().

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const

inlineinherited

Definition at line 105 of file json_settings.h.

References m_writeFile.

Referenced by PANEL_COLOR_SETTINGS::GetSettingsDropdownName(), PANEL_COLOR_SETTINGS::OnThemeChanged(), APPEARANCE_CONTROLS::rebuildLayers(), SETTINGS_MANAGER::SaveColorSettings(), and APPEARANCE_CONTROLS::syncColorsAndVisibility().

◆ Load()

void JSON_SETTINGS::Load ( )

virtualinherited

Updates the parameters of this object based on the current JSON document contents.

Definition at line 144 of file json_settings.cpp.

References m_params, m_resetParamsIfMissing, and traceSettings.

◆ LoadFromFile()

bool BOARD_DESIGN_SETTINGS::LoadFromFile ( const wxString & aDirectory = "" )

overridevirtual

Loads the backing file from disk and then calls Load()

Parameters

aDirectory is the path to the file

Returns: true if the file was found on disk and loaded or migrated

Reimplemented from JSON_SETTINGS.

Definition at line 1553 of file board_design_settings.cpp.

References JSON_SETTINGS::Contains(), DRC_ITEM::Create(), DRCE_MISSING_COURTYARD, DRCE_OVERLAPPING_FOOTPRINTS, NESTED_SETTINGS::GetParent(), JSON_SETTINGS::Load(), NESTED_SETTINGS::LoadFromFile(), m_ZoneKeepExternalFillets, project, and JSON_SETTINGS::Set().

Referenced by BOOST_AUTO_TEST_CASE().

◆ LoadFromRawFile()

bool JSON_SETTINGS::LoadFromRawFile ( const wxString & aPath )

inherited

Definition at line 595 of file json_settings.cpp.

References ALLOW_EXCEPTIONS, IGNORE_COMMENTS, Load(), m_internals, and traceSettings.

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )

inherited

Migrates the schema of this settings from the version in the file to the latest version.

Schema migration doesn't need to be used every time a setting is added! This is intended to be more of an "escape hatch" in the event that we decide to move settings around or make other changes to a settings file format that can't simply be handled by loading a new default

Returns: true if migration was successful

Definition at line 749 of file json_settings.cpp.

References m_internals, m_migrators, m_schemaVersion, and traceSettings.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), LoadFromFile(), and NESTED_SETTINGS::LoadFromFile().

◆ MigrateFromLegacy()

bool JSON_SETTINGS::MigrateFromLegacy ( wxConfigBase * aLegacyConfig )

virtualinherited

Migrates from wxConfig to JSON-based configuration.

Should be implemented by any subclasses of JSON_SETTINGS that map to a legacy (wxConfig-based) config file.

Parameters

aLegacyConfig is a wxConfigBase holding a loaded configuration to migrate

Returns: true if migration was successful

Reimplemented in APP_SETTINGS_BASE, BITMAP2CMP_SETTINGS, COLOR_SETTINGS, COMMON_SETTINGS, CVPCB_SETTINGS, EDA_3D_VIEWER_SETTINGS, EESCHEMA_SETTINGS, FOOTPRINT_EDITOR_SETTINGS, GERBVIEW_SETTINGS, KICAD_SETTINGS, PCB_CALCULATOR_SETTINGS, PCBNEW_SETTINGS, PL_EDITOR_SETTINGS, PROJECT_FILE, PROJECT_LOCAL_SETTINGS, and SYMBOL_EDITOR_SETTINGS.

Definition at line 785 of file json_settings.cpp.

References traceSettings.

Referenced by LoadFromFile().

◆ migrateSchema0to1()

bool BOARD_DESIGN_SETTINGS::migrateSchema0to1 ( )

private

Schema 0 to 1: default dimension precision changed in meaning. Previously it was an enum with the following meaning:

0: 0.01mm / 1 mil / 0.001 in 1: 0.001mm / 0.1 mil / 0.0001 in 2: 0.0001mm / 0.01 mil / 0.00001 in

Now it is independent of display units and is an integer meaning the number of digits displayed after the decimal point, so we have to migrate based on the default units.

The units is an integer with the following mapping:

0: Inches 1: Mils 2: Millimeters

Definition at line 1460 of file board_design_settings.cpp.

References JSON_SETTINGS::At(), JSON_SETTINGS::Contains(), JSON_SETTINGS::Get(), and JSON_SETTINGS::Set().

Referenced by BOARD_DESIGN_SETTINGS().

◆ migrateSchema2to3()

bool BOARD_DESIGN_SETTINGS::migrateSchema2to3 ( )

private

Definition at line 1512 of file board_design_settings.cpp.

References DRC_EXCLUSION::FromLegacyStrings(), DRC_EXCLUSION::GetSortKey(), JSON_SETTINGS::Get< nlohmann::json >(), and JSON_SETTINGS::Set().

Referenced by BOARD_DESIGN_SETTINGS().

◆ operator!=()

bool BOARD_DESIGN_SETTINGS::operator!= ( const BOARD_DESIGN_SETTINGS & aOther ) const

inline

Definition at line 291 of file board_design_settings.h.

References BOARD_DESIGN_SETTINGS(), and operator==().

◆ operator=()

BOARD_DESIGN_SETTINGS & BOARD_DESIGN_SETTINGS::operator= ( const BOARD_DESIGN_SETTINGS & aOther )

Definition at line 1230 of file board_design_settings.cpp.

References BOARD_DESIGN_SETTINGS(), and initFromOther().

◆ operator==()

bool BOARD_DESIGN_SETTINGS::operator== ( const BOARD_DESIGN_SETTINGS & aOther ) const

Definition at line 1345 of file board_design_settings.cpp.

References BOARD_DESIGN_SETTINGS(), m_AllowSoldermaskBridgesInFPs, m_auxOrigin, m_boardThickness, FIELDS_TABLE_BOM_SETTINGS::m_BomExportFileName, FIELDS_TABLE_BOM_SETTINGS::m_BomFmtPresets, FIELDS_TABLE_BOM_SETTINGS::m_BomFmtSettings, FIELDS_TABLE_BOM_SETTINGS::m_BomPresets, FIELDS_TABLE_BOM_SETTINGS::m_BomSettings, m_CapVias, m_CopperEdgeClearance, m_copperLayerCount, m_CoverViasBack, m_CoverViasFront, m_currentNetClassName, m_CurrentViaType, m_customDiffPair, m_customTrackWidth, m_customViaSize, m_DefaultFPTextItems, m_defaultZoneSettings, m_DiffPairDimensionsList, m_diffPairIndex, m_DimensionArrowLength, m_DimensionExtensionOffset, m_DimensionKeepTextAligned, m_DimensionPrecision, m_DimensionSuppressZeroes, m_DimensionTextPosition, m_DimensionUnitsFormat, m_DimensionUnitsMode, m_DrcExclusions, m_DRCSeverities, m_enabledLayers, m_FillVias, m_gridOrigin, m_HasStackup, m_HoleClearance, m_HoleToHoleMin, m_LineThickness, m_MaxError, m_MicroViasMinDrill, m_MicroViasMinSize, m_MinClearance, m_MinConn, m_MinGrooveWidth, m_MinResolvedSpokes, m_MinSilkTextHeight, m_MinSilkTextThickness, m_MinThroughDrill, m_NetSettings, m_Pad_Master, m_PlugViasBack, m_PlugViasFront, m_SilkClearance, m_SolderMaskExpansion, m_SolderMaskMinWidth, m_SolderMaskToCopperClearance, m_SolderPasteMargin, m_SolderPasteMarginRatio, m_stackup, m_StyleFPBarcodes, m_StyleFPDimensions, m_StyleFPFields, m_StyleFPShapes, m_StyleFPText, m_TempOverrideTrackWidth, m_TentViasBack, m_TentViasFront, m_TextItalic, m_TextSize, m_TextThickness, m_TextUpright, m_TrackMinWidth, m_trackWidthIndex, m_TrackWidthList, m_UseConnectedTrackWidth, m_useCustomDiffPair, m_useCustomTrackVia, m_UseHeightForLengthCalcs, m_userDefinedLayerCount, m_UserLayerNames, m_ViasDimensionsList, m_viaSizeIndex, m_ViasMinAnnularWidth, m_ViasMinSize, m_viaStackIndex, m_ViaStackPresets, and m_ZoneKeepExternalFillets.

Referenced by operator!=().

◆ registerMigration()

void JSON_SETTINGS::registerMigration	(	int	aOldSchemaVersion,
		int	aNewSchemaVersion,
		std::function< bool(void)>	aMigrator )

protectedinherited

Registers a migration from one schema version to another.

If the schema version in the file loaded from disk is less than the schema version of the JSON_SETTINGS class, migration functions will be called one after the other until the data is up-to-date.

Parameters

aOldSchemaVersion	is the starting schema version for this migration
aNewSchemaVersion	is the ending schema version for this migration
aMigrator	is a function that performs the migration and returns true if successful

Definition at line 740 of file json_settings.cpp.

References m_migrators, and m_schemaVersion.

Referenced by BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), ERC_SETTINGS::ERC_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), MIGRATING_NESTED_SETTINGS::MIGRATING_NESTED_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::PROJECT_FILE(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), and TUNING_PROFILES::TUNING_PROFILES().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS * aSettings )

inherited

Saves and frees a nested settings object, if it exists within this one.

Parameters

aSettings is a pointer to a NESTED_SETTINGS that has already been added to this one

Definition at line 941 of file json_settings.cpp.

References JSON_SETTINGS(), m_manager, m_modified, m_nested_settings, NESTED_SETTINGS, NESTED_SETTINGS::SetParent(), and traceSettings.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ~JSON_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().

◆ ResetsParamsIfMissing()

bool JSON_SETTINGS::ResetsParamsIfMissing ( ) const

inlineinherited

Returns: true if a param absent from the file is reset to its default on load, meaning an absent key whose value equals the default is a faithful round-trip of the file. When false (e.g. board design settings), an absent key preserves the loaded value, so absent-and-default must still be treated as a change.

Definition at line 114 of file json_settings.h.

References m_resetParamsIfMissing.

Referenced by COLOR_MAP_PARAM::MatchesFile(), PARAM< ValueType >::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< Type >::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), PARAM_SET< Type >::MatchesFile(), and PARAM_WXSTRING_MAP::MatchesFile().

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )

inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 399 of file json_settings.cpp.

References m_params.

Referenced by BOOST_AUTO_TEST_CASE(), PANEL_COMMON_SETTINGS::ResetPanel(), PANEL_MAINTENANCE::ResetPanel(), PANEL_MOUSE_SETTINGS::ResetPanel(), and PANEL_SPACEMOUSE::ResetPanel().

◆ SaveToFile()

bool NESTED_SETTINGS::SaveToFile	(	const wxString &	aDirectory = "",
		bool	aForce = false )

overridevirtualinherited

Calls Store() and then saves the JSON document contents into the parent JSON_SETTINGS.

Parameters

aDirectory	is ignored.
aForce	is a flag to force the save.

Returns: true if the document contents were updated.

Reimplemented from JSON_SETTINGS.

Definition at line 129 of file nested_settings.cpp.

References dummy, JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_filename, JSON_SETTINGS::m_internals, JSON_SETTINGS::m_params, m_parent, m_path, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS_INTERNALS::PointerFromString(), JSON_SETTINGS::Store(), and traceSettings.

Referenced by BOOST_AUTO_TEST_CASE(), PCBNEW_JOBS_HANDLER::runPcbMerge(), SCH_EDIT_FRAME::saveProjectSettings(), and SIMULATOR_FRAME::SaveSettings().

◆ Set() [1/3]

template<typename ValueType>

template KICOMMON_API void JSON_SETTINGS::Set< wxAuiPaneInfo >	(	const std::string &	aPath,
		ValueType	aVal )

inherited

Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle.

Template Parameters

ValueType is the type to store

Parameters

aPath	is a path to store in the form "key1.key2.key3"
aVal	is the value to store

Definition at line 701 of file json_settings.cpp.

References m_internals.

◆ Set() [2/3]

template<>

void JSON_SETTINGS::Set	(	const std::string &	aPath,
		wxString	aVal )

inherited

Definition at line 980 of file json_settings.cpp.

◆ Set() [3/3]

template<>

KICOMMON_API void JSON_SETTINGS::Set	(	const std::string &	aPath,
		wxString	aVal )

inherited

References KICOMMON_API.

◆ SetAuxOrigin()

void BOARD_DESIGN_SETTINGS::SetAuxOrigin ( const VECTOR2I & aOrigin )

inline

Definition at line 687 of file board_design_settings.h.

References m_auxOrigin.

Referenced by BOOST_AUTO_TEST_CASE(), PCB_IO_EAGLE::centerBoard(), BOARD_EDITOR_CONTROL::DoSetDrillOrigin(), API_HANDLER_PCB::handleSetBoardOrigin(), PCB_IO_EASYEDA::loadBoard(), PCB_IO_KICAD_LEGACY::loadSETUP(), ALTIUM_PCB::Parse(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_EASYEDAPRO_V3_PARSER::ParseBoard(), and PCB_IO_KICAD_SEXPR_PARSER::parseSetup().

◆ SetBoardThickness()

void BOARD_DESIGN_SETTINGS::SetBoardThickness ( int aThickness )

inline

Definition at line 650 of file board_design_settings.h.

References m_boardThickness.

Referenced by FOOTPRINT_CHOOSER_FRAME::build3DCanvas(), PADS_PCB_CONVERTER::BuildStackup(), DIALOG_MIGRATE_3D_MODELS::initPreviewBoard(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), and PANEL_PREVIEW_3D_MODEL::View3DSettings().

◆ SetCopperLayerCount()

void BOARD_DESIGN_SETTINGS::SetCopperLayerCount ( int aNewLayerCount )

Set the copper layer count to aNewLayerCount.

Parameters

aNewLayerCount The new number of enabled copper layers.

Definition at line 2013 of file board_design_settings.cpp.

References LSET::AllCuMask(), m_copperLayerCount, and m_enabledLayers.

Referenced by BOARD_DESIGN_SETTINGS(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOARD::SetCopperLayerCount(), and BACKDRILL_TEST_FIXTURE::SetupSixLayerBoard().

◆ SetCustomDiffPairGap()

void BOARD_DESIGN_SETTINGS::SetCustomDiffPairGap ( int aGap )

inline

Sets custom gap for differential pairs (i.e.

not available in netclasses or preset list).

Parameters

aGap	is the new gap.

Definition at line 539 of file board_design_settings.h.

References m_customDiffPair.

Referenced by ROUTER_TOOL::DpDimensionsDialog(), and BOARD::SynchronizeNetsAndNetClasses().

◆ SetCustomDiffPairViaGap()

void BOARD_DESIGN_SETTINGS::SetCustomDiffPairViaGap ( int aGap )

inline

Sets custom via gap for differential pairs (i.e.

not available in netclasses or preset list).

Parameters

aGap	is the new gap. Specify 0 to use the DiffPairGap for vias as well.

Definition at line 552 of file board_design_settings.h.

References m_customDiffPair.

Referenced by ROUTER_TOOL::DpDimensionsDialog(), and BOARD::SynchronizeNetsAndNetClasses().

◆ SetCustomDiffPairWidth()

void BOARD_DESIGN_SETTINGS::SetCustomDiffPairWidth ( int aWidth )

inline

Sets custom track width for differential pairs (i.e.

not available in netclasses or preset list).

Parameters

aWidth is the new track width.

Definition at line 527 of file board_design_settings.h.

References m_customDiffPair.

Referenced by ROUTER_TOOL::DpDimensionsDialog(), and BOARD::SynchronizeNetsAndNetClasses().

◆ SetCustomTrackWidth()

void BOARD_DESIGN_SETTINGS::SetCustomTrackWidth ( int aWidth )

inline

Sets custom width for track (i.e.

not available in netclasses or preset list).

To have it returned with GetCurrentTrackWidth() you need to enable custom track & via sizes with UseCustomTrackViaSize().

Parameters

aWidth is the new track width.

Definition at line 409 of file board_design_settings.h.

References m_customTrackWidth.

Referenced by BOOST_AUTO_TEST_CASE(), PCB_IO_PADS::loadBoardSetup(), and BOARD::SynchronizeNetsAndNetClasses().

◆ SetCustomViaDrill()

void BOARD_DESIGN_SETTINGS::SetCustomViaDrill ( int aDrill )

inline

Sets custom size for via drill (i.e.

not available in netclasses or preset list).

To have it returned with GetCurrentViaDrill() you need to enable custom track & via sizes with UseCustomTrackViaSize().

Parameters

aDrill is the new drill size.

Definition at line 480 of file board_design_settings.h.

References m_customViaSize.

Referenced by PCB_IO_PADS::loadBoardSetup(), and BOARD::SynchronizeNetsAndNetClasses().

◆ SetCustomViaSize()

void BOARD_DESIGN_SETTINGS::SetCustomViaSize ( int aSize )

inline

Set custom size for via diameter (i.e.

not available in netclasses or preset list).

To have it returned with GetCurrentViaSize() you need to enable custom track & via sizes with UseCustomTrackViaSize().

Parameters

aSize is the new drill diameter.

Definition at line 458 of file board_design_settings.h.

References m_customViaSize.

Referenced by PCB_IO_PADS::loadBoardSetup(), and BOARD::SynchronizeNetsAndNetClasses().

◆ SetDefaultMasterPad()

void BOARD_DESIGN_SETTINGS::SetDefaultMasterPad ( )

Definition at line 2118 of file board_design_settings.cpp.

References PADSTACK::ALL_LAYERS, ANGLE_45, ANGLE_90, CIRCLE, DEFAULT_PAD_DRILL_DIAMETER_MM, DEFAULT_PAD_HEIGTH_MM, DEFAULT_PAD_RR_RADIUS_RATIO, DEFAULT_PAD_WIDTH_MM, m_Pad_Master, PADSTACK::NORMAL, pcbIUScale, and ROUNDRECT.

Referenced by BOARD_DESIGN_SETTINGS().

◆ SetDefaultZoneSettings()

void BOARD_DESIGN_SETTINGS::SetDefaultZoneSettings ( const ZONE_SETTINGS & aSettings )

inline

Definition at line 332 of file board_design_settings.h.

References m_defaultZoneSettings.

Referenced by PCB_IO_KICAD_LEGACY::loadSETUP().

◆ SetDiffPairIndex()

void BOARD_DESIGN_SETTINGS::SetDiffPairIndex ( int aIndex )

Parameters

aIndex is the diff pair dimensions list index to set.

Definition at line 1938 of file board_design_settings.cpp.

References m_DiffPairDimensionsList, m_diffPairIndex, and m_useCustomDiffPair.

Referenced by BOOST_AUTO_TEST_CASE(), DIFF_PAIR_MENU::eventHandler(), BOARD_EDITOR_CONTROL::TrackWidthDec(), and BOARD_EDITOR_CONTROL::TrackWidthInc().

◆ SetEnabledLayers()

void BOARD_DESIGN_SETTINGS::SetEnabledLayers ( const LSET & aMask )

Change the bit-mask of enabled layers to aMask.

Parameters

aMask = The new bit-mask of enabled layers.

Definition at line 2036 of file board_design_settings.cpp.

References B_CrtYd, B_Cu, LSET::ClearNonCopperLayers(), Edge_Cuts, F_CrtYd, F_Cu, m_copperLayerCount, m_enabledLayers, m_userDefinedLayerCount, Margin, and LSET::UserDefinedLayersMask().

Referenced by FOOTPRINT_CHOOSER_FRAME::build3DCanvas(), DIALOG_MIGRATE_3D_MODELS::initPreviewBoard(), PCB_IO_GEDA::loadBoard(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), and BOARD::SetEnabledLayers().

◆ SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString & aFilename )

inlineinherited

Definition at line 92 of file json_settings.h.

References m_filename.

Referenced by SETTINGS_MANAGER::GetColorSettings(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), SETTINGS_MANAGER::SaveProjectAs(), and SETTINGS_MANAGER::SaveProjectCopy().

◆ SetGridOrigin()

void BOARD_DESIGN_SETTINGS::SetGridOrigin ( const VECTOR2I & aOrigin )

inline

Definition at line 690 of file board_design_settings.h.

References m_gridOrigin.

Referenced by PCB_IO_EAGLE::centerBoard(), PCB_CONTROL::DoSetGridOrigin(), API_HANDLER_PCB::handleSetBoardOrigin(), PCB_IO_KICAD_LEGACY::loadSETUP(), ALTIUM_PCB::Parse(), and PCB_IO_KICAD_SEXPR_PARSER::parseSetup().

◆ SetIfPresent() [1/4]

bool JSON_SETTINGS::SetIfPresent	(	const nlohmann::json &	aObj,
		const std::string &	aPath,
		bool &	aTarget )

staticinherited

Sets the given bool if the given key/path is present.

Parameters

aObj	is the source object.
aPath	is the path of aObj.
aTarget	is the storage destination.

Returns: True if set, false if not.

Definition at line 806 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [2/4]

bool JSON_SETTINGS::SetIfPresent	(	const nlohmann::json &	aObj,
		const std::string &	aPath,
		int &	aTarget )

staticinherited

Sets the given int if the given key/path is present.

Parameters

aObj	is the source object.
aPath	is the path of aObj.
aTarget	is the storage destination.

Returns: True if set, false if not.

Definition at line 820 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [3/4]

bool JSON_SETTINGS::SetIfPresent	(	const nlohmann::json &	aObj,
		const std::string &	aPath,
		unsigned int &	aTarget )

staticinherited

Sets the given unsigned int if the given key/path is present.

Parameters

aObj	is the source object.
aPath	is the path of aObj.
aTarget	is the storage destination.

Returns: True if set, false if not.

Definition at line 834 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [4/4]

bool JSON_SETTINGS::SetIfPresent	(	const nlohmann::json &	aObj,
		const std::string &	aPath,
		wxString &	aTarget )

staticinherited

Sets the given string if the given key/path is present.

Parameters

aObj	is the source object
aPath	is the path of aObj.
aTarget	is the storage destination

Returns: True if set, false if not

Definition at line 792 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const wxString & aFilename )

inlineinherited

Definition at line 103 of file json_settings.h.

References m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC aLocation )

inlineinherited

Definition at line 94 of file json_settings.h.

References m_location.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), and COLOR_SETTINGS::migrateSchema0to1().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER * aManager )

inlineinherited

Definition at line 228 of file json_settings.h.

References m_manager.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ SetParent()

void NESTED_SETTINGS::SetParent	(	JSON_SETTINGS *	aParent,
		bool	aLoadFromFile = true )

inherited

Definition at line 186 of file nested_settings.cpp.

References JSON_SETTINGS::JSON_SETTINGS(), LoadFromFile(), and m_parent.

Referenced by NESTED_SETTINGS(), and JSON_SETTINGS::ReleaseNestedSettings().

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool aReadOnly )

inlineinherited

Definition at line 106 of file json_settings.h.

References m_writeFile.

Referenced by SETTINGS_MANAGER::GetColorSettings(), SETTINGS_MANAGER::loadAllColorSettings(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), SETTINGS_MANAGER::SaveProjectAs(), and DIALOG_DATABASE_LIB_SETTINGS::TransferDataFromWindow().

◆ SetTrackWidthIndex()

void BOARD_DESIGN_SETTINGS::SetTrackWidthIndex ( int aIndex )

Set the current track width list index to aIndex.

Parameters

aIndex is the track width list index.

Definition at line 1912 of file board_design_settings.cpp.

References m_trackWidthIndex, m_TrackWidthList, and m_useCustomTrackVia.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), TRACK_WIDTH_MENU::eventHandler(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), and PCB_EDIT_FRAME::UpdateTrackWidthSelectBox().

◆ SetUserDefinedLayerCount()

void BOARD_DESIGN_SETTINGS::SetUserDefinedLayerCount ( int aNewLayerCount )

Set the number of user defined layers to aNewLayerCount.

Parameters

aNewLayerCount The new number of enabled user defined layers.

Definition at line 2025 of file board_design_settings.cpp.

References m_enabledLayers, m_userDefinedLayerCount, and LSET::UserDefinedLayersMask().

Referenced by BOARD_DESIGN_SETTINGS(), BOARD::SetUserDefinedLayerCount(), and PANEL_FP_USER_LAYER_NAMES::TransferDataFromWindow().

◆ SetViaSizeIndex()

void BOARD_DESIGN_SETTINGS::SetViaSizeIndex ( int aIndex )

Set the current via size list index to aIndex.

Parameters

aIndex is the via size list index.

Definition at line 1871 of file board_design_settings.cpp.

References m_useCustomTrackVia, m_ViasDimensionsList, and m_viaSizeIndex.

Referenced by BOOST_AUTO_TEST_CASE(), TRACK_WIDTH_MENU::eventHandler(), VIA_SIZE_MENU::eventHandler(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), BOARD_EDITOR_CONTROL::ViaSizeDec(), and BOARD_EDITOR_CONTROL::ViaSizeInc().

◆ SetViaStackIndex()

void BOARD_DESIGN_SETTINGS::SetViaStackIndex ( int aIndex )

inline

Set the current via stack preset index to aIndex.

Definition at line 425 of file board_design_settings.h.

References m_viaStackIndex.

Referenced by PCB_EDIT_FRAME::SelectViaStack_Event(), PANEL_SETUP_VIA_STACKS::TransferDataFromWindow(), and PCB_EDIT_FRAME::UpdateViaStackSelectBox().

◆ Store()

bool JSON_SETTINGS::Store ( )

virtualinherited

Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER.

Returns: true if any part of the JSON document has been updated since the last save to disk

Reimplemented in PROJECT_FILE.

Definition at line 380 of file json_settings.cpp.

References m_modified, m_params, and traceSettings.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), NET_SETTINGS::CopyFrom(), flushToStore(), FormatAsString(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), and PROJECT_FILE::Store().

◆ UseCustomDiffPairDimensions() [1/2]

bool BOARD_DESIGN_SETTINGS::UseCustomDiffPairDimensions ( ) const

inline

Returns: True if custom sizes of diff pairs are enabled, false otherwise.

Definition at line 572 of file board_design_settings.h.

References m_useCustomDiffPair.

◆ UseCustomDiffPairDimensions() [2/2]

void BOARD_DESIGN_SETTINGS::UseCustomDiffPairDimensions ( bool aEnabled )

inline

Enables/disables custom differential pair dimensions.

Parameters

aEnabled decides if custom settings should be used for new differential pairs.

Definition at line 567 of file board_design_settings.h.

References m_useCustomDiffPair.

Referenced by DIFF_PAIR_MENU::eventHandler(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), and DIFF_PAIR_MENU::update().

◆ UseCustomTrackViaSize() [1/2]

bool BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize ( ) const

inline

Returns: True if custom sizes of tracks & vias are enabled, false otherwise.

Definition at line 500 of file board_design_settings.h.

References m_useCustomTrackVia.

◆ UseCustomTrackViaSize() [2/2]

void BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize ( bool aEnabled )

inline

Enables/disables custom track/via size settings.

If enabled, values set with SetCustomTrackWidth(), SetCustomViaSize(), and SetCustomViaDrill() are used for newly created tracks and vias.

Parameters

aEnabled decides if custom settings should be used for new tracks/vias.

Definition at line 495 of file board_design_settings.h.

References m_useCustomTrackVia.

Referenced by BOARD_EDITOR_CONTROL::AutoTrackWidth(), BOARD::BOARD(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ROUTER_TOOL::CustomTrackWidthDialog(), TRACK_WIDTH_MENU::eventHandler(), VIA_SIZE_MENU::eventHandler(), PCB_EDIT_FRAME::OnUpdateSelectTrackWidth(), PCB_EDIT_FRAME::OnUpdateSelectViaSize(), BOARD::SynchronizeNetsAndNetClasses(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), TRACK_WIDTH_MENU::update(), VIA_SIZE_MENU::update(), BOARD_EDITOR_CONTROL::ViaSizeDec(), and BOARD_EDITOR_CONTROL::ViaSizeInc().

◆ UseNetClassDiffPair()

bool BOARD_DESIGN_SETTINGS::UseNetClassDiffPair ( ) const

inline

Return true if netclass values should be used to obtain appropriate diff pair dimensions.

Definition at line 358 of file board_design_settings.h.

References m_diffPairIndex, and m_useCustomDiffPair.

Referenced by PNS_KICAD_IFACE_BASE::ImportSizes(), and ROUTER_TOOL::updateSizesAfterRouterEvent().

◆ UseNetClassTrack()

bool BOARD_DESIGN_SETTINGS::UseNetClassTrack ( ) const

inline

Return true if netclass values should be used to obtain appropriate track width.

Definition at line 348 of file board_design_settings.h.

References m_trackWidthIndex, and m_useCustomTrackVia.

Referenced by PNS_KICAD_IFACE_BASE::ImportSizes(), and ROUTER_TOOL::updateSizesAfterRouterEvent().

◆ UseNetClassVia()

bool BOARD_DESIGN_SETTINGS::UseNetClassVia ( ) const

inline

Return true if netclass values should be used to obtain appropriate via size.

Definition at line 353 of file board_design_settings.h.

References m_useCustomTrackVia, and m_viaSizeIndex.

Referenced by ROUTER_TOOL::handleLayerSwitch(), and PNS_KICAD_IFACE_BASE::ImportSizes().

◆ ValidateDesignRules()

std::vector< BOARD_DESIGN_SETTINGS::VALIDATION_ERROR > BOARD_DESIGN_SETTINGS::ValidateDesignRules ( std::optional< EDA_UNITS > aUnits = std::nullopt ) const

Validate design settings values and return per-field errors.

Returns: empty vector if valid, otherwise one or more validation errors.

Definition at line 1639 of file board_design_settings.cpp.

References _, TEARDROP_PARAMETERS_LIST::GetParameters(), TEARDROP_PARAMETERS_LIST::GetParametersCount(), GetTeardropTargetCanonicalName(), TEARDROP_PARAMETERS::m_BestLengthRatio, TEARDROP_PARAMETERS::m_BestWidthRatio, m_CopperEdgeClearance, VIA_DIMENSION::m_Diameter, m_DiffPairDimensionsList, VIA_DIMENSION::m_Drill, DIFF_PAIR_DIMENSION::m_Gap, m_HoleClearance, m_HoleToHoleMin, m_MaxError, m_MicroViasMinDrill, m_MicroViasMinSize, m_MinClearance, m_MinConn, m_MinGrooveWidth, m_MinResolvedSpokes, m_MinSilkTextHeight, m_MinSilkTextThickness, m_MinThroughDrill, m_SilkClearance, m_SolderMaskExpansion, m_SolderMaskMinWidth, m_SolderMaskToCopperClearance, m_SolderPasteMargin, m_SolderPasteMarginRatio, TEARDROP_PARAMETERS::m_TdMaxLen, TEARDROP_PARAMETERS::m_TdMaxWidth, m_TeardropParamsList, m_TrackMinWidth, m_ViasDimensionsList, m_ViasMinAnnularWidth, m_ViasMinSize, DIFF_PAIR_DIMENSION::m_Width, TEARDROP_PARAMETERS::m_WidthtoSizeFilterRatio, MAXIMUM_ERROR_SIZE_MM, MINIMUM_ERROR_SIZE_MM, MM, pcbIUScale, EDA_UNIT_UTILS::UI::StringFromValue(), and PCB_VIA::ValidateViaParameters().

Referenced by API_HANDLER_PCB::handleSetBoardDesignRules(), and PANEL_SETUP_TRACKS_AND_VIAS::Validate().

Member Data Documentation

◆ m_AllowSoldermaskBridgesInFPs

bool BOARD_DESIGN_SETTINGS::m_AllowSoldermaskBridgesInFPs

Definition at line 764 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), operator==(), and PCB_IO_KICAD_SEXPR_PARSER::parseSetup().

◆ m_auxOrigin

VECTOR2I BOARD_DESIGN_SETTINGS::m_auxOrigin

private

origin for plot exports

Definition at line 828 of file board_design_settings.h.

Referenced by GetAuxOrigin(), initFromOther(), operator==(), and SetAuxOrigin().

◆ m_boardThickness

int BOARD_DESIGN_SETTINGS::m_boardThickness

private

Board thickness for 3D viewer.

Definition at line 851 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetBoardThickness(), initFromOther(), operator==(), and SetBoardThickness().

◆ m_BomExportFileName

wxString FIELDS_TABLE_BOM_SETTINGS::m_BomExportFileName

inherited

Definition at line 119 of file bom_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), BOARD_DESIGN_SETTINGS::initFromOther(), BOARD_DESIGN_SETTINGS::operator==(), and SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ m_BomFmtPresets

std::vector<BOM_FMT_PRESET> FIELDS_TABLE_BOM_SETTINGS::m_BomFmtPresets

inherited

Definition at line 127 of file bom_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), PANEL_BOM_PRESETS::ImportBomFmtPresetsFrom(), BOARD_DESIGN_SETTINGS::initFromOther(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), BOARD_DESIGN_SETTINGS::operator==(), and SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ m_BomFmtSettings

BOM_FMT_PRESET FIELDS_TABLE_BOM_SETTINGS::m_BomFmtSettings

inherited

List of stored BOM format presets.

Definition at line 126 of file bom_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), BOARD_DESIGN_SETTINGS::initFromOther(), BOARD_DESIGN_SETTINGS::operator==(), and SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ m_BomPresets

std::vector<BOM_PRESET> FIELDS_TABLE_BOM_SETTINGS::m_BomPresets

inherited

Definition at line 123 of file bom_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), PANEL_BOM_PRESETS::ImportBomPresetsFrom(), BOARD_DESIGN_SETTINGS::initFromOther(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), BOARD_DESIGN_SETTINGS::operator==(), and SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ m_BomSettings

BOM_PRESET FIELDS_TABLE_BOM_SETTINGS::m_BomSettings

inherited

List of stored BOM presets.

Definition at line 122 of file bom_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), BOARD_DESIGN_SETTINGS::initFromOther(), BOARD_DESIGN_SETTINGS::operator==(), and SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ m_CapVias

bool BOARD_DESIGN_SETTINGS::m_CapVias

Definition at line 775 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), operator==(), and PCB_IO_KICAD_SEXPR_PARSER::parseSetup().

◆ m_CopperEdgeClearance

int BOARD_DESIGN_SETTINGS::m_CopperEdgeClearance

Definition at line 734 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), GetBiggestClearanceValue(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), PCB_IO_PADS::loadBoardSetup(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), PCB_EDIT_FRAME::OpenProjectFiles(), operator==(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_EASYEDAPRO_V3_PARSER::ParseBoard(), PCB_IO_KICAD_SEXPR_PARSER::parseDefaults(), and ValidateDesignRules().

◆ m_copperLayerCount

int BOARD_DESIGN_SETTINGS::m_copperLayerCount

private

Number of copper layers for this design.

Definition at line 847 of file board_design_settings.h.

Referenced by GetCopperLayerCount(), initFromOther(), operator==(), SetCopperLayerCount(), and SetEnabledLayers().

◆ m_CoverViasBack

bool BOARD_DESIGN_SETTINGS::m_CoverViasBack

Definition at line 770 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), operator==(), and PCB_IO_KICAD_SEXPR_PARSER::parseSetup().

◆ m_CoverViasFront

bool BOARD_DESIGN_SETTINGS::m_CoverViasFront

Definition at line 769 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), operator==(), and PCB_IO_KICAD_SEXPR_PARSER::parseSetup().

◆ m_createIfDefault

bool JSON_SETTINGS::m_createIfDefault

protectedinherited

Whether or not the backing store file should be created if all parameters are still at their default values.

Ignored if m_createIfMissing is false or m_writeFile is false.

Definition at line 370 of file json_settings.h.

Referenced by JSON_SETTINGS(), and SaveToFile().

◆ m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing

protectedinherited

Whether or not the backing store file should be created it if doesn't exist.

Definition at line 364 of file json_settings.h.

Referenced by JSON_SETTINGS(), and SaveToFile().

◆ m_currentNetClassName

wxString BOARD_DESIGN_SETTINGS::m_currentNetClassName

private

Current net class name used to display netclass info.

This is also the last used netclass after starting a track.

Definition at line 855 of file board_design_settings.h.

Referenced by GetCurrentNetClassName(), initFromOther(), and operator==().

◆ m_CurrentViaType

VIATYPE BOARD_DESIGN_SETTINGS::m_CurrentViaType

(VIA_BLIND_BURIED, VIA_THROUGH, VIA_MICROVIA)

Definition at line 719 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DRAWING_TOOL::DrawVia(), initFromOther(), and operator==().

◆ m_customDiffPair

DIFF_PAIR_DIMENSION BOARD_DESIGN_SETTINGS::m_customDiffPair

private

Definition at line 845 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetCurrentDiffPairGap(), GetCurrentDiffPairViaGap(), GetCurrentDiffPairWidth(), GetCustomDiffPairGap(), GetCustomDiffPairViaGap(), GetCustomDiffPairWidth(), initFromOther(), operator==(), SetCustomDiffPairGap(), SetCustomDiffPairViaGap(), and SetCustomDiffPairWidth().

◆ m_customTrackWidth

int BOARD_DESIGN_SETTINGS::m_customTrackWidth

private

Definition at line 840 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetCurrentTrackWidth(), GetCustomTrackWidth(), initFromOther(), operator==(), and SetCustomTrackWidth().

◆ m_customViaSize

VIA_DIMENSION BOARD_DESIGN_SETTINGS::m_customViaSize

private

Definition at line 841 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetCurrentViaDrill(), GetCurrentViaSize(), GetCustomViaDrill(), GetCustomViaSize(), initFromOther(), operator==(), SetCustomViaDrill(), and SetCustomViaSize().

◆ m_DefaultFPTextItems

std::vector<TEXT_ITEM_INFO> BOARD_DESIGN_SETTINGS::m_DefaultFPTextItems

Definition at line 784 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_BASE_FRAME::CreateNewFootprint(), initFromOther(), PANEL_FP_EDITOR_FIELD_DEFAULTS::loadFPSettings(), operator==(), and PANEL_FP_EDITOR_FIELD_DEFAULTS::TransferDataFromWindow().

◆ m_defaultZoneSettings

ZONE_SETTINGS BOARD_DESIGN_SETTINGS::m_defaultZoneSettings

private

The default settings that will be used for new zones.

Definition at line 872 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetDefaultZoneSettings(), initFromOther(), operator==(), and SetDefaultZoneSettings().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration

protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 382 of file json_settings.h.

Referenced by JSON_SETTINGS(), LoadFromFile(), PROJECT_FILE::PROJECT_FILE(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ m_DiffPairDimensionsList

std::vector<DIFF_PAIR_DIMENSION> BOARD_DESIGN_SETTINGS::m_DiffPairDimensionsList

Definition at line 706 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), GetCurrentDiffPairGap(), GetCurrentDiffPairViaGap(), GetCurrentDiffPairWidth(), GetNextDiffPairIndex(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), SetDiffPairIndex(), DIFF_PAIR_MENU::update(), PANEL_SETUP_TRACKS_AND_VIAS::Validate(), and ValidateDesignRules().

◆ m_diffPairIndex

int BOARD_DESIGN_SETTINGS::m_diffPairIndex

private

Definition at line 835 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetCurrentDiffPairGap(), GetCurrentDiffPairViaGap(), GetCurrentDiffPairWidth(), GetDiffPairIndex(), initFromOther(), operator==(), SetDiffPairIndex(), and UseNetClassDiffPair().

◆ m_DiffPairMeanderSettings

PNS::MEANDER_SETTINGS BOARD_DESIGN_SETTINGS::m_DiffPairMeanderSettings

Definition at line 716 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_TUNING_PATTERN::CreateNew(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), PANEL_SETUP_TUNING_PATTERNS::ImportSettingsFrom(), and DRAWING_TOOL::PlaceTuningPattern().

◆ m_DimensionArrowLength

int BOARD_DESIGN_SETTINGS::m_DimensionArrowLength

Definition at line 806 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DRAWING_TOOL::DrawDimension(), initFromOther(), PANEL_SETUP_DIMENSIONS::LoadFromSettings(), and operator==().

◆ m_DimensionExtensionOffset

int BOARD_DESIGN_SETTINGS::m_DimensionExtensionOffset

Definition at line 807 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DRAWING_TOOL::DrawDimension(), initFromOther(), PANEL_SETUP_DIMENSIONS::LoadFromSettings(), and operator==().

◆ m_DimensionKeepTextAligned

bool BOARD_DESIGN_SETTINGS::m_DimensionKeepTextAligned

Definition at line 805 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DRAWING_TOOL::DrawDimension(), initFromOther(), PANEL_SETUP_DIMENSIONS::LoadFromSettings(), operator==(), and PCB_DIMENSION_BASE::StyleFromSettings().

◆ m_DimensionPrecision

DIM_PRECISION BOARD_DESIGN_SETTINGS::m_DimensionPrecision

Number of digits after the decimal.

Definition at line 801 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DRAWING_TOOL::DrawDimension(), initFromOther(), PANEL_SETUP_DIMENSIONS::LoadFromSettings(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseDefaults(), and PCB_DIMENSION_BASE::StyleFromSettings().

◆ m_DimensionSuppressZeroes

bool BOARD_DESIGN_SETTINGS::m_DimensionSuppressZeroes

Definition at line 803 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DRAWING_TOOL::DrawDimension(), initFromOther(), PANEL_SETUP_DIMENSIONS::LoadFromSettings(), operator==(), and PCB_DIMENSION_BASE::StyleFromSettings().

◆ m_DimensionTextPosition

DIM_TEXT_POSITION BOARD_DESIGN_SETTINGS::m_DimensionTextPosition

Definition at line 804 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DRAWING_TOOL::DrawDimension(), initFromOther(), PANEL_SETUP_DIMENSIONS::LoadFromSettings(), operator==(), and PCB_DIMENSION_BASE::StyleFromSettings().

◆ m_DimensionUnitsFormat

DIM_UNITS_FORMAT BOARD_DESIGN_SETTINGS::m_DimensionUnitsFormat

Definition at line 802 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DRAWING_TOOL::DrawDimension(), initFromOther(), PANEL_SETUP_DIMENSIONS::LoadFromSettings(), operator==(), and PCB_DIMENSION_BASE::StyleFromSettings().

◆ m_DimensionUnitsMode

DIM_UNITS_MODE BOARD_DESIGN_SETTINGS::m_DimensionUnitsMode

Definition at line 800 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DRAWING_TOOL::DrawDimension(), initFromOther(), PANEL_SETUP_DIMENSIONS::LoadFromSettings(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseDefaults(), and PCB_DIMENSION_BASE::StyleFromSettings().

◆ m_DRCEngine

std::shared_ptr<DRC_ENGINE> BOARD_DESIGN_SETTINGS::m_DRCEngine

Definition at line 742 of file board_design_settings.h.

◆ m_DrcExclusions

std::set<DRC_EXCLUSION, DRC_EXCLUSION_COMPARE> BOARD_DESIGN_SETTINGS::m_DrcExclusions

◆ m_DRCSeverities

std::map<int, SEVERITY> BOARD_DESIGN_SETTINGS::m_DRCSeverities

Definition at line 743 of file board_design_settings.h.

◆ m_drillSymbolProfile

DRILL_SYMBOL_PROFILE BOARD_DESIGN_SETTINGS::m_drillSymbolProfile

private

Grouping rules and symbol assignments shared by every drill chart and map on the board.

Definition at line 868 of file board_design_settings.h.

Referenced by GetDrillSymbolProfile(), and GetDrillSymbolProfile().

◆ m_enabledLayers

LSET BOARD_DESIGN_SETTINGS::m_enabledLayers

private

Bit-mask for layer enabling.

Definition at line 849 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetEnabledLayers(), initFromOther(), IsLayerEnabled(), operator==(), SetCopperLayerCount(), SetEnabledLayers(), and SetUserDefinedLayerCount().

◆ m_filename

wxString JSON_SETTINGS::m_filename

protectedinherited

The filename (not including path) of this settings file (inicode)

Definition at line 349 of file json_settings.h.

Referenced by APP_SETTINGS_BASE::addParamsForWindow(), COLOR_SETTINGS::COLOR_SETTINGS(), APP_SETTINGS_BASE::DefaultGridSizeList(), APP_SETTINGS_BASE::DefaultZoomList(), GetFilename(), GetFullFilename(), JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::operator=(), SaveToFile(), NESTED_SETTINGS::SaveToFile(), and SetFilename().

◆ m_fileSynced

bool JSON_SETTINGS::m_fileSynced

protectedinherited

True once the store has been synchronized with an on-disk file (loaded or saved)

Definition at line 379 of file json_settings.h.

Referenced by IsFileSynced(), JSON_SETTINGS(), LoadFromFile(), and SaveToFile().

◆ m_FillVias

bool BOARD_DESIGN_SETTINGS::m_FillVias

Definition at line 778 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_VIA_STACK::CreateFromItems(), PCB_IO_KICAD_SEXPR::formatSetup(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), operator==(), and PCB_IO_KICAD_SEXPR_PARSER::parseSetup().

◆ m_gridOrigin

VECTOR2I BOARD_DESIGN_SETTINGS::m_gridOrigin

private

origin for grid offsets

Definition at line 829 of file board_design_settings.h.

Referenced by GetGridOrigin(), initFromOther(), operator==(), and SetGridOrigin().

◆ m_HasStackup

bool BOARD_DESIGN_SETTINGS::m_HasStackup

Definition at line 822 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PADS_PCB_CONVERTER::BuildStackup(), PCB_IO_KICAD_SEXPR::formatSetup(), initFromOther(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), operator==(), and ALTIUM_PCB::ParseBoard6Data().

◆ m_HoleClearance

int BOARD_DESIGN_SETTINGS::m_HoleClearance

Definition at line 735 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetBiggestClearanceValue(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), PNS_KICAD_IFACE_BASE::ImportSizes(), initFromOther(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), DSN::SPECCTRA_DB::makeIMAGE(), operator==(), and ValidateDesignRules().

◆ m_HoleToHoleMin

int BOARD_DESIGN_SETTINGS::m_HoleToHoleMin

Definition at line 736 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), GetBiggestClearanceValue(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), PNS_KICAD_IFACE_BASE::ImportSizes(), initFromOther(), PCB_IO_PADS::loadBoardSetup(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), and ValidateDesignRules().

◆ m_internals

std::unique_ptr<JSON_SETTINGS_INTERNALS> JSON_SETTINGS::m_internals

protectedinherited

Definition at line 399 of file json_settings.h.

◆ m_isFutureFormat

bool JSON_SETTINGS::m_isFutureFormat

protectedinherited

Set to true if this settings is loaded from a file with a newer schema version than is known.

Definition at line 391 of file json_settings.h.

Referenced by JSON_SETTINGS(), LoadFromFile(), PROJECT_FILE::ShouldAutoSave(), and PROJECT_LOCAL_SETTINGS::ShouldAutoSave().

◆ m_legacy_filename

wxString JSON_SETTINGS::m_legacy_filename

protectedinherited

The filename of the wxConfig legacy file (if different from m_filename)

Definition at line 352 of file json_settings.h.

Referenced by JSON_SETTINGS(), LoadFromFile(), and SetLegacyFilename().

◆ m_LineThickness

int BOARD_DESIGN_SETTINGS::m_LineThickness[LAYER_CLASS_COUNT]

Definition at line 793 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), CONVERT_TOOL::CreatePolys(), GetLineThickness(), API_HANDLER_BOARD::handleGetGraphicsDefaults(), initFromOther(), PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::loadFPSettings(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseDefaults(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), PlotStandardLayer(), and PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::TransferDataFromWindow().

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location

protectedinherited

The location of this settings file (.

See also: SETTINGS_LOC)

Definition at line 355 of file json_settings.h.

Referenced by GetLocation(), JSON_SETTINGS(), and SetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager

protectedinherited

A pointer to the settings manager managing this file (may be null)

Definition at line 394 of file json_settings.h.

Referenced by JSON_SETTINGS(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), ReleaseNestedSettings(), and SetManager().

◆ m_MaxError

int BOARD_DESIGN_SETTINGS::m_MaxError

◆ m_MicroViasMinDrill

int BOARD_DESIGN_SETTINGS::m_MicroViasMinDrill

Definition at line 733 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), DRC_ENGINE::loadImplicitRules(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), and ValidateDesignRules().

◆ m_MicroViasMinSize

int BOARD_DESIGN_SETTINGS::m_MicroViasMinSize

Definition at line 732 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), DRC_ENGINE::loadImplicitRules(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), and ValidateDesignRules().

◆ m_migrators

std::map<int, std::pair<int, std::function<bool()> > > JSON_SETTINGS::m_migrators

protectedinherited

A map of starting schema version to a pair of <ending version, migrator function>

Definition at line 397 of file json_settings.h.

Referenced by Migrate(), and registerMigration().

◆ m_MinClearance

◆ m_MinConn

int BOARD_DESIGN_SETTINGS::m_MinConn

Definition at line 727 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), BOOST_FIXTURE_TEST_CASE(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), DRC_ENGINE::loadImplicitRules(), operator==(), and ValidateDesignRules().

◆ m_MinGrooveWidth

int BOARD_DESIGN_SETTINGS::m_MinGrooveWidth

Definition at line 726 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), operator==(), and ValidateDesignRules().

◆ m_MinResolvedSpokes

int BOARD_DESIGN_SETTINGS::m_MinResolvedSpokes

Definition at line 738 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), DRC_ENGINE::loadImplicitRules(), operator==(), and ValidateDesignRules().

◆ m_MinSilkTextHeight

int BOARD_DESIGN_SETTINGS::m_MinSilkTextHeight

Definition at line 739 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), DRC_ENGINE::loadImplicitRules(), operator==(), and ValidateDesignRules().

◆ m_MinSilkTextThickness

int BOARD_DESIGN_SETTINGS::m_MinSilkTextThickness

Definition at line 740 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), DRC_ENGINE::loadImplicitRules(), operator==(), and ValidateDesignRules().

◆ m_MinThroughDrill

int BOARD_DESIGN_SETTINGS::m_MinThroughDrill

Definition at line 731 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), API_HANDLER_PCB::handleGetBoardDesignRules(), ROUTER_TOOL::handleLayerSwitch(), API_HANDLER_PCB::handleSetBoardDesignRules(), PNS_KICAD_IFACE_BASE::ImportSizes(), initFromOther(), PCB_IO_EAGLE::loadBoard(), PCB_IO_PADS::loadBoardSetup(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), and ValidateDesignRules().

◆ m_modified

bool JSON_SETTINGS::m_modified

protectedinherited

True if the JSON data store has been written to since the last file write.

Definition at line 376 of file json_settings.h.

Referenced by TEST_JSON_SETTINGS::ClearModified(), DISK_SETTINGS::ForceModified(), TEST_JSON_SETTINGS::IsModified(), JSON_SETTINGS(), LoadFromFile(), ReleaseNestedSettings(), SaveToFile(), PROJECT_FILE::SerializeToString(), Store(), and PROJECT_FILE::Store().

◆ m_nested_settings

std::vector<NESTED_SETTINGS*> JSON_SETTINGS::m_nested_settings

protectedinherited

Nested settings files that live inside this one, if any.

Definition at line 361 of file json_settings.h.

Referenced by AddNestedSettings(), flushToStore(), LoadFromFile(), ReleaseNestedSettings(), and ~JSON_SETTINGS().

◆ m_NetSettings

std::shared_ptr<NET_SETTINGS> BOARD_DESIGN_SETTINGS::m_NetSettings

Definition at line 781 of file board_design_settings.h.

Referenced by KICAD_DIFF::PCB_MERGE_APPLIER::Apply(), DIPTRACE::PCB_PARSER::ApplyBoardSettings(), BOARD_NETLIST_UPDATER::ApplyChainNetclasses(), ALLEGRO::BOARD_BUILDER::applyConstraintSets(), ApplyImportedNetNameMap(), ALLEGRO::BOARD_BUILDER::applyMatchGroups(), BOARD::ApplyNetChainNetclasses(), ALLEGRO::BOARD_BUILDER::applyNetConstraints(), BOARD::BOARD(), BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), CONNECTIVITY_DATA::Build(), DIALOG_VIA_STITCH_PROPERTIES::buildGuardPreview(), APPEARANCE_CONTROLS::buildNetClassMenu(), PANEL_SETUP_RULES::checkPlausibility(), BOARD::ClearProject(), ComputeBoardStatistics(), KICAD_DIFF::PCB_DIFFER::Diff(), NETCLASS_EXPECTATION::doSimpleCountTest(), NETCLASS_EXPECTATION::findMatchingNetclasses(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::FromSESSION(), GetCurrentDiffPairGap(), GetCurrentDiffPairViaGap(), GetCurrentDiffPairWidth(), GetCurrentTrackWidth(), GetCurrentViaDrill(), GetCurrentViaSize(), GetSmallestClearanceValue(), initFromOther(), PCB_IO_EAGLE::loadBoard(), PCB_IO_EASYEDA::loadBoard(), PCB_IO_PADS::loadBoardSetup(), PCB_IO_EAGLE::loadClasses(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), PCB_IO_KICAD_LEGACY::loadSETUP(), PCB_IO_EAGLE::loadSignals(), NETINFO_ITEM::NETINFO_ITEM(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), PANEL_DRC_RULE_EDITOR::onScintillaCharAdded(), PANEL_SETUP_RULES::onScintillaCharAdded(), operator==(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_EASYEDAPRO_V3_PARSER::ParseBoard(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), APPEARANCE_CONTROLS::rebuildNets(), PCBNEW_JOBS_HANDLER::runPcbMerge(), BOARD::SetProject(), BOARD::SynchronizeNetsAndNetClasses(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), BOARD_EDITOR_CONTROL::ViaSizeDec(), and BOARD_EDITOR_CONTROL::ViaSizeInc().

◆ m_Pad_Master

std::unique_ptr<PAD> BOARD_DESIGN_SETTINGS::m_Pad_Master

Definition at line 816 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), BOARD_DESIGN_SETTINGS(), initFromOther(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), and SetDefaultMasterPad().

◆ m_params

std::vector<PARAM_BASE*> JSON_SETTINGS::m_params

protectedinherited

The list of parameters (owned by this object)

Definition at line 358 of file json_settings.h.

Referenced by PCB_VIEWERS_SETTINGS_BASE::addMatchPropertiesParam(), APP_SETTINGS_BASE::addParamsForWindow(), APP_SETTINGS_BASE::APP_SETTINGS_BASE(), BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), COMMON_SETTINGS::COMMON_SETTINGS(), COMPONENT_CLASS_SETTINGS::COMPONENT_CLASS_SETTINGS(), COLOR_SETTINGS::CreateBuiltinColorSettings(), CVPCB_SETTINGS::CVPCB_SETTINGS(), DATABASE_LIB_SETTINGS::DATABASE_LIB_SETTINGS(), DISK_PARENT_SETTINGS::DISK_PARENT_SETTINGS(), DISK_SETTINGS::DISK_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), ERC_SETTINGS::ERC_SETTINGS(), FLUSH_TEST_SETTINGS::FLUSH_TEST_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), formatFileContents(), GERBVIEW_SETTINGS::GERBVIEW_SETTINGS(), COLOR_SETTINGS::GetDefaultColor(), HTTP_LIB_SETTINGS::HTTP_LIB_SETTINGS(), COLOR_SETTINGS::initFromOther(), JOBSET::JOBSET(), JSON_SETTINGS(), KICAD_SETTINGS::KICAD_SETTINGS(), Load(), NET_SETTINGS::NET_SETTINGS(), NGSPICE_SETTINGS::NGSPICE_SETTINGS(), PCB_CALCULATOR_SETTINGS::PCB_CALCULATOR_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PL_EDITOR_SETTINGS::PL_EDITOR_SETTINGS(), PROJECT_FILE::PROJECT_FILE(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), ResetToDefaults(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), NESTED_SETTINGS::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SPICE_SETTINGS::SPICE_SETTINGS(), Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), TEST_NESTED_SETTINGS::TEST_NESTED_SETTINGS(), TOOLBAR_SETTINGS::TOOLBAR_SETTINGS(), TUNING_PROFILES::TUNING_PROFILES(), and ~JSON_SETTINGS().

◆ m_parent

JSON_SETTINGS* NESTED_SETTINGS::m_parent

protectedinherited

A pointer to the parent object to load and store from.

Definition at line 63 of file nested_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), GetParent(), LoadFromFile(), NESTED_SETTINGS(), SaveToFile(), SetParent(), BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS(), COMPONENT_CLASS_SETTINGS::~COMPONENT_CLASS_SETTINGS(), ERC_SETTINGS::~ERC_SETTINGS(), MIGRATING_NESTED_SETTINGS::~MIGRATING_NESTED_SETTINGS(), ~NESTED_SETTINGS(), NET_SETTINGS::~NET_SETTINGS(), SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS(), TEST_NESTED_SETTINGS::~TEST_NESTED_SETTINGS(), and TUNING_PROFILES::~TUNING_PROFILES().

◆ m_path

std::string NESTED_SETTINGS::m_path

protectedinherited

The path (in pointer format) of where to store this document in the parent.

Definition at line 66 of file nested_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), LoadFromFile(), NESTED_SETTINGS(), and SaveToFile().

◆ m_PlugViasBack

bool BOARD_DESIGN_SETTINGS::m_PlugViasBack

Definition at line 773 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), operator==(), and PCB_IO_KICAD_SEXPR_PARSER::parseSetup().

◆ m_PlugViasFront

bool BOARD_DESIGN_SETTINGS::m_PlugViasFront

Definition at line 772 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), operator==(), and PCB_IO_KICAD_SEXPR_PARSER::parseSetup().

◆ m_resetParamsIfMissing

bool JSON_SETTINGS::m_resetParamsIfMissing

protectedinherited

Whether or not to set parameters to their default value if missing from JSON on Load()

Definition at line 385 of file json_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), JSON_SETTINGS(), Load(), ResetsParamsIfMissing(), and TEST_NESTED_SETTINGS::TEST_NESTED_SETTINGS().

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion

protectedinherited

Version of this settings schema.

Definition at line 388 of file json_settings.h.

Referenced by JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), Migrate(), registerMigration(), and NESTED_SETTINGS::SaveToFile().

◆ m_SilkClearance

int BOARD_DESIGN_SETTINGS::m_SilkClearance

Definition at line 737 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), PCB_IO_PADS::loadBoardSetup(), DRC_ENGINE::loadImplicitRules(), operator==(), and ValidateDesignRules().

◆ m_SingleTrackMeanderSettings

PNS::MEANDER_SETTINGS BOARD_DESIGN_SETTINGS::m_SingleTrackMeanderSettings

Definition at line 715 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_TUNING_PATTERN::CreateNew(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), PANEL_SETUP_TUNING_PATTERNS::ImportSettingsFrom(), and DRAWING_TOOL::PlaceTuningPattern().

◆ m_SkewMeanderSettings

PNS::MEANDER_SETTINGS BOARD_DESIGN_SETTINGS::m_SkewMeanderSettings

Definition at line 717 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_TUNING_PATTERN::CreateNew(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), PANEL_SETUP_TUNING_PATTERNS::ImportSettingsFrom(), and DRAWING_TOOL::PlaceTuningPattern().

◆ m_SolderMaskExpansion

int BOARD_DESIGN_SETTINGS::m_SolderMaskExpansion

Definition at line 755 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOARD_ADAPTER::createLayers(), KIGFX::PCB_PAINTER::draw(), PCB_IO_KICAD_SEXPR::formatSetup(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), PCB_IO_PADS::loadBoardSetup(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), DIALOG_PLOT::reInitDialog(), DIALOG_PLOT::SetPlotFormat(), and ValidateDesignRules().

◆ m_SolderMaskMinWidth

int BOARD_DESIGN_SETTINGS::m_SolderMaskMinWidth

Definition at line 756 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), GenerateLayerPoly(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), PlotSolderMaskLayer(), DIALOG_PLOT::reInitDialog(), DIALOG_PLOT::SetPlotFormat(), and ValidateDesignRules().

◆ m_SolderMaskToCopperClearance

int BOARD_DESIGN_SETTINGS::m_SolderMaskToCopperClearance

Definition at line 758 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), BOOST_FIXTURE_TEST_CASE(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), operator==(), and ValidateDesignRules().

◆ m_SolderPasteMargin

int BOARD_DESIGN_SETTINGS::m_SolderPasteMargin

Definition at line 761 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), and ValidateDesignRules().

◆ m_SolderPasteMarginRatio

double BOARD_DESIGN_SETTINGS::m_SolderPasteMarginRatio

Definition at line 762 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), and ValidateDesignRules().

◆ m_stackup

BOARD_STACKUP BOARD_DESIGN_SETTINGS::m_stackup

private

The description of layers stackup, for board fabrication only physical layers are in layers stackup.

It includes not only layers enabled for the board edition, but also dielectric layers.

Definition at line 863 of file board_design_settings.h.

Referenced by GetStackupDescriptor(), GetStackupDescriptor(), initFromOther(), and operator==().

◆ m_StyleFPBarcodes

bool BOARD_DESIGN_SETTINGS::m_StyleFPBarcodes

Definition at line 813 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PANEL_SETUP_FORMATTING::ImportSettingsFrom(), initFromOther(), LoadFootprintFromProject(), operator==(), and FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard().

◆ m_StyleFPDimensions

bool BOARD_DESIGN_SETTINGS::m_StyleFPDimensions

Definition at line 812 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PANEL_SETUP_FORMATTING::ImportSettingsFrom(), initFromOther(), LoadFootprintFromProject(), operator==(), and FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard().

◆ m_StyleFPFields

bool BOARD_DESIGN_SETTINGS::m_StyleFPFields

Definition at line 809 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PANEL_SETUP_FORMATTING::ImportSettingsFrom(), initFromOther(), LoadFootprintFromProject(), operator==(), and FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard().

◆ m_StyleFPShapes

bool BOARD_DESIGN_SETTINGS::m_StyleFPShapes

Definition at line 811 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PANEL_SETUP_FORMATTING::ImportSettingsFrom(), initFromOther(), LoadFootprintFromProject(), operator==(), and FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard().

◆ m_StyleFPText

bool BOARD_DESIGN_SETTINGS::m_StyleFPText

Definition at line 810 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PANEL_SETUP_FORMATTING::ImportSettingsFrom(), initFromOther(), LoadFootprintFromProject(), operator==(), and FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard().

◆ m_TeardropParamsList

TEARDROP_PARAMETERS_LIST BOARD_DESIGN_SETTINGS::m_TeardropParamsList

The parameters of teardrops for the different teardrop targets (via/pad, track end).

3 set of parameters always exist: for round shapes, for rect shapes, for track ends.

Definition at line 713 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetTeadropParamsList(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataToWindow(), and ValidateDesignRules().

◆ m_TempOverrideTrackWidth

bool BOARD_DESIGN_SETTINGS::m_TempOverrideTrackWidth

Definition at line 723 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), ROUTER_TOOL::CustomTrackWidthDialog(), TRACK_WIDTH_MENU::eventHandler(), PNS_KICAD_IFACE_BASE::ImportSizes(), initFromOther(), operator==(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), BOARD_EDITOR_CONTROL::TrackWidthDec(), and BOARD_EDITOR_CONTROL::TrackWidthInc().

◆ m_TentViasBack

bool BOARD_DESIGN_SETTINGS::m_TentViasBack

Definition at line 767 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), PCB_IO_KICAD_SEXPR::formatSetup(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), operator==(), and PCB_IO_KICAD_SEXPR_PARSER::parseSetup().

◆ m_TentViasFront

bool BOARD_DESIGN_SETTINGS::m_TentViasFront

Definition at line 766 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), PCB_IO_KICAD_SEXPR::formatSetup(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), operator==(), and PCB_IO_KICAD_SEXPR_PARSER::parseSetup().

◆ m_TextItalic

bool BOARD_DESIGN_SETTINGS::m_TextItalic[LAYER_CLASS_COUNT]

Definition at line 796 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetTextItalic(), API_HANDLER_BOARD::handleGetGraphicsDefaults(), initFromOther(), PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::loadFPSettings(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseDefaultTextDims(), and PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::TransferDataFromWindow().

◆ m_TextSize

VECTOR2I BOARD_DESIGN_SETTINGS::m_TextSize[LAYER_CLASS_COUNT]

Definition at line 794 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetTextSize(), API_HANDLER_BOARD::handleGetGraphicsDefaults(), initFromOther(), PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::loadFPSettings(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseDefaultTextDims(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), and PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::TransferDataFromWindow().

◆ m_TextThickness

int BOARD_DESIGN_SETTINGS::m_TextThickness[LAYER_CLASS_COUNT]

Definition at line 795 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetTextThickness(), API_HANDLER_BOARD::handleGetGraphicsDefaults(), initFromOther(), PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::loadFPSettings(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseDefaultTextDims(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), and PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::TransferDataFromWindow().

◆ m_TextUpright

bool BOARD_DESIGN_SETTINGS::m_TextUpright[LAYER_CLASS_COUNT]

Definition at line 797 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetTextUpright(), API_HANDLER_BOARD::handleGetGraphicsDefaults(), initFromOther(), operator==(), and PCB_IO_KICAD_SEXPR_PARSER::parseDefaultTextDims().

◆ m_TrackMinWidth

◆ m_trackWidthIndex

int BOARD_DESIGN_SETTINGS::m_trackWidthIndex

private

Definition at line 833 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetCurrentTrackWidth(), GetTrackWidthIndex(), initFromOther(), operator==(), SetTrackWidthIndex(), and UseNetClassTrack().

◆ m_TrackWidthList

std::vector<int> BOARD_DESIGN_SETTINGS::m_TrackWidthList

Definition at line 703 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), GetCurrentTrackWidth(), GetNextTrackWidthIndex(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), SetTrackWidthIndex(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), TRACK_WIDTH_MENU::update(), and PCB_EDIT_FRAME::UpdateTrackWidthSelectBox().

◆ m_UseConnectedTrackWidth

bool BOARD_DESIGN_SETTINGS::m_UseConnectedTrackWidth

Definition at line 721 of file board_design_settings.h.

Referenced by BOARD_EDITOR_CONTROL::AutoTrackWidth(), BOARD_DESIGN_SETTINGS(), TRACK_WIDTH_MENU::eventHandler(), VIA_SIZE_MENU::eventHandler(), PNS_KICAD_IFACE_BASE::ImportSizes(), initFromOther(), PNS_LOG_FILE::Load(), PCB_EDIT_FRAME::LoadProjectSettings(), operator==(), PCB_EDIT_FRAME::saveProjectSettings(), PCB_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), TRACK_WIDTH_MENU::update(), and VIA_SIZE_MENU::update().

◆ m_useCustomDiffPair

bool BOARD_DESIGN_SETTINGS::m_useCustomDiffPair

private

Definition at line 844 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetCurrentDiffPairGap(), GetCurrentDiffPairViaGap(), GetCurrentDiffPairWidth(), initFromOther(), operator==(), SetDiffPairIndex(), UseCustomDiffPairDimensions(), UseCustomDiffPairDimensions(), and UseNetClassDiffPair().

◆ m_useCustomTrackVia

bool BOARD_DESIGN_SETTINGS::m_useCustomTrackVia

private

Definition at line 839 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetCurrentTrackWidth(), GetCurrentViaDrill(), GetCurrentViaSize(), initFromOther(), operator==(), SetTrackWidthIndex(), SetViaSizeIndex(), UseCustomTrackViaSize(), UseCustomTrackViaSize(), UseNetClassTrack(), and UseNetClassVia().

◆ m_UseHeightForLengthCalcs

bool BOARD_DESIGN_SETTINGS::m_UseHeightForLengthCalcs

Enable inclusion of stackup height in track length measurements and length tuning.

Definition at line 825 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), initFromOther(), and operator==().

◆ m_userDefinedLayerCount

int BOARD_DESIGN_SETTINGS::m_userDefinedLayerCount

private

Number of user defined layers for this design.

Definition at line 848 of file board_design_settings.h.

Referenced by GetUserDefinedLayerCount(), initFromOther(), operator==(), SetEnabledLayers(), and SetUserDefinedLayerCount().

◆ m_UserLayerNames

std::map<std::string, wxString> BOARD_DESIGN_SETTINGS::m_UserLayerNames

Definition at line 787 of file board_design_settings.h.

Referenced by initFromOther(), PANEL_FP_USER_LAYER_NAMES::loadFPSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), operator==(), APPEARANCE_CONTROLS::rebuildLayers(), and PANEL_FP_USER_LAYER_NAMES::TransferDataFromWindow().

◆ m_ViasDimensionsList

std::vector<VIA_DIMENSION> BOARD_DESIGN_SETTINGS::m_ViasDimensionsList

◆ m_viaSizeIndex

int BOARD_DESIGN_SETTINGS::m_viaSizeIndex

private

Definition at line 834 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetCurrentViaDrill(), GetCurrentViaSize(), GetViaSizeIndex(), initFromOther(), operator==(), SetViaSizeIndex(), and UseNetClassVia().

◆ m_ViasMinAnnularWidth

int BOARD_DESIGN_SETTINGS::m_ViasMinAnnularWidth

Definition at line 729 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardDesignRules(), initFromOther(), PCB_IO_EAGLE::loadBoard(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), and ValidateDesignRules().

◆ m_ViasMinSize

int BOARD_DESIGN_SETTINGS::m_ViasMinSize

Definition at line 730 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), API_HANDLER_PCB::handleGetBoardDesignRules(), ROUTER_TOOL::handleLayerSwitch(), API_HANDLER_PCB::handleSetBoardDesignRules(), PNS_KICAD_IFACE_BASE::ImportSizes(), initFromOther(), PCB_IO_EAGLE::loadBoard(), PCB_IO_PADS::loadBoardSetup(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), and ValidateDesignRules().

◆ m_viaStackIndex

int BOARD_DESIGN_SETTINGS::m_viaStackIndex

private

Definition at line 836 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetViaStackIndex(), initFromOther(), operator==(), and SetViaStackIndex().

◆ m_ViaStackPresets

std::vector<VIA_STACK_PRESET> BOARD_DESIGN_SETTINGS::m_ViaStackPresets

Definition at line 705 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), initFromOther(), PANEL_SETUP_VIA_STACKS::loadFrom(), ROUTER_TOOL::onViaStackCommand(), operator==(), PCB_EDIT_FRAME::SelectViaStack_Event(), PANEL_SETUP_VIA_STACKS::TransferDataFromWindow(), and PCB_EDIT_FRAME::UpdateViaStackSelectBox().

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile

protectedinherited

Whether or not the backing store file should be written.

Definition at line 373 of file json_settings.h.

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), COLOR_SETTINGS::initFromOther(), IsReadOnly(), JSON_SETTINGS(), LoadFromFile(), SaveToFile(), and SetReadOnly().

◆ m_ZoneKeepExternalFillets

bool BOARD_DESIGN_SETTINGS::m_ZoneKeepExternalFillets

Definition at line 749 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), initFromOther(), LoadFromFile(), and operator==().

◆ m_ZoneLayerProperties

std::map<PCB_LAYER_ID, ZONE_LAYER_PROPERTIES> BOARD_DESIGN_SETTINGS::m_ZoneLayerProperties

Definition at line 790 of file board_design_settings.h.

Referenced by PCB_IO_KICAD_SEXPR::formatSetup().

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

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BOARD_DESIGN_SETTINGS() [1/2]

◆ ~BOARD_DESIGN_SETTINGS()

◆ BOARD_DESIGN_SETTINGS() [2/2]

Member Function Documentation

◆ AddNestedSettings()

◆ At()

◆ Contains()

◆ fetchOrDefault()

◆ flushToStore()

◆ FormatAsString()

◆ formatFileContents()

◆ fromLegacy()

◆ fromLegacyColor()

◆ fromLegacyString()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAuxOrigin()

◆ GetBiggestClearanceValue()

◆ GetBoardThickness()

◆ GetCopperLayerCount()

◆ GetCurrentDiffPairGap()

◆ GetCurrentDiffPairViaGap()

◆ GetCurrentDiffPairWidth()

◆ GetCurrentNetClassName()

◆ GetCurrentTrackWidth()

◆ GetCurrentViaDrill()

◆ GetCurrentViaSize()

◆ GetCustomDiffPairGap()

◆ GetCustomDiffPairViaGap()

◆ GetCustomDiffPairWidth()

◆ GetCustomTrackWidth()

◆ GetCustomViaDrill()

◆ GetCustomViaSize()

◆ GetDefaultZoneSettings()

◆ GetDiffPairIndex()

◆ GetDRCEpsilon()

◆ GetDrillSymbolProfile() [1/2]

◆ GetDrillSymbolProfile() [2/2]

◆ GetEnabledLayers()

◆ getFileExt()

◆ GetFileHistories()

◆ GetFilename()

◆ GetFullFilename()

◆ GetGridOrigin()

◆ GetHolePlatingThickness()

◆ GetJson()

◆ GetLayerClass()

◆ getLegacyFileExt()

◆ GetLineThickness()

◆ GetLocation()

◆ GetNextDiffPairIndex()

◆ GetNextTrackWidthIndex()

◆ GetNextViaSizeIndex()

◆ GetOwningProject()

◆ GetParent()

◆ GetSeverity()

◆ GetSmallestClearanceValue()

◆ GetStackupDescriptor() [1/2]

◆ GetStackupDescriptor() [2/2]

◆ GetTeadropParamsList()

◆ GetTextItalic()

◆ GetTextSize()

◆ GetTextThickness()

◆ GetTextUpright()

◆ GetTrackWidthIndex()

◆ GetUserDefinedLayerCount()

◆ GetViaSizeIndex()

◆ GetViaStackIndex()