BOARD_DESIGN_SETTINGS Class Reference

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

#include <board_design_settings.h>

Inheritance diagram for BOARD_DESIGN_SETTINGS:

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
TEARDROP_PARAMETERS_LIST *	GetTeadropParamsList ()
SEVERITY	GetSeverity (int aDRCErrorCode)
bool	Ignore (int aDRCErrorCode)
	Return true if the DRC error code's severity is SEVERITY_IGNORE.
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
unsigned	GetTrackWidthIndex () const
void	SetTrackWidthIndex (unsigned aIndex)
	Set the current track width list index to aIndex.
int	GetCurrentTrackWidth () const
void	SetCustomTrackWidth (int aWidth)
	Sets custom width for track (i.e.
int	GetCustomTrackWidth () const
unsigned	GetViaSizeIndex () const
void	SetViaSizeIndex (unsigned aIndex)
	Set the current via size list index to aIndex.
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
unsigned	GetDiffPairIndex () const
void	SetDiffPairIndex (unsigned aIndex)
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 ()
	Function 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
void	SetLegacyFilename (const wxString &aFilename)
bool	IsReadOnly () const
void	SetReadOnly (bool aReadOnly)
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.
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<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)
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< 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< wxString >	m_DrcExclusions
std::map< wxString, wxString >	m_DrcExclusionComments
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
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
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.

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.
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_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 ()

Private Attributes
VECTOR2I	m_auxOrigin
	origin for plot exports
VECTOR2I	m_gridOrigin
	origin for grid offsets
unsigned	m_trackWidthIndex
unsigned	m_viaSizeIndex
unsigned	m_diffPairIndex
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.
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 249 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 41 of file board_design_settings.cpp.

References PADSTACK::ALL_LAYERS, ARC_HIGH_DEF, DEFAULT_BOARD_THICKNESS_MM, DEFAULT_COPPER_LINE_WIDTH, DEFAULT_COPPER_TEXT_SIZE, DEFAULT_COPPER_TEXT_WIDTH, DEFAULT_COPPEREDGECLEARANCE, DEFAULT_COURTYARD_WIDTH, DEFAULT_CUSTOMDPAIRGAP, DEFAULT_CUSTOMDPAIRVIAGAP, DEFAULT_CUSTOMDPAIRWIDTH, DEFAULT_CUSTOMTRACKWIDTH, DEFAULT_DIMENSION_ARROW_LENGTH, DEFAULT_DIMENSION_EXTENSION_OFFSET, DEFAULT_DP_MEANDER_SPACING, DEFAULT_EDGE_WIDTH, DEFAULT_HOLECLEARANCE, DEFAULT_HOLETOHOLEMIN, DEFAULT_LINE_WIDTH, DEFAULT_MEANDER_SPACING, DEFAULT_MICROVIASMINDRILL, DEFAULT_MICROVIASMINSIZE, DEFAULT_MINCLEARANCE, DEFAULT_MINCONNECTION, DEFAULT_MINGROOVEWIDTH, DEFAULT_MINRESOLVEDSPOKES, DEFAULT_MINTHROUGHDRILL, DEFAULT_SILK_LINE_WIDTH, DEFAULT_SILK_TEXT_SIZE, DEFAULT_SILK_TEXT_WIDTH, DEFAULT_SILKCLEARANCE, DEFAULT_SOLDERMASK_EXPANSION, DEFAULT_SOLDERMASK_MIN_WIDTH, DEFAULT_SOLDERMASK_TO_COPPER_CLEARANCE, DEFAULT_SOLDERPASTE_CLEARANCE, DEFAULT_SOLDERPASTE_RATIO, DEFAULT_TEXT_SIZE, DEFAULT_TEXT_WIDTH, DEFAULT_TRACKMINWIDTH, DEFAULT_VIASMINSIZE, DRCE_CONNECTION_WIDTH, DRCE_COPPER_SLIVER, DRCE_DANGLING_TRACK, DRCE_DANGLING_VIA, DRCE_DRILLED_HOLES_COLOCATED, DRCE_DRILLED_HOLES_TOO_CLOSE, DRCE_DUPLICATE_FOOTPRINT, DRCE_EXTRA_FOOTPRINT, DRCE_FIRST, DRCE_FOOTPRINT_FILTERS, DRCE_FOOTPRINT_TYPE_MISMATCH, DRCE_ISOLATED_COPPER, DRCE_LAST, DRCE_LIB_FOOTPRINT_ISSUES, DRCE_LIB_FOOTPRINT_MISMATCH, DRCE_MIRRORED_TEXT_ON_FRONT_LAYER, DRCE_MISSING_COURTYARD, DRCE_MISSING_FOOTPRINT, DRCE_NET_CONFLICT, DRCE_NONMIRRORED_TEXT_ON_BACK_LAYER, DRCE_NPTH_IN_COURTYARD, DRCE_OVERLAPPING_SILK, DRCE_PADSTACK, DRCE_PTH_IN_COURTYARD, DRCE_SCHEMATIC_PARITY, DRCE_SILK_EDGE_CLEARANCE, DRCE_SILK_MASK_CLEARANCE, DRCE_TEXT_HEIGHT, DRCE_TEXT_THICKNESS, F_Fab, F_SilkS, DRC_ITEM::GetItemsWithSeverities(), TEARDROP_PARAMETERS_LIST::GetParameters(), TEARDROP_PARAMETERS_LIST::GetParametersCount(), GetTeardropTargetCanonicalName(), GetTeardropTargetTypeFromCanonicalName(), EDA_IU_SCALE::IU_PER_MM, EDA_IU_SCALE::IUTomm(), LAYER_CLASS_COPPER, LAYER_CLASS_COURTYARD, LAYER_CLASS_EDGES, LAYER_CLASS_FAB, LAYER_CLASS_OTHERS, LAYER_CLASS_SILK, m_AllowSoldermaskBridgesInFPs, TEARDROP_PARAMETERS::m_AllowUseTwoTracks, TEARDROP_PARAMETERS::m_BestLengthRatio, TEARDROP_PARAMETERS::m_BestWidthRatio, m_boardThickness, m_CapVias, m_CopperEdgeClearance, PNS::MEANDER_SETTINGS::m_cornerRadiusPercentage, PNS::MEANDER_SETTINGS::m_cornerStyle, m_CoverViasBack, m_CoverViasFront, m_CurrentViaType, TEARDROP_PARAMETERS::m_CurvedEdges, m_customDiffPair, m_customTrackWidth, m_customViaSize, m_DefaultFPTextItems, m_defaultZoneSettings, VIA_DIMENSION::m_Diameter, m_DiffPairDimensionsList, m_diffPairIndex, m_DiffPairMeanderSettings, m_DimensionArrowLength, m_DimensionExtensionOffset, m_DimensionKeepTextAligned, m_DimensionPrecision, m_DimensionSuppressZeroes, m_DimensionTextPosition, m_DimensionUnitsFormat, m_DimensionUnitsMode, m_DrcExclusionComments, m_DrcExclusions, m_DRCSeverities, VIA_DIMENSION::m_Drill, m_enabledLayers, m_FillVias, DIFF_PAIR_DIMENSION::m_Gap, m_HasStackup, m_HoleClearance, m_HoleToHoleMin, m_LineThickness, PNS::MEANDER_SETTINGS::m_maxAmplitude, m_MaxError, m_MicroViasMinDrill, m_MicroViasMinSize, PNS::MEANDER_SETTINGS::m_minAmplitude, m_MinClearance, m_MinConn, m_MinGrooveWidth, m_MinResolvedSpokes, m_MinSilkTextHeight, m_MinSilkTextThickness, m_MinThroughDrill, m_NetSettings, m_Pad_Master, JSON_SETTINGS::m_params, m_PlugViasBack, m_PlugViasFront, JSON_SETTINGS::m_resetParamsIfMissing, m_SilkClearance, PNS::MEANDER_SETTINGS::m_singleSided, m_SingleTrackMeanderSettings, m_SkewMeanderSettings, m_SolderMaskExpansion, m_SolderMaskMinWidth, m_SolderMaskToCopperClearance, m_SolderPasteMargin, m_SolderPasteMarginRatio, PNS::MEANDER_SETTINGS::m_spacing, m_StyleFPFields, m_StyleFPShapes, m_StyleFPText, TEARDROP_PARAMETERS_LIST::m_TargetPTHPads, TEARDROP_PARAMETERS_LIST::m_TargetSMDPads, TEARDROP_PARAMETERS_LIST::m_TargetTrack2Track, TEARDROP_PARAMETERS_LIST::m_TargetVias, TEARDROP_PARAMETERS::m_TdMaxLen, TEARDROP_PARAMETERS::m_TdMaxWidth, TEARDROP_PARAMETERS::m_TdOnPadsInZones, m_TeardropParamsList, 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, TEARDROP_PARAMETERS_LIST::m_UseRoundShapesOnly, DIFF_PAIR_DIMENSION::m_ViaGap, m_ViasDimensionsList, m_viaSizeIndex, m_ViasMinAnnularWidth, m_ViasMinSize, DIFF_PAIR_DIMENSION::m_Width, TEARDROP_PARAMETERS::m_WidthtoSizeFilterRatio, ZONE_SETTINGS::m_ZoneClearance, m_ZoneKeepExternalFillets, PNS::MEANDER_STYLE_CHAMFER, PNS::MEANDER_STYLE_ROUND, migrateSchema0to1(), EDA_IU_SCALE::MilsToIU(), EDA_IU_SCALE::MM_PER_IU, EDA_IU_SCALE::mmToIU(), name, pcbIUScale, JSON_SETTINGS::registerMigration(), RPT_SEVERITY_ERROR, RPT_SEVERITY_IGNORE, RPT_SEVERITY_WARNING, BASE_SET::set(), SetCopperLayerCount(), SetDefaultMasterPad(), SetUserDefinedLayerCount(), SeverityToString(), TEXT_MAX_SIZE_MM, TEXT_MIN_SIZE_MM, via, VECTOR2< T >::x, VECTOR2< T >::y, and ZONE_CLEARANCE_MM.

~BOARD_DESIGN_SETTINGS()

BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS ( )

virtual

Definition at line 931 of file board_design_settings.cpp.

References NESTED_SETTINGS::m_parent, and JSON_SETTINGS::ReleaseNestedSettings().

BOARD_DESIGN_SETTINGS() [2/2]

BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS

(

const BOARD_DESIGN_SETTINGS &

aOther

)

Definition at line 941 of file board_design_settings.cpp.

References initFromOther().

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
aTarget	is a pointer to update to the passed in settings

Definition at line 886 of file json_settings.cpp.

References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_nested_settings, and traceSettings.

Referenced by NESTED_SETTINGS::SetParent().

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 119 of file json_settings.cpp.

References JSON_SETTINGS::m_internals.

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

Contains()

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

inherited

Definition at line 125 of file json_settings.cpp.

References JSON_SETTINGS::m_internals, and JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), LoadFromFile(), EESCHEMA_SETTINGS::migrateBomSettings(), migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), 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.

Returns

the result, or aDefault if aKey is not found.

Definition at line 934 of file json_settings.cpp.

FormatAsString()

const std::string JSON_SETTINGS::FormatAsString ( )

inherited

Definition at line 521 of file json_settings.cpp.

References dummy, JSON_SETTINGS::m_internals, and JSON_SETTINGS::Store().

Referenced by ROUTER_TOOL::saveRouterDebugLog().

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 795 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 858 of file json_settings.cpp.

References color.

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

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 834 of file json_settings.cpp.

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

Get() [1/2]

template<>

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

inherited

Definition at line 917 of file json_settings.cpp.

References JSON_SETTINGS::GetJson().

Get() [2/2]

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 586 of file json_settings.cpp.

References JSON_SETTINGS::GetJson().

Referenced by 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_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().

GetAuxOrigin()

const VECTOR2I & BOARD_DESIGN_SETTINGS::GetAuxOrigin ( ) const

inline

Definition at line 675 of file board_design_settings.h.

References m_auxOrigin.

Referenced by AddGerberX2Header(), build_pad_testpoints(), build_via_testpoints(), EXPORTER_STEP::buildBoard3DShapes(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), PCB_EDIT_FRAME::ExportToGenCAD(), PCB_IO_KICAD_SEXPR::formatSetup(), PCB_BASE_FRAME::GetAuxOrigin(), API_HANDLER_PCB::handleGetBoardOrigin(), initializePlotter(), ODB_NET_LIST::InitPadNetPoints(), ODB_NET_LIST::InitViaNetPoints(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportGencad(), EDIT_TOOL::MoveExact(), ALTIUM_PCB::Parse(), PLACE_FILE_EXPORTER::PLACE_FILE_EXPORTER(), PCB_PLOTTER::Plot(), and DIALOG_GENDRILL::UpdateDrillParams().

GetBiggestClearanceValue()

int BOARD_DESIGN_SETTINGS::GetBiggestClearanceValue

(

)

const

Returns

the biggest clearance value found in NetClasses list.

Definition at line 1300 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, and DRC_CONSTRAINT::Value().

Referenced by 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 636 of file board_design_settings.h.

References m_boardThickness.

Referenced by GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), BOARD_STACKUP::BuildDefaultStackupList(), EXPORTER_PCB_VRML::ComputeLayer3D_Zpos(), PCB_EDIT_FRAME::Export_IDF3(), EXPORTER_PCB_VRML::EXPORTER_PCB_VRML(), PCB_IO_KICAD_SEXPR::formatGeneral(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PCB_CONTROL::PlaceCharacteristics(), PANEL_SETUP_BOARD_STACKUP::TransferDataFromWindow(), and PANEL_PREVIEW_3D_MODEL::View3DSettings().

GetCopperLayerCount()

int BOARD_DESIGN_SETTINGS::GetCopperLayerCount ( ) const

inline

Returns

the number of enabled copper layers.

Definition at line 605 of file board_design_settings.h.

References m_copperLayerCount.

Referenced by BOARD_STACKUP::BuildDefaultStackupList(), PANEL_SETUP_BOARD_STACKUP::buildLayerStackPanel(), BOARD::GetCopperLayerCount(), ROUTER_TOOL::handleLayerSwitch(), and PCB_CONTROL::PlaceCharacteristics().

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 1425 of file board_design_settings.cpp.

References m_customDiffPair, m_DiffPairDimensionsList, m_diffPairIndex, DIFF_PAIR_DIMENSION::m_Gap, 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 1445 of file board_design_settings.cpp.

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

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 1405 of file board_design_settings.cpp.

References m_customDiffPair, m_DiffPairDimensionsList, m_diffPairIndex, m_NetSettings, m_useCustomDiffPair, and DIFF_PAIR_DIMENSION::m_Width.

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 296 of file board_design_settings.h.

References m_currentNetClassName.

Referenced by DIALOG_CLEANUP_TRACKS_AND_VIAS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TEARDROPS::buildFilterLists(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists().

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 1382 of file board_design_settings.cpp.

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

Referenced by EDIT_TOOL::ChangeTrackWidth(), 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 1360 of file board_design_settings.cpp.

References m_customViaSize, VIA_DIMENSION::m_Drill, m_NetSettings, m_useCustomTrackVia, m_ViasDimensionsList, and m_viaSizeIndex.

Referenced by EDIT_TOOL::ChangeTrackWidth(), DRAWING_TOOL::DrawVia(), ROUTER_TOOL::handleLayerSwitch(), PNS_KICAD_IFACE_BASE::ImportSizes(), 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 1349 of file board_design_settings.cpp.

References m_customViaSize, VIA_DIMENSION::m_Diameter, m_NetSettings, m_useCustomTrackVia, m_ViasDimensionsList, and m_viaSizeIndex.

Referenced by EDIT_TOOL::ChangeTrackWidth(), DRAWING_TOOL::DrawVia(), ROUTER_TOOL::handleLayerSwitch(), PNS_KICAD_IFACE_BASE::ImportSizes(), and PCB_EDIT_FRAME::SetTrackSegmentWidth().

GetCustomDiffPairGap()

int BOARD_DESIGN_SETTINGS::GetCustomDiffPairGap ( )

inline

Function GetCustomDiffPairGap.

Returns

Current custom gap width for differential pairs.

Definition at line 510 of file board_design_settings.h.

References m_customDiffPair, and DIFF_PAIR_DIMENSION::m_Gap.

GetCustomDiffPairViaGap()

int BOARD_DESIGN_SETTINGS::GetCustomDiffPairViaGap ( )

inline

Returns

Current custom via gap width for differential pairs.

Definition at line 529 of file board_design_settings.h.

References m_customDiffPair, DIFF_PAIR_DIMENSION::m_Gap, and DIFF_PAIR_DIMENSION::m_ViaGap.

GetCustomDiffPairWidth()

int BOARD_DESIGN_SETTINGS::GetCustomDiffPairWidth ( )

inline

Returns

Current custom track width for differential pairs.

Definition at line 491 of file board_design_settings.h.

References m_customDiffPair, and DIFF_PAIR_DIMENSION::m_Width.

GetCustomTrackWidth()

int BOARD_DESIGN_SETTINGS::GetCustomTrackWidth ( ) const

inline

Returns

Current custom width for a track.

Definition at line 370 of file board_design_settings.h.

References m_customTrackWidth.

Referenced by DIALOG_TRACK_VIA_SIZE::TransferDataToWindow().

GetCustomViaDrill()

int BOARD_DESIGN_SETTINGS::GetCustomViaDrill ( ) const

inline

Returns

Current custom size for the via drill.

Definition at line 441 of file board_design_settings.h.

References m_customViaSize, and VIA_DIMENSION::m_Drill.

Referenced by DIALOG_TRACK_VIA_SIZE::TransferDataToWindow().

GetCustomViaSize()

int BOARD_DESIGN_SETTINGS::GetCustomViaSize ( ) const

inline

Returns

Current custom size for the via diameter.

Definition at line 413 of file board_design_settings.h.

References m_customViaSize, and VIA_DIMENSION::m_Diameter.

Referenced by DIALOG_TRACK_VIA_SIZE::TransferDataToWindow().

GetDefaultZoneSettings()

ZONE_SETTINGS & BOARD_DESIGN_SETTINGS::GetDefaultZoneSettings ( )

inline

Definition at line 283 of file board_design_settings.h.

References m_defaultZoneSettings.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), CONVERT_TOOL::CreatePolys(), PCB_EDIT_FRAME::Edit_Zone_Params(), PCB_IO_KICAD_SEXPR::formatSetup(), CADSTAR_PCB_ARCHIVE_LOADER::getHatchCodeAngle(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadHatchCodeGap(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadHatchCodeThickness(), PCB_IO_KICAD_LEGACY::loadSETUP(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), ZONE::ZONE(), and GLOBAL_EDIT_TOOL::ZonesManager().

GetDiffPairIndex()

unsigned BOARD_DESIGN_SETTINGS::GetDiffPairIndex ( ) const

inline

Returns

the current diff pair dimension list index.

Definition at line 470 of file board_design_settings.h.

References m_diffPairIndex.

Referenced by 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 1529 of file board_design_settings.cpp.

References ADVANCED_CFG::GetCfg(), EDA_IU_SCALE::mmToIU(), and pcbIUScale.

Referenced by collidesWithArea(), DRAWING_TOOL::DrawVia(), PCB_TUNING_PATTERN::EditPush(), DRC_ENGINE::IsNetTieExclusion(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), and DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer().

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 576 of file board_design_settings.h.

References m_enabledLayers.

Referenced by BOARD_STACKUP::BuildDefaultStackupList(), LENGTH_DELAY_CALCULATION_ITEM::CalculateViaLayers(), GENCAD_EXPORTER::createPadsShapesSection(), GENCAD_EXPORTER::createRoutesSection(), BOARD::GetEnabledLayers(), and HYPERLYNX_EXPORTER::writeStackupInfo().

getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const

inlineprotectedvirtualinherited

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

Definition at line 283 of file json_settings.h.

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

GetFilename()

wxString JSON_SETTINGS::GetFilename ( ) const

inlineinherited

Definition at line 81 of file json_settings.h.

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

GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const

inherited

Definition at line 110 of file json_settings.cpp.

References JSON_SETTINGS::getFileExt(), and JSON_SETTINGS::m_filename.

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

GetGridOrigin()

const VECTOR2I & BOARD_DESIGN_SETTINGS::GetGridOrigin ( ) const

inline

Definition at line 678 of file board_design_settings.h.

References m_gridOrigin.

Referenced by EXPORTER_STEP::buildBoard3DShapes(), PCB_IO_KICAD_SEXPR::formatSetup(), PCB_BASE_FRAME::GetGridOrigin(), API_HANDLER_PCB::handleGetBoardOrigin(), ALTIUM_PCB::Parse(), PCB_EDIT_FRAME::RebuildAndRefresh(), 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 1535 of file board_design_settings.cpp.

References ADVANCED_CFG::GetCfg(), EDA_IU_SCALE::mmToIU(), and pcbIUScale.

Referenced by KIGFX::PCB_PAINTER::Draw(), and BOARD_ADAPTER::GetHolePlatingThickness().

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 566 of file json_settings.cpp.

References JSON_SETTINGS::m_internals.

Referenced by JSON_SETTINGS::Get(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< Type >::Load(), PARAM_SET< Type >::Load(), PARAM_MAP< Value >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< Type >::MatchesFile(), PARAM_SET< Type >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), PARAM_WXSTRING_MAP::MatchesFile(), SETTINGS_MANAGER::SaveColorSettings(), and NESTED_SETTINGS::SaveToFile().

GetLayerClass()

int BOARD_DESIGN_SETTINGS::GetLayerClass

(

PCB_LAYER_ID

aLayer

)

const

Definition at line 1512 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 288 of file json_settings.h.

Referenced by JSON_SETTINGS::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 1541 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::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawOneBezier(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), CADSTAR_PCB_ARCHIVE_LOADER::getLineThickness(), ALTIUM_PCB::HelperCreateBoardOutline(), 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(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DRAWING_TOOL::Reset(), and PCB_SHAPE::StyleFromSettings().

GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const

inlineinherited

Definition at line 88 of file json_settings.h.

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

GetParent()

JSON_SETTINGS * NESTED_SETTINGS::GetParent ( )

inlineinherited

Definition at line 54 of file nested_settings.h.

Referenced by LoadFromFile().

GetSeverity()

SEVERITY BOARD_DESIGN_SETTINGS::GetSeverity

(

int

aDRCErrorCode

)

Definition at line 1288 of file board_design_settings.cpp.

References m_DRCSeverities.

Referenced by BOOST_FIXTURE_TEST_CASE(), PCB_MARKER::GetSeverity(), DIALOG_DRC::OnIgnoredItemRClick(), DIALOG_DRC::updateDisplayedCounts(), WriteDRCReport(), DRC_REPORT::WriteJsonReport(), and DRC_REPORT::WriteTextReport().

GetSmallestClearanceValue()

int BOARD_DESIGN_SETTINGS::GetSmallestClearanceValue

(

)

const

Returns

the smallest clearance value found in NetClasses list.

Definition at line 1331 of file board_design_settings.cpp.

References clearance, m_NetSettings, and name.

Referenced by DIALOG_PLOT::init_Dialog().

GetStackupDescriptor() [1/2]

BOARD_STACKUP & BOARD_DESIGN_SETTINGS::GetStackupDescriptor ( )

inline

Definition at line 268 of file board_design_settings.h.

References m_stackup.

Referenced by GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), FOOTPRINT_CHOOSER_FRAME::build3DCanvas(), BOARD_STACKUP::BuildDefaultStackupList(), PANEL_SETUP_BOARD_STACKUP::buildLayerStackPanel(), EXPORTER_PCB_VRML::EXPORTER_PCB_VRML(), PCB_IO_KICAD_SEXPR::formatSetup(), PCB_IO_IPC2581::generateCadLayers(), PCB_IO_IPC2581::generateCadSpecs(), PCB_IO_IPC2581::generateContentStackup(), PCB_IO_IPC2581::generateStackup(), BOARD_ADAPTER::GetLayerColors(), BOARD::GetStackupOrDefault(), ODB_MATRIX_ENTITY::InitMatrixLayerData(), BOARD_ADAPTER::InitSettings(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), ALTIUM_PCB::ParseBoard6Data(), PCB_IO_KICAD_SEXPR_PARSER::parseBoardStackup(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), PCB_CONTROL::PlaceCharacteristics(), PCB_CONTROL::PlaceStackup(), PNS_KICAD_IFACE_BASE::StackupHeight(), LENGTH_DELAY_CALCULATION::StackupHeight(), PANEL_SETUP_BOARD_FINISH::synchronizeWithBoard(), BOARD_STACKUP::SynchronizeWithBoard(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), PANEL_SETUP_BOARD_FINISH::TransferDataFromWindow(), PANEL_SETUP_BOARD_STACKUP::TransferDataFromWindow(), PANEL_PREVIEW_3D_MODEL::View3DSettings(), and HYPERLYNX_EXPORTER::writeStackupInfo().

GetStackupDescriptor() [2/2]

const BOARD_STACKUP & BOARD_DESIGN_SETTINGS::GetStackupDescriptor ( ) const

inline

Definition at line 269 of file board_design_settings.h.

References m_stackup.

GetTeadropParamsList()

TEARDROP_PARAMETERS_LIST * BOARD_DESIGN_SETTINGS::GetTeadropParamsList ( )

inline

Definition at line 271 of file board_design_settings.h.

References m_TeardropParamsList.

Referenced by DIALOG_GLOBAL_EDIT_TEARDROPS::processItem(), TEARDROP_MANAGER::TEARDROP_MANAGER(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataFromWindow(), PANEL_SETUP_TEARDROPS::TransferDataFromWindow(), and PANEL_SETUP_TEARDROPS::TransferDataToWindow().

GetTextItalic()

bool BOARD_DESIGN_SETTINGS::GetTextItalic

(

PCB_LAYER_ID

aLayer

)

const

Definition at line 1559 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(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), 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 1547 of file board_design_settings.cpp.

References GetLayerClass(), and m_TextSize.

Referenced by PCB_BASE_FRAME::CreateNewFootprint(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), PCB_IO_EAGLE::loadPlain(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DRAWING_TOOL::PlaceText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DRAWING_TOOL::Reset(), 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 1553 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(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DRAWING_TOOL::Reset(), PCB_TEXT::StyleFromSettings(), and PCB_TEXTBOX::StyleFromSettings().

GetTextUpright()

bool BOARD_DESIGN_SETTINGS::GetTextUpright

(

PCB_LAYER_ID

aLayer

)

const

Definition at line 1565 of file board_design_settings.cpp.

References GetLayerClass(), and m_TextUpright.

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

GetTrackWidthIndex()

unsigned BOARD_DESIGN_SETTINGS::GetTrackWidthIndex ( ) const

inline

Returns

the current track width list index.

Definition at line 338 of file board_design_settings.h.

References m_trackWidthIndex.

Referenced by 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 620 of file board_design_settings.h.

References m_userDefinedLayerCount.

Referenced by BOARD::GetUserDefinedLayerCount().

GetViaSizeIndex()

unsigned BOARD_DESIGN_SETTINGS::GetViaSizeIndex ( ) const

inline

Returns

the current via size list index.

Definition at line 378 of file board_design_settings.h.

References m_viaSizeIndex.

Referenced by 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().

Ignore()

bool BOARD_DESIGN_SETTINGS::Ignore

(

int

aDRCErrorCode

)

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

Definition at line 1294 of file board_design_settings.cpp.

References m_DRCSeverities, and RPT_SEVERITY_IGNORE.

Referenced by DRC_ENGINE::RunTests().

initFromOther()

void BOARD_DESIGN_SETTINGS::initFromOther ( const BOARD_DESIGN_SETTINGS &  aOther )

private

Definition at line 957 of file board_design_settings.cpp.

References m_AllowSoldermaskBridgesInFPs, m_auxOrigin, m_boardThickness, 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_DrcExclusionComments, 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_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, and m_ZoneKeepExternalFillets.

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

Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )

inherited

Definition at line 131 of file json_settings.cpp.

References JSON_SETTINGS::m_internals.

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

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 594 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 92 of file json_settings.h.

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

Load()

void JSON_SETTINGS::Load ( )

virtualinherited

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

Definition at line 137 of file json_settings.cpp.

References JSON_SETTINGS::m_params, JSON_SETTINGS::m_resetParamsIfMissing, and traceSettings.

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), JSON_SETTINGS::LoadFromFile(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromRawFile(), PCB_TEST_FRAME_BASE::LoadSettings(), PCBNEW_SETTINGS::MigrateFromLegacy(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_3D_DISPLAY_OPTIONS::ResetPanel(), PANEL_3D_OPENGL_OPTIONS::ResetPanel(), PANEL_3D_RAYTRACING_OPTIONS::ResetPanel(), PANEL_EESCHEMA_ANNOTATION_OPTIONS::ResetPanel(), PANEL_EESCHEMA_DISPLAY_OPTIONS::ResetPanel(), PANEL_EESCHEMA_EDITING_OPTIONS::ResetPanel(), PANEL_SYM_DISPLAY_OPTIONS::ResetPanel(), PANEL_SYM_EDITING_OPTIONS::ResetPanel(), PANEL_GERBVIEW_DISPLAY_OPTIONS::ResetPanel(), PANEL_PL_EDITOR_DISPLAY_OPTIONS::ResetPanel(), PANEL_DISPLAY_OPTIONS::ResetPanel(), PANEL_EDIT_OPTIONS::ResetPanel(), PANEL_FP_EDITOR_FIELD_DEFAULTS::ResetPanel(), PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::ResetPanel(), PANEL_PCBNEW_DISPLAY_ORIGIN::ResetPanel(), SETTINGS_MANAGER::SaveColorSettings(), and SETTINGS_MANAGER::SETTINGS_MANAGER().

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 1213 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, name, project, and JSON_SETTINGS::Set().

LoadFromRawFile()

bool JSON_SETTINGS::LoadFromRawFile ( const wxString &  aPath )

inherited

Definition at line 534 of file json_settings.cpp.

References JSON_SETTINGS::Load(), JSON_SETTINGS::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 685 of file json_settings.cpp.

References JSON_SETTINGS::m_internals, JSON_SETTINGS::m_migrators, JSON_SETTINGS::m_schemaVersion, and traceSettings.

Referenced by JSON_SETTINGS::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 PROJECT_FILE, APP_SETTINGS_BASE, COLOR_SETTINGS, EDA_3D_VIEWER_SETTINGS, BITMAP2CMP_SETTINGS, EESCHEMA_SETTINGS, SYMBOL_EDITOR_SETTINGS, GERBVIEW_SETTINGS, FOOTPRINT_EDITOR_SETTINGS, PROJECT_LOCAL_SETTINGS, COMMON_SETTINGS, CVPCB_SETTINGS, KICAD_SETTINGS, PL_EDITOR_SETTINGS, PCB_CALCULATOR_SETTINGS, and PCBNEW_SETTINGS.

Definition at line 726 of file json_settings.cpp.

References traceSettings.

Referenced by JSON_SETTINGS::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 1161 of file board_design_settings.cpp.

References JSON_SETTINGS::At(), JSON_SETTINGS::Contains(), 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 257 of file board_design_settings.h.

References operator==().

operator=()

BOARD_DESIGN_SETTINGS & BOARD_DESIGN_SETTINGS::operator=

(

const BOARD_DESIGN_SETTINGS &

aOther

)

Definition at line 950 of file board_design_settings.cpp.

References initFromOther().

operator==()

bool BOARD_DESIGN_SETTINGS::operator==

(

const BOARD_DESIGN_SETTINGS &

aOther

)

const

Definition at line 1057 of file board_design_settings.cpp.

References m_AllowSoldermaskBridgesInFPs, m_auxOrigin, m_boardThickness, 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_DrcExclusionComments, 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_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, 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 676 of file json_settings.cpp.

References JSON_SETTINGS::m_migrators, and JSON_SETTINGS::m_schemaVersion.

Referenced by BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::PROJECT_FILE(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

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 893 of file json_settings.cpp.

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

Referenced by ~BOARD_DESIGN_SETTINGS(), COMPONENT_CLASS_SETTINGS::~COMPONENT_CLASS_SETTINGS(), ERC_SETTINGS::~ERC_SETTINGS(), NESTED_SETTINGS::~NESTED_SETTINGS(), NET_SETTINGS::~NET_SETTINGS(), SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS(), and TIME_DOMAIN_PARAMETERS::~TIME_DOMAIN_PARAMETERS().

ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )

inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 393 of file json_settings.cpp.

References JSON_SETTINGS::m_params.

Referenced by EDA_3D_VIEWER_FRAME::Process_Special_Functions(), PANEL_COMMON_SETTINGS::ResetPanel(), and PANEL_MOUSE_SETTINGS::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

Returns

true if the document contents were updated

Reimplemented from JSON_SETTINGS.

Definition at line 128 of file nested_settings.cpp.

References dummy, JSON_SETTINGS::GetFilename(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::m_filename, JSON_SETTINGS::m_internals, NESTED_SETTINGS::m_parent, NESTED_SETTINGS::m_path, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::Store(), and traceSettings.

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 639 of file json_settings.cpp.

References JSON_SETTINGS::m_internals.

Referenced by BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), LoadFromFile(), APP_SETTINGS_BASE::migrateFindReplace(), PROJECT_FILE::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), KICAD_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), PROJECT_FILE::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), COLOR_MAP_PARAM::Store(), PARAM< ValueType >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< Type >::Store(), PARAM_SET< Type >::Store(), PARAM_PATH_LIST::Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().

Set() [2/3]

template<>

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

inherited

Definition at line 927 of file json_settings.cpp.

Set() [3/3]

template<>

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

inherited

SetAuxOrigin()

void BOARD_DESIGN_SETTINGS::SetAuxOrigin ( const VECTOR2I &  aOrigin )

inline

Definition at line 674 of file board_design_settings.h.

References m_auxOrigin.

Referenced by BOARD_EDITOR_CONTROL::DoSetDrillOrigin(), PCB_IO_EASYEDA::LoadBoard(), PCB_IO_KICAD_LEGACY::loadSETUP(), ALTIUM_PCB::Parse(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), ALTIUM_PCB::ParseBoard6Data(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), and PCB_PLOTTER::Plot().

SetBoardThickness()

void BOARD_DESIGN_SETTINGS::SetBoardThickness ( int  aThickness )

inline

Definition at line 637 of file board_design_settings.h.

References m_boardThickness.

Referenced by FOOTPRINT_CHOOSER_FRAME::build3DCanvas(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), PCB_IO_KICAD_LEGACY::loadGENERAL(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PCB_IO_KICAD_SEXPR_PARSER::parseGeneralSection(), PANEL_SETUP_BOARD_STACKUP::TransferDataFromWindow(), 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 1465 of file board_design_settings.cpp.

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

Referenced by BOARD_DESIGN_SETTINGS(), and BOARD::SetCopperLayerCount().

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 501 of file board_design_settings.h.

References m_customDiffPair, and DIFF_PAIR_DIMENSION::m_Gap.

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 521 of file board_design_settings.h.

References m_customDiffPair, and DIFF_PAIR_DIMENSION::m_ViaGap.

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

aDrill

is the new track width.

Definition at line 483 of file board_design_settings.h.

References m_customDiffPair, and DIFF_PAIR_DIMENSION::m_Width.

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 362 of file board_design_settings.h.

References m_customTrackWidth.

Referenced by BOARD::SynchronizeNetsAndNetClasses(), and DIALOG_TRACK_VIA_SIZE::TransferDataFromWindow().

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 433 of file board_design_settings.h.

References m_customViaSize, and VIA_DIMENSION::m_Drill.

Referenced by BOARD::SynchronizeNetsAndNetClasses(), and DIALOG_TRACK_VIA_SIZE::TransferDataFromWindow().

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 405 of file board_design_settings.h.

References m_customViaSize, and VIA_DIMENSION::m_Diameter.

Referenced by BOARD::SynchronizeNetsAndNetClasses(), and DIALOG_TRACK_VIA_SIZE::TransferDataFromWindow().

SetDefaultMasterPad()

void BOARD_DESIGN_SETTINGS::SetDefaultMasterPad

(

)

Definition at line 1570 of file board_design_settings.cpp.

References PADSTACK::ALL_LAYERS, DEFAULT_PAD_DRILL_DIAMETER_MM, DEFAULT_PAD_HEIGTH_MM, DEFAULT_PAD_RR_RADIUS_RATIO, DEFAULT_PAD_WIDTH_MM, m_Pad_Master, EDA_IU_SCALE::mmToIU(), and pcbIUScale.

Referenced by BOARD_DESIGN_SETTINGS(), and DIALOG_PAD_PROPERTIES::initValues().

SetDefaultZoneSettings()

void BOARD_DESIGN_SETTINGS::SetDefaultZoneSettings ( const ZONE_SETTINGS &  aSettings )

inline

Definition at line 288 of file board_design_settings.h.

References m_defaultZoneSettings.

Referenced by PCB_EDIT_FRAME::Edit_Zone_Params(), PCB_IO_KICAD_LEGACY::loadSETUP(), and GLOBAL_EDIT_TOOL::ZonesManager().

SetDiffPairIndex()

void BOARD_DESIGN_SETTINGS::SetDiffPairIndex

(

unsigned

aIndex

)

Parameters

aIndex

is the diff pair dimensions list index to set.

Definition at line 1393 of file board_design_settings.cpp.

References m_DiffPairDimensionsList, m_diffPairIndex, and m_useCustomDiffPair.

Referenced by 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 1488 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, BASE_SET::set(), and LSET::UserDefinedLayersMask().

Referenced by FOOTPRINT_CHOOSER_FRAME::build3DCanvas(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), and BOARD::SetEnabledLayers().

SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString &  aFilename )

inlineinherited

Definition at line 85 of file json_settings.h.

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 677 of file board_design_settings.h.

References m_gridOrigin.

Referenced by PCB_CONTROL::DoSetGridOrigin(), PCB_IO_KICAD_LEGACY::loadSETUP(), ALTIUM_PCB::Parse(), ALTIUM_PCB::ParseBoard6Data(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), and PCB_BASE_FRAME::SetGridOrigin().

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
aTarget	is the storage destination

Returns

True if set, false if not

Definition at line 749 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
aTarget	is the storage destination

Returns

True if set, false if not

Definition at line 764 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
aTarget	is the storage destination

Returns

True if set, false if not

Definition at line 779 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
aTarget	is the storage destination

Returns

True if set, false if not

Definition at line 734 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by 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 90 of file json_settings.h.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC  aLocation )

inlineinherited

Definition at line 87 of file json_settings.h.

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

SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER *  aManager )

inlineinherited

Definition at line 199 of file json_settings.h.

SetParent()

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

inherited

Definition at line 169 of file nested_settings.cpp.

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

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

SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly )

inlineinherited

Definition at line 93 of file json_settings.h.

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

SetTrackWidthIndex()

void BOARD_DESIGN_SETTINGS::SetTrackWidthIndex

(

unsigned

aIndex

)

Set the current track width list index to aIndex.

Parameters

aIndex

is the track width list index.

Definition at line 1375 of file board_design_settings.cpp.

References m_trackWidthIndex, m_TrackWidthList, and m_useCustomTrackVia.

Referenced by 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 1477 of file board_design_settings.cpp.

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

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

SetViaSizeIndex()

void BOARD_DESIGN_SETTINGS::SetViaSizeIndex

(

unsigned

aIndex

)

Set the current via size list index to aIndex.

Parameters

aIndex

is the via size list index.

Definition at line 1342 of file board_design_settings.cpp.

References m_useCustomTrackVia, m_ViasDimensionsList, and m_viaSizeIndex.

Referenced by 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().

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

Definition at line 381 of file json_settings.cpp.

References JSON_SETTINGS::m_modified, and JSON_SETTINGS::m_params.

Referenced by JSON_SETTINGS::FormatAsString(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), SETTINGS_MANAGER::SaveColorSettings(), JSON_SETTINGS::SaveToFile(), and NESTED_SETTINGS::SaveToFile().

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 547 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 539 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 462 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 454 of file board_design_settings.h.

References m_useCustomTrackVia.

Referenced by BOARD_EDITOR_CONTROL::AutoTrackWidth(), BOARD::BOARD(), 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 320 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 304 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 312 of file board_design_settings.h.

References m_useCustomTrackVia, and m_viaSizeIndex.

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

Member Data Documentation

m_AllowSoldermaskBridgesInFPs

bool BOARD_DESIGN_SETTINGS::m_AllowSoldermaskBridgesInFPs

Definition at line 750 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), initFromOther(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), PANEL_SETUP_MASK_AND_PASTE::TransferDataFromWindow(), and PANEL_SETUP_MASK_AND_PASTE::TransferDataToWindow().

m_auxOrigin

VECTOR2I BOARD_DESIGN_SETTINGS::m_auxOrigin

private

origin for plot exports

Definition at line 809 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 833 of file board_design_settings.h.

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

m_CapVias

bool BOARD_DESIGN_SETTINGS::m_CapVias

Definition at line 761 of file board_design_settings.h.

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

m_CopperEdgeClearance

int BOARD_DESIGN_SETTINGS::m_CopperEdgeClearance

Definition at line 719 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetBiggestClearanceValue(), initFromOther(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), PCB_EDIT_FRAME::OpenProjectFiles(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseDefaults(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), and PANEL_SETUP_CONSTRAINTS::TransferDataToWindow().

m_copperLayerCount

int BOARD_DESIGN_SETTINGS::m_copperLayerCount

private

Number of copper layers for this design.

Definition at line 827 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 756 of file board_design_settings.h.

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

m_CoverViasFront

bool BOARD_DESIGN_SETTINGS::m_CoverViasFront

Definition at line 755 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), 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 326 of file json_settings.h.

Referenced by JSON_SETTINGS::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 320 of file json_settings.h.

Referenced by JSON_SETTINGS::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 837 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 704 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 825 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 820 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 821 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 770 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_BASE_FRAME::CreateNewFootprint(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), 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 848 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 335 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 691 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetCurrentDiffPairGap(), GetCurrentDiffPairViaGap(), GetCurrentDiffPairWidth(), initFromOther(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), SetDiffPairIndex(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataToWindow(), and DIFF_PAIR_MENU::update().

m_diffPairIndex

unsigned BOARD_DESIGN_SETTINGS::m_diffPairIndex

private

Definition at line 816 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 701 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 789 of file board_design_settings.h.

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

m_DimensionExtensionOffset

int BOARD_DESIGN_SETTINGS::m_DimensionExtensionOffset

Definition at line 790 of file board_design_settings.h.

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

m_DimensionKeepTextAligned

bool BOARD_DESIGN_SETTINGS::m_DimensionKeepTextAligned

Definition at line 788 of file board_design_settings.h.

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

m_DimensionPrecision

DIM_PRECISION BOARD_DESIGN_SETTINGS::m_DimensionPrecision

Number of digits after the decimal.

Definition at line 784 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(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), and PANEL_SETUP_DIMENSIONS::TransferDataFromWindow().

m_DimensionSuppressZeroes

bool BOARD_DESIGN_SETTINGS::m_DimensionSuppressZeroes

Definition at line 786 of file board_design_settings.h.

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

m_DimensionTextPosition

DIM_TEXT_POSITION BOARD_DESIGN_SETTINGS::m_DimensionTextPosition

Definition at line 787 of file board_design_settings.h.

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

m_DimensionUnitsFormat

DIM_UNITS_FORMAT BOARD_DESIGN_SETTINGS::m_DimensionUnitsFormat

Definition at line 785 of file board_design_settings.h.

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

m_DimensionUnitsMode

DIM_UNITS_MODE BOARD_DESIGN_SETTINGS::m_DimensionUnitsMode

Definition at line 783 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(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), and PANEL_SETUP_DIMENSIONS::TransferDataFromWindow().

m_DRCEngine

std::shared_ptr<DRC_ENGINE> BOARD_DESIGN_SETTINGS::m_DRCEngine

Definition at line 727 of file board_design_settings.h.

Referenced by BOOST_DATA_TEST_CASE_F(), BOOST_FIXTURE_TEST_CASE(), ZONE_FILLER::buildCopperItemClearances(), ZONE_FILLER::buildThermalSpokes(), PCB_TUNING_PATTERN::CreateNew(), DRAWING_TOOL::DrawVia(), GetBiggestClearanceValue(), PCB_VIA::GetDrillConstraint(), PCB_VIA::GetMinAnnulus(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), BOARD_CONNECTED_ITEM::GetOwnClearance(), PAD::GetOwnClearance(), PCB_TRACK::GetWidthConstraint(), PCB_VIA::GetWidthConstraint(), ROUTER_TOOL::handleLayerSwitch(), PNS_PCBNEW_RULE_RESOLVER::IsNetTieExclusion(), PCBNEW_JOBS_HANDLER::JobExportDrc(), ZONE_FILLER::knockoutThermalReliefs(), PNS_LOG_FILE::Load(), LoadBoard(), NewBoard(), DRAWING_TOOL::PlaceTuningPattern(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), DRC_TOOL::Reset(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), PANEL_SETUP_RULES::TransferDataFromWindow(), PCB_CONTROL::UpdateMessagePanel(), ROUTER_TOOL::updateSizesAfterRouterEvent(), and WriteDRCReport().

m_DrcExclusionComments

std::map<wxString, wxString> BOARD_DESIGN_SETTINGS::m_DrcExclusionComments

Definition at line 730 of file board_design_settings.h.

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

m_DrcExclusions

std::set<wxString> BOARD_DESIGN_SETTINGS::m_DrcExclusions

Definition at line 729 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), BOOST_FIXTURE_TEST_CASE(), DIALOG_DRC::ExcludeMarker(), initFromOther(), DIALOG_DRC::OnDRCItemRClick(), and operator==().

m_DRCSeverities

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

Definition at line 728 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), BOOST_DATA_TEST_CASE_F(), BOOST_FIXTURE_TEST_CASE(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DoCourtyardInvalidTest(), DoCourtyardOverlapTest(), GetSeverity(), PCB_BASE_FRAME::GetSeverity(), Ignore(), initFromOther(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnIgnoredItemRClick(), and operator==().

m_enabledLayers

LSET BOARD_DESIGN_SETTINGS::m_enabledLayers

private

Bit-mask for layer enabling.

Definition at line 831 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 305 of file json_settings.h.

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

m_FillVias

bool BOARD_DESIGN_SETTINGS::m_FillVias

Definition at line 764 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), 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 810 of file board_design_settings.h.

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

m_HasStackup

bool BOARD_DESIGN_SETTINGS::m_HasStackup

Definition at line 803 of file board_design_settings.h.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), initFromOther(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseBoardStackup(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), LENGTH_DELAY_CALCULATION::StackupHeight(), and PANEL_SETUP_BOARD_STACKUP::TransferDataFromWindow().

m_HoleClearance

int BOARD_DESIGN_SETTINGS::m_HoleClearance

Definition at line 720 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DRC_ENGINE::EvalRules(), GetBiggestClearanceValue(), initFromOther(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), DSN::SPECCTRA_DB::makeIMAGE(), operator==(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), and PANEL_SETUP_CONSTRAINTS::TransferDataToWindow().

m_HoleToHoleMin

int BOARD_DESIGN_SETTINGS::m_HoleToHoleMin

Definition at line 721 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetBiggestClearanceValue(), PNS_KICAD_IFACE_BASE::ImportSizes(), initFromOther(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), operator==(), ALTIUM_PCB::ParseRules6Data(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), and PANEL_SETUP_CONSTRAINTS::TransferDataToWindow().

m_internals

std::unique_ptr<JSON_SETTINGS_INTERNALS> JSON_SETTINGS::m_internals

protectedinherited

Definition at line 352 of file json_settings.h.

Referenced by JSON_SETTINGS::At(), JSON_SETTINGS::Contains(), JSON_SETTINGS::FormatAsString(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::Internals(), JSON_SETTINGS::JSON_SETTINGS(), JSON_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromRawFile(), JSON_SETTINGS::Migrate(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::migrateSchema0to1(), NET_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), COMMON_SETTINGS::migrateSchema0to1(), PROJECT_FILE::migrateSchema1To2(), COMMON_SETTINGS::migrateSchema1to2(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema2To3(), NET_SETTINGS::migrateSchema2to3(), PROJECT_FILE::migrateSchema2To3(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema3To4(), NET_SETTINGS::migrateSchema3to4(), COMMON_SETTINGS::migrateSchema3to4(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema4To5(), NET_SETTINGS::migrateSchema4to5(), JSON_SETTINGS::SaveToFile(), NESTED_SETTINGS::SaveToFile(), and JSON_SETTINGS::Set().

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 344 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile(), and PROJECT_FILE::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 308 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile().

m_LineThickness

int BOARD_DESIGN_SETTINGS::m_LineThickness[LAYER_CLASS_COUNT]

Definition at line 776 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), CONVERT_TOOL::CreatePolys(), GetLineThickness(), API_HANDLER_PCB::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(), PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::TransferDataFromWindow(), PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataFromWindow(), and PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataToWindow().

m_location

SETTINGS_LOC JSON_SETTINGS::m_location

protectedinherited

The location of this settings file (.

See also

SETTINGS_LOC)

Definition at line 311 of file json_settings.h.

m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager

protectedinherited

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

Definition at line 347 of file json_settings.h.

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

m_MaxError

int BOARD_DESIGN_SETTINGS::m_MaxError

Definition at line 738 of file board_design_settings.h.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), FEATURES_MANAGER::AddPadShape(), FEATURES_MANAGER::AddShape(), PCB_IO_IPC2581::addShape(), BOARD_ADAPTER::addText(), BOARD_DESIGN_SETTINGS(), EXPORTER_STEP::buildBoard3DShapes(), PAD::BuildEffectivePolygon(), PAD::buildEffectiveShape(), EXPORTER_STEP::buildFootprint3DShapes(), EXPORTER_STEP::buildGraphic3DShape(), ZONE::BuildSmoothedPoly(), ZONE_FILLER::buildThermalSpokes(), EXPORTER_STEP::buildTrack3DShape(), GRAPHICS_CLEANER::CleanupBoard(), TEARDROP_MANAGER::computeAnchorPoints(), TEARDROP_MANAGER::computeCurvedForRectShape(), TEARDROP_MANAGER::computeCurvedForRoundShape(), BOARD::ConvertBrdLayerToPolygonalContours(), FABMASTER::createBoardItems(), BOARD_ADAPTER::createBoardPolygon(), BOARD_ADAPTER::createLayers(), GENCAD_EXPORTER::createPadsShapesSection(), BOARD_ADAPTER::createPadWithMargin(), CONVERT_TOOL::CreatePolys(), TEARDROP_MANAGER::createTeardropMask(), PAD::doCheckPad(), KIGFX::PCB_PAINTER::Draw(), enclosedByAreaFunc(), ZONE_FILLER::fillCopperZone(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), GenerateLayerPoly(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), FEATURES_MANAGER::InitFeatureList(), initFromOther(), DSN::SPECCTRA_DB::makePADSTACK(), CONVERT_TOOL::makePolysFromChainedSegs(), CONVERT_TOOL::makePolysFromClosedGraphics(), CONVERT_TOOL::makePolysFromOpenGraphics(), PAD::MergePrimitivesAsPolygon(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), BRDITEMS_PLOTTER::PlotShape(), PlotStandardLayer(), BRDITEMS_PLOTTER::PlotText(), PAD_TOOL::RecombinePad(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SOLDER_MASK::Run(), PNS_KICAD_IFACE_BASE::syncTextItem(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), and ZONE::TransformSmoothedOutlineToPolygon().

m_MicroViasMinDrill

int BOARD_DESIGN_SETTINGS::m_MicroViasMinDrill

Definition at line 718 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), initFromOther(), DRC_ENGINE::loadImplicitRules(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), and PANEL_SETUP_CONSTRAINTS::TransferDataToWindow().

m_MicroViasMinSize

int BOARD_DESIGN_SETTINGS::m_MicroViasMinSize

Definition at line 717 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), initFromOther(), DRC_ENGINE::loadImplicitRules(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), and PANEL_SETUP_CONSTRAINTS::TransferDataToWindow().

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 350 of file json_settings.h.

Referenced by JSON_SETTINGS::Migrate(), and JSON_SETTINGS::registerMigration().

m_MinClearance

int BOARD_DESIGN_SETTINGS::m_MinClearance

Definition at line 710 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), CADSTAR_PCB_ARCHIVE_LOADER::calculateZonePriorities(), DRC_ENGINE::EvalRules(), GetBiggestClearanceValue(), PNS_KICAD_IFACE_BASE::ImportSizes(), initFromOther(), PCB_IO_EAGLE::LoadBoard(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), operator==(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), ALTIUM_PCB::ParseRules6Data(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), PCB_CONTROL::PlaceCharacteristics(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), and ROUTER_TOOL::updateSizesAfterRouterEvent().

m_MinConn

int BOARD_DESIGN_SETTINGS::m_MinConn

Definition at line 712 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), initFromOther(), DRC_ENGINE::loadImplicitRules(), operator==(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), and PANEL_SETUP_CONSTRAINTS::TransferDataToWindow().

m_MinGrooveWidth

int BOARD_DESIGN_SETTINGS::m_MinGrooveWidth

Definition at line 711 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), initFromOther(), operator==(), DRC_TEST_PROVIDER_CREEPAGE::testCreepage(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), and PANEL_SETUP_CONSTRAINTS::TransferDataToWindow().

m_MinResolvedSpokes

int BOARD_DESIGN_SETTINGS::m_MinResolvedSpokes

Definition at line 723 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), initFromOther(), DRC_ENGINE::loadImplicitRules(), operator==(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), and PANEL_SETUP_CONSTRAINTS::TransferDataToWindow().

m_MinSilkTextHeight

int BOARD_DESIGN_SETTINGS::m_MinSilkTextHeight

Definition at line 724 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), initFromOther(), DRC_ENGINE::loadImplicitRules(), operator==(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), and PANEL_SETUP_CONSTRAINTS::TransferDataToWindow().

m_MinSilkTextThickness

int BOARD_DESIGN_SETTINGS::m_MinSilkTextThickness

Definition at line 725 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), initFromOther(), DRC_ENGINE::loadImplicitRules(), operator==(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), and PANEL_SETUP_CONSTRAINTS::TransferDataToWindow().

m_MinThroughDrill

int BOARD_DESIGN_SETTINGS::m_MinThroughDrill

Definition at line 716 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), ROUTER_TOOL::handleLayerSwitch(), PNS_KICAD_IFACE_BASE::ImportSizes(), initFromOther(), PCB_IO_EAGLE::LoadBoard(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), ALTIUM_PCB::ParseRules6Data(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), PCB_CONTROL::PlaceCharacteristics(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), and PANEL_SETUP_CONSTRAINTS::TransferDataToWindow().

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 332 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile(), JSON_SETTINGS::ReleaseNestedSettings(), JSON_SETTINGS::SaveToFile(), and JSON_SETTINGS::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 317 of file json_settings.h.

Referenced by JSON_SETTINGS::AddNestedSettings(), JSON_SETTINGS::LoadFromFile(), JSON_SETTINGS::ReleaseNestedSettings(), and JSON_SETTINGS::SaveToFile().

m_NetSettings

std::shared_ptr<NET_SETTINGS> BOARD_DESIGN_SETTINGS::m_NetSettings

Definition at line 767 of file board_design_settings.h.

Referenced by GERBER_JOBFILE_WRITER::addJSONDesignRules(), PCB_CONTROL::AppendBoard(), BOARD::BOARD(), BOARD_DESIGN_SETTINGS(), CONNECTIVITY_DATA::Build(), DIALOG_CLEANUP_TRACKS_AND_VIAS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TEARDROPS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), APPEARANCE_CONTROLS::buildNetClassMenu(), NETINFO_ITEM::Clear(), BOARD::ClearProject(), PNS_KICAD_IFACE::createBoardItem(), EVT_GRID_CMD_CELL_CHANGED(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::FromSESSION(), GetCurrentDiffPairGap(), GetCurrentDiffPairViaGap(), GetCurrentDiffPairWidth(), GetCurrentTrackWidth(), GetCurrentViaDrill(), GetCurrentViaSize(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadNet(), GetSmallestClearanceValue(), initFromOther(), PCB_IO_EAGLE::LoadBoard(), PCB_IO_EASYEDA::LoadBoard(), PCB_IO_EAGLE::loadClasses(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), PCB_IO_KICAD_LEGACY::loadNETCLASS(), PCB_IO_KICAD_LEGACY::loadSETUP(), NETINFO_ITEM::NETINFO_ITEM(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), PANEL_SETUP_RULES::onScintillaCharAdded(), operator==(), ALTIUM_PCB::ParseClasses6Data(), PCB_IO_KICAD_SEXPR_PARSER::parseNETCLASS(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), APPEARANCE_CONTROLS::rebuildNets(), NETINFO_ITEM::SetNetClass(), 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 797 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), 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 314 of file json_settings.h.

Referenced by APP_SETTINGS_BASE::addParamsForWindow(), APP_SETTINGS_BASE::APP_SETTINGS_BASE(), BITMAP2CMP_SETTINGS::BITMAP2CMP_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(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), ERC_SETTINGS::ERC_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), GERBVIEW_SETTINGS::GERBVIEW_SETTINGS(), COLOR_SETTINGS::GetDefaultColor(), HTTP_LIB_SETTINGS::HTTP_LIB_SETTINGS(), COLOR_SETTINGS::initFromOther(), JOBSET::JOBSET(), JSON_SETTINGS::JSON_SETTINGS(), KICAD_SETTINGS::KICAD_SETTINGS(), JSON_SETTINGS::Load(), 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(), JSON_SETTINGS::ResetToDefaults(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), JSON_SETTINGS::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SPICE_SETTINGS::SPICE_SETTINGS(), JSON_SETTINGS::Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), TIME_DOMAIN_PARAMETERS::TIME_DOMAIN_PARAMETERS(), TOOLBAR_SETTINGS::TOOLBAR_SETTINGS(), and JSON_SETTINGS::~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 62 of file nested_settings.h.

Referenced by NESTED_SETTINGS::LoadFromFile(), NESTED_SETTINGS::SaveToFile(), NESTED_SETTINGS::SetParent(), ~BOARD_DESIGN_SETTINGS(), COMPONENT_CLASS_SETTINGS::~COMPONENT_CLASS_SETTINGS(), ERC_SETTINGS::~ERC_SETTINGS(), NESTED_SETTINGS::~NESTED_SETTINGS(), NET_SETTINGS::~NET_SETTINGS(), SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS(), and TIME_DOMAIN_PARAMETERS::~TIME_DOMAIN_PARAMETERS().

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 65 of file nested_settings.h.

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

m_PlugViasBack

bool BOARD_DESIGN_SETTINGS::m_PlugViasBack

Definition at line 759 of file board_design_settings.h.

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

m_PlugViasFront

bool BOARD_DESIGN_SETTINGS::m_PlugViasFront

Definition at line 758 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), 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 338 of file json_settings.h.

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

m_schemaVersion

int JSON_SETTINGS::m_schemaVersion

protectedinherited

Version of this settings schema.

Definition at line 341 of file json_settings.h.

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

m_SilkClearance

int BOARD_DESIGN_SETTINGS::m_SilkClearance

Definition at line 722 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), initFromOther(), DRC_ENGINE::loadImplicitRules(), operator==(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), and PANEL_SETUP_CONSTRAINTS::TransferDataToWindow().

m_SingleTrackMeanderSettings

PNS::MEANDER_SETTINGS BOARD_DESIGN_SETTINGS::m_SingleTrackMeanderSettings

Definition at line 700 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 702 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 741 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), KIGFX::PCB_PAINTER::draw(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), PCB_IO_KICAD_SEXPR::formatSetup(), PCB_SHAPE::GetSolderMaskExpansion(), PCB_TRACK::GetSolderMaskExpansion(), initFromOther(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), ALTIUM_PCB::ParseRules6Data(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), DIALOG_PLOT::reInitDialog(), DIALOG_PLOT::SetPlotFormat(), PANEL_SETUP_MASK_AND_PASTE::TransferDataFromWindow(), and PANEL_SETUP_MASK_AND_PASTE::TransferDataToWindow().

m_SolderMaskMinWidth

int BOARD_DESIGN_SETTINGS::m_SolderMaskMinWidth

Definition at line 742 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), GenerateLayerPoly(), initFromOther(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), PlotSolderMaskLayer(), DIALOG_PLOT::reInitDialog(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_SOLDER_MASK::Run(), DIALOG_PLOT::SetPlotFormat(), PANEL_SETUP_MASK_AND_PASTE::TransferDataFromWindow(), and PANEL_SETUP_MASK_AND_PASTE::TransferDataToWindow().

m_SolderMaskToCopperClearance

int BOARD_DESIGN_SETTINGS::m_SolderMaskToCopperClearance

Definition at line 744 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), initFromOther(), operator==(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), PANEL_SETUP_MASK_AND_PASTE::TransferDataFromWindow(), and PANEL_SETUP_MASK_AND_PASTE::TransferDataToWindow().

m_SolderPasteMargin

int BOARD_DESIGN_SETTINGS::m_SolderPasteMargin

Definition at line 747 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), initFromOther(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), ALTIUM_PCB::ParseRules6Data(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), PANEL_SETUP_MASK_AND_PASTE::TransferDataFromWindow(), and PANEL_SETUP_MASK_AND_PASTE::TransferDataToWindow().

m_SolderPasteMarginRatio

double BOARD_DESIGN_SETTINGS::m_SolderPasteMarginRatio

Definition at line 748 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), initFromOther(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), PANEL_SETUP_MASK_AND_PASTE::TransferDataFromWindow(), and PANEL_SETUP_MASK_AND_PASTE::TransferDataToWindow().

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 845 of file board_design_settings.h.

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

m_StyleFPFields

bool BOARD_DESIGN_SETTINGS::m_StyleFPFields

Definition at line 792 of file board_design_settings.h.

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

m_StyleFPShapes

bool BOARD_DESIGN_SETTINGS::m_StyleFPShapes

Definition at line 794 of file board_design_settings.h.

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

m_StyleFPText

bool BOARD_DESIGN_SETTINGS::m_StyleFPText

Definition at line 793 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PANEL_SETUP_FORMATTING::ImportSettingsFrom(), initFromOther(), PCB_BASE_FRAME::loadFootprint(), 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 698 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetTeadropParamsList(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataFromWindow(), and DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataToWindow().

m_TempOverrideTrackWidth

bool BOARD_DESIGN_SETTINGS::m_TempOverrideTrackWidth

Definition at line 708 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 753 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), initFromOther(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), PANEL_SETUP_MASK_AND_PASTE::TransferDataFromWindow(), and PANEL_SETUP_MASK_AND_PASTE::TransferDataToWindow().

m_TentViasFront

bool BOARD_DESIGN_SETTINGS::m_TentViasFront

Definition at line 752 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatSetup(), initFromOther(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), PANEL_SETUP_MASK_AND_PASTE::TransferDataFromWindow(), and PANEL_SETUP_MASK_AND_PASTE::TransferDataToWindow().

m_TextItalic

bool BOARD_DESIGN_SETTINGS::m_TextItalic[LAYER_CLASS_COUNT]

Definition at line 779 of file board_design_settings.h.

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

m_TextSize

VECTOR2I BOARD_DESIGN_SETTINGS::m_TextSize[LAYER_CLASS_COUNT]

Definition at line 777 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetTextSize(), API_HANDLER_PCB::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(), PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::TransferDataFromWindow(), PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataFromWindow(), and PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataToWindow().

m_TextThickness

int BOARD_DESIGN_SETTINGS::m_TextThickness[LAYER_CLASS_COUNT]

Definition at line 778 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetTextThickness(), API_HANDLER_PCB::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(), PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::TransferDataFromWindow(), PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataFromWindow(), and PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataToWindow().

m_TextUpright

bool BOARD_DESIGN_SETTINGS::m_TextUpright[LAYER_CLASS_COUNT]

Definition at line 780 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetTextUpright(), API_HANDLER_PCB::handleGetGraphicsDefaults(), initFromOther(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseDefaultTextDims(), PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataFromWindow(), and PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataToWindow().

m_TrackMinWidth

int BOARD_DESIGN_SETTINGS::m_TrackMinWidth

Definition at line 713 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PNS_KICAD_IFACE_BASE::ImportSizes(), DIALOG_PLOT::init_Dialog(), initFromOther(), PCB_IO_EAGLE::LoadBoard(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), ALTIUM_PCB::ParseRules6Data(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), PCB_CONTROL::PlaceCharacteristics(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), and ROUTER_TOOL::updateSizesAfterRouterEvent().

m_trackWidthIndex

unsigned BOARD_DESIGN_SETTINGS::m_trackWidthIndex

private

Definition at line 814 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 689 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), GetCurrentTrackWidth(), initFromOther(), PCB_IO_KICAD_LEGACY::loadSETUP(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), SetTrackWidthIndex(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataToWindow(), TRACK_WIDTH_MENU::update(), and PCB_EDIT_FRAME::UpdateTrackWidthSelectBox().

m_UseConnectedTrackWidth

bool BOARD_DESIGN_SETTINGS::m_UseConnectedTrackWidth

Definition at line 706 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 824 of file board_design_settings.h.

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

m_useCustomTrackVia

bool BOARD_DESIGN_SETTINGS::m_useCustomTrackVia

private

Definition at line 819 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetCurrentTrackWidth(), GetCurrentViaDrill(), GetCurrentViaSize(), initFromOther(), operator==(), SetTrackWidthIndex(), SetViaSizeIndex(), 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 806 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), LENGTH_DELAY_CALCULATION::CalculateLengthDetails(), initFromOther(), operator==(), PNS_KICAD_IFACE_BASE::StackupHeight(), LENGTH_DELAY_CALCULATION::StackupHeight(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), and PANEL_SETUP_CONSTRAINTS::TransferDataToWindow().

m_userDefinedLayerCount

int BOARD_DESIGN_SETTINGS::m_userDefinedLayerCount

private

Number of user defined layers for this design.

Definition at line 829 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 773 of file board_design_settings.h.

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

m_ViasDimensionsList

std::vector<VIA_DIMENSION> BOARD_DESIGN_SETTINGS::m_ViasDimensionsList

Definition at line 690 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), GetCurrentViaDrill(), GetCurrentViaSize(), initFromOther(), PCB_IO_KICAD_LEGACY::loadSETUP(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), SetViaSizeIndex(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataToWindow(), TRACK_WIDTH_MENU::update(), VIA_SIZE_MENU::update(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), BOARD_EDITOR_CONTROL::ViaSizeDec(), and BOARD_EDITOR_CONTROL::ViaSizeInc().

m_viaSizeIndex

unsigned BOARD_DESIGN_SETTINGS::m_viaSizeIndex

private

Definition at line 815 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 714 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), initFromOther(), PCB_IO_EAGLE::LoadBoard(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), and PANEL_SETUP_CONSTRAINTS::TransferDataToWindow().

m_ViasMinSize

int BOARD_DESIGN_SETTINGS::m_ViasMinSize

Definition at line 715 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), ROUTER_TOOL::handleLayerSwitch(), PNS_KICAD_IFACE_BASE::ImportSizes(), initFromOther(), PCB_IO_EAGLE::LoadBoard(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), PCB_IO_KICAD_LEGACY::loadSETUP(), operator==(), ALTIUM_PCB::ParseRules6Data(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), PCB_CONTROL::PlaceCharacteristics(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), and PANEL_SETUP_CONSTRAINTS::TransferDataToWindow().

m_writeFile

bool JSON_SETTINGS::m_writeFile

protectedinherited

Whether or not the backing store file should be written.

Definition at line 329 of file json_settings.h.

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

m_ZoneKeepExternalFillets

bool BOARD_DESIGN_SETTINGS::m_ZoneKeepExternalFillets

Definition at line 735 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), ZONE::BuildSmoothedPoly(), initFromOther(), LoadFromFile(), operator==(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), and PANEL_SETUP_CONSTRAINTS::TransferDataToWindow().

---

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

• board_design_settings.h
• board_design_settings.cpp