A collection of nets and the parameters used to route or test these nets. More...

#include <netclass.h>

Inheritance diagram for NETCLASS:

Public Member Functions
	NETCLASS (const wxString &aName, bool aInitWithDefaults=true)
	Create a NETCLASS instance with aName.

	~NETCLASS ()

bool	operator== (const NETCLASS &other) const

wxString	GetClass () const

void	Serialize (google::protobuf::Any &aContainer) const override
	Serializes this object to the given Any message.

bool	Deserialize (const google::protobuf::Any &aContainer) override
	Deserializes the given protobuf message into this object.

void	ResetParents ()
	Resets all parent fields to point to this netclass.

void	ResetParameters ()
	Resets all parameters (except Name and Description)

const std::vector< NETCLASS * > &	GetConstituentNetclasses () const
	Gets the netclasses which make up this netclass.

void	SetConstituentNetclasses (std::vector< NETCLASS * > &&constituents)
	Sets the netclasses which make up this netclass.

bool	ContainsNetclassWithName (const wxString &netclass) const
	Determines if the given netclass name is a constituent of this (maybe aggregate) netclass.

bool	IsDefault () const
	@ brief Determines if this is marked as the default netclass

void	SetName (const wxString &aName)
	Set the name of this netclass.

const wxString	GetName () const
	Gets the name of this (maybe aggregate) netclass in a format for internal usage or for export to external tools / netlists.

const wxString	GetHumanReadableName () const
	Gets the consolidated name of this netclass (which may be an aggregate).

const wxString &	GetDescription () const

void	SetDescription (const wxString &aDesc)

bool	HasClearance () const

int	GetClearance () const

std::optional< int >	GetClearanceOpt () const

void	SetClearance (int aClearance)

void	SetClearance (std::optional< int > aClearance)

void	SetClearanceParent (NETCLASS *parent)

NETCLASS *	GetClearanceParent () const

bool	HasTrackWidth () const

int	GetTrackWidth () const

std::optional< int >	GetTrackWidthOpt () const

void	SetTrackWidth (int aWidth)

void	SetTrackWidth (std::optional< int > aWidth)

void	SetTrackWidthParent (NETCLASS *parent)

NETCLASS *	GetTrackWidthParent () const

bool	HasViaDiameter () const

int	GetViaDiameter () const

std::optional< int >	GetViaDiameterOpt () const

void	SetViaDiameter (int aDia)

void	SetViaDiameter (std::optional< int > aDia)

void	SetViaDiameterParent (NETCLASS *parent)

NETCLASS *	GetViaDiameterParent () const

int	HasViaDrill () const

int	GetViaDrill () const

std::optional< int >	GetViaDrillOpt () const

void	SetViaDrill (int aSize)

void	SetViaDrill (std::optional< int > aSize)

void	SetViaDrillParent (NETCLASS *parent)

NETCLASS *	GetViaDrillParent () const

bool	HasuViaDiameter () const

int	GetuViaDiameter () const

std::optional< int >	GetuViaDiameterOpt () const

void	SetuViaDiameter (int aSize)

void	SetuViaDiameter (std::optional< int > aSize)

void	SetuViaDiameterParent (NETCLASS *parent)

NETCLASS *	GetuViaDiameterParent () const

bool	HasuViaDrill () const

int	GetuViaDrill () const

std::optional< int >	GetuViaDrillOpt () const

void	SetuViaDrill (int aSize)

void	SetuViaDrill (std::optional< int > aSize)

void	SetuViaDrillParent (NETCLASS *parent)

NETCLASS *	GetuViaDrillParent () const

bool	HasDiffPairWidth () const

int	GetDiffPairWidth () const

std::optional< int >	GetDiffPairWidthOpt () const

void	SetDiffPairWidth (int aSize)

void	SetDiffPairWidth (std::optional< int > aSize)

void	SetDiffPairWidthParent (NETCLASS *parent)

NETCLASS *	GetDiffPairWidthParent () const

bool	HasDiffPairGap () const

int	GetDiffPairGap () const

std::optional< int >	GetDiffPairGapOpt () const

void	SetDiffPairGap (int aSize)

void	SetDiffPairGap (std::optional< int > aSize)

void	SetDiffPairGapParent (NETCLASS *parent)

NETCLASS *	GetDiffPairGapParent () const

bool	HasDiffPairViaGap () const

int	GetDiffPairViaGap () const

std::optional< int >	GetDiffPairViaGapOpt () const

void	SetDiffPairViaGap (int aSize)

void	SetDiffPairViaGap (std::optional< int > aSize)

void	SetDiffPairViaGapParent (NETCLASS *parent)

NETCLASS *	GetDiffPairViaGapParent () const

bool	HasPcbColor () const

COLOR4D	GetPcbColor (bool aIsForSave=false) const

void	SetPcbColor (const COLOR4D &aColor)

void	SetPcbColorParent (NETCLASS *parent)

NETCLASS *	GetPcbColorParent () const

bool	HasWireWidth () const

int	GetWireWidth () const

std::optional< int >	GetWireWidthOpt () const

void	SetWireWidth (int aWidth)

void	SetWireWidth (std::optional< int > aWidth)

void	SetWireWidthParent (NETCLASS *parent)

NETCLASS *	GetWireWidthParent () const

bool	HasBusWidth () const

int	GetBusWidth () const

std::optional< int >	GetBusWidthOpt () const

void	SetBusWidth (int aWidth)

void	SetBusWidth (std::optional< int > aWidth)

void	SetBusWidthParent (NETCLASS *parent)

NETCLASS *	GetBusWidthParent () const

COLOR4D	GetSchematicColor (bool aIsForSave=false) const

void	SetSchematicColor (COLOR4D aColor)

void	SetSchematicColorParent (NETCLASS *parent)

NETCLASS *	GetSchematicColorParent () const

bool	HasLineStyle () const

int	GetLineStyle () const

std::optional< int >	GetLineStyleOpt () const

void	SetLineStyle (int aStyle)

void	SetLineStyle (std::optional< int > aStyle)

void	SetLineStyleParent (NETCLASS *parent)

NETCLASS *	GetLineStyleParent () const

void	SetPriority (int aPriority)

int	GetPriority () const

bool	HasDelayProfile () const

void	SetDelayProfile (const wxString &aDelayProfile)

wxString	GetDelayProfile () const

void	SetDelayProfileParent (NETCLASS *aParent)

NETCLASS *	GetDelayProfileParent () const

Static Public Attributes
static const char	Default [] = "Default"
	the name of the default NETCLASS

Protected Attributes
bool	m_isDefault
	Mark if this instance is the default netclass.

std::vector< NETCLASS * >	m_constituents
	NETCLASSes contributing to an aggregate.

wxString	m_Name
	Name of the net class.

int	m_Priority
	The priority for multiple netclass resolution.

wxString	m_Description
	what this NETCLASS is for.

std::optional< int >	m_Clearance
	clearance when routing

std::optional< int >	m_TrackWidth
	track width used to route nets

std::optional< int >	m_ViaDia
	via diameter

std::optional< int >	m_ViaDrill
	via drill hole diameter

std::optional< int >	m_uViaDia
	microvia diameter

std::optional< int >	m_uViaDrill
	microvia drill hole diameter

std::optional< int >	m_diffPairWidth

std::optional< int >	m_diffPairGap

std::optional< int >	m_diffPairViaGap

std::optional< int >	m_wireWidth

std::optional< int >	m_busWidth

COLOR4D	m_schematicColor

std::optional< int >	m_lineStyle

COLOR4D	m_pcbColor
	Optional PCB color override for this netclass.

wxString	m_DelayProfile
	The tuning profile name being used by this netclass.

NETCLASS *	m_clearanceParent

NETCLASS *	m_trackWidthParent

NETCLASS *	m_viaDiameterParent

NETCLASS *	m_viaDrillParent

NETCLASS *	m_uViaDiaParent

NETCLASS *	m_uViaDrillParent

NETCLASS *	m_diffPairWidthParent

NETCLASS *	m_diffPairGapParent

NETCLASS *	m_diffPairViaGapParent

NETCLASS *	m_pcbColorParent

NETCLASS *	m_wireWidthParent

NETCLASS *	m_busWidthParent

NETCLASS *	m_schematicColorParent

NETCLASS *	m_lineStyleParent

NETCLASS *	m_delayProfileParent

Detailed Description

A collection of nets and the parameters used to route or test these nets.

Definition at line 44 of file netclass.h.

Constructor & Destructor Documentation

◆ NETCLASS()

NETCLASS::NETCLASS	(	const wxString &	aName,
		bool	aInitWithDefaults = `true`
	)

Create a NETCLASS instance with aName.

The units on the optional parameters are Internal Units (1 nm)

Parameters

aName	is the name of this new netclass.
aInitWithDefaults	if true, initalise the netclass with default values

Definition at line 56 of file netclass.cpp.

References DEFAULT_BUS_WIDTH, DEFAULT_CLEARANCE, DEFAULT_DIFF_PAIR_GAP, DEFAULT_DIFF_PAIR_VIAGAP, DEFAULT_DIFF_PAIR_WIDTH, DEFAULT_LINE_STYLE, DEFAULT_TRACK_WIDTH, DEFAULT_UVIA_DIAMETER, DEFAULT_UVIA_DRILL, DEFAULT_VIA_DIAMETER, DEFAULT_VIA_DRILL, DEFAULT_WIRE_WIDTH, m_constituents, ResetParents(), SetBusWidth(), SetClearance(), SetDelayProfile(), SetDiffPairGap(), SetDiffPairViaGap(), SetDiffPairWidth(), SetLineStyle(), SetName(), SetPcbColor(), SetPriority(), SetSchematicColor(), SetTrackWidth(), SetuViaDiameter(), SetuViaDrill(), SetViaDiameter(), SetViaDrill(), and SetWireWidth().

◆ ~NETCLASS()

NETCLASS::~NETCLASS ( )

inline

Definition at line 57 of file netclass.h.

Member Function Documentation

◆ ContainsNetclassWithName()

bool NETCLASS::ContainsNetclassWithName ( const wxString & netclass ) const

Determines if the given netclass name is a constituent of this (maybe aggregate) netclass.

Definition at line 284 of file netclass.cpp.

References m_constituents.

Referenced by PCBEXPR_NETCLASS_VALUE::EqualTo(), hasNetclassFunc(), PCBEXPR_NETCLASS_VALUE::NotEqualTo(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ Deserialize()

bool NETCLASS::Deserialize ( const google::protobuf::Any & aContainer )

overridevirtual

Deserializes the given protobuf message into this object.

Parameters

aContainer is an Any which should have a concrete type matching this object

Returns: true if unpacking and deserialization succeeded

Reimplemented from SERIALIZABLE.

Definition at line 208 of file netclass.cpp.

References m_busWidth, m_Clearance, m_DelayProfile, m_diffPairGap, m_diffPairViaGap, m_diffPairWidth, m_Name, m_pcbColor, m_Priority, m_schematicColor, m_TrackWidth, m_ViaDia, m_ViaDrill, m_wireWidth, and SetConstituentNetclasses().

◆ GetBusWidth()

int NETCLASS::GetBusWidth ( ) const

inline

Definition at line 209 of file netclass.h.

Referenced by NET_SETTINGS::makeEffectiveNetclass().

◆ GetBusWidthOpt()

std::optional< int > NETCLASS::GetBusWidthOpt ( ) const

inline

Definition at line 210 of file netclass.h.

◆ GetBusWidthParent()

NETCLASS * NETCLASS::GetBusWidthParent ( ) const

inline

Definition at line 214 of file netclass.h.

◆ GetClass()

wxString NETCLASS::GetClass ( ) const

inline

Definition at line 61 of file netclass.h.

◆ GetClearance()

int NETCLASS::GetClearance ( ) const

inline

Definition at line 114 of file netclass.h.

Referenced by DSN::SPECCTRA_DB::exportNETCLASS(), and NET_SETTINGS::makeEffectiveNetclass().

◆ GetClearanceOpt()

std::optional< int > NETCLASS::GetClearanceOpt ( ) const

inline

Definition at line 115 of file netclass.h.

◆ GetClearanceParent()

NETCLASS * NETCLASS::GetClearanceParent ( ) const

inline

Definition at line 119 of file netclass.h.

◆ GetConstituentNetclasses()

const std::vector< NETCLASS * > & NETCLASS::GetConstituentNetclasses ( ) const

Gets the netclasses which make up this netclass.

Definition at line 272 of file netclass.cpp.

References m_constituents.

◆ GetDelayProfile()

wxString NETCLASS::GetDelayProfile ( ) const

inline

Definition at line 243 of file netclass.h.

Referenced by TIME_DOMAIN_PARAMETERS_USER_DEFINED::CalculatePropagationDelayForShapeLineChain(), TIME_DOMAIN_PARAMETERS_USER_DEFINED::GetPropagationDelay(), TIME_DOMAIN_PARAMETERS_USER_DEFINED::GetTrackLengthForPropagationDelay(), and NET_SETTINGS::makeEffectiveNetclass().

◆ GetDelayProfileParent()

NETCLASS * NETCLASS::GetDelayProfileParent ( ) const

inline

Definition at line 245 of file netclass.h.

◆ GetDescription()

const wxString & NETCLASS::GetDescription ( ) const

inline

Definition at line 110 of file netclass.h.

◆ GetDiffPairGap()

int NETCLASS::GetDiffPairGap ( ) const

inline

Definition at line 170 of file netclass.h.

Referenced by NET_SETTINGS::makeEffectiveNetclass().

◆ GetDiffPairGapOpt()

std::optional< int > NETCLASS::GetDiffPairGapOpt ( ) const

inline

Definition at line 171 of file netclass.h.

◆ GetDiffPairGapParent()

NETCLASS * NETCLASS::GetDiffPairGapParent ( ) const

inline

Definition at line 175 of file netclass.h.

◆ GetDiffPairViaGap()

int NETCLASS::GetDiffPairViaGap ( ) const

inline

Definition at line 178 of file netclass.h.

Referenced by NET_SETTINGS::makeEffectiveNetclass().

◆ GetDiffPairViaGapOpt()

std::optional< int > NETCLASS::GetDiffPairViaGapOpt ( ) const

inline

Definition at line 179 of file netclass.h.

◆ GetDiffPairViaGapParent()

NETCLASS * NETCLASS::GetDiffPairViaGapParent ( ) const

inline

Definition at line 183 of file netclass.h.

◆ GetDiffPairWidth()

int NETCLASS::GetDiffPairWidth ( ) const

inline

Definition at line 162 of file netclass.h.

Referenced by NET_SETTINGS::makeEffectiveNetclass().

◆ GetDiffPairWidthOpt()

std::optional< int > NETCLASS::GetDiffPairWidthOpt ( ) const

inline

Definition at line 163 of file netclass.h.

◆ GetDiffPairWidthParent()

NETCLASS * NETCLASS::GetDiffPairWidthParent ( ) const

inline

Definition at line 167 of file netclass.h.

◆ GetHumanReadableName()

const wxString NETCLASS::GetHumanReadableName ( ) const

Gets the consolidated name of this netclass (which may be an aggregate).

This is intended for display to users (e.g. in infobars or messages). WARNING: Do not use this to compare equivalence, or to export to other tools)

Definition at line 294 of file netclass.cpp.

References _, GetName(), m_constituents, m_Name, and name.

Referenced by BOARD_INSPECTION_TOOL::getItemDescription(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::LIST_ITEM(), and ROUTER_TOOL::UpdateMessagePanel().

◆ GetLineStyle()

int NETCLASS::GetLineStyle ( ) const

inline

Definition at line 231 of file netclass.h.

Referenced by NET_SETTINGS::makeEffectiveNetclass().

◆ GetLineStyleOpt()

std::optional< int > NETCLASS::GetLineStyleOpt ( ) const

inline

Definition at line 232 of file netclass.h.

◆ GetLineStyleParent()

NETCLASS * NETCLASS::GetLineStyleParent ( ) const

inline

Definition at line 236 of file netclass.h.

◆ GetName()

const wxString NETCLASS::GetName ( ) const

Gets the name of this (maybe aggregate) netclass in a format for internal usage or for export to external tools / netlists.

WARNING: Do not use this to display a netclass name to a user. Use GetHumanReadableName instead.

Definition at line 322 of file netclass.cpp.

References m_constituents, m_Name, and name.

Referenced by PCBEXPR_NETCLASS_VALUE::AsString(), PCBEXPR_NETCLASS_VALUE::EqualTo(), DSN::SPECCTRA_DB::exportNETCLASS(), DSN::SPECCTRA_DB::FromBOARD(), GetHumanReadableName(), BOARD_CONNECTED_ITEM::GetNetClassName(), NETS_SEARCH_HANDLER::getResultCell(), RATSNEST_SEARCH_HANDLER::getResultCell(), API_HANDLER_PCB::handleGetNets(), PCB_NET_INSPECTOR_PANEL::netFilterMatches(), PCBEXPR_NETCLASS_VALUE::NotEqualTo(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataToWindow(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow().

◆ GetPcbColor()

COLOR4D NETCLASS::GetPcbColor ( bool aIsForSave = false ) const

inline

Definition at line 186 of file netclass.h.

References KIGFX::COLOR4D::UNSPECIFIED.

Referenced by PNS_KICAD_IFACE::DisplayRatline(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NET_SETTINGS::makeEffectiveNetclass(), and RATSNEST_VIEW_ITEM::ViewDraw().

◆ GetPcbColorParent()

NETCLASS * NETCLASS::GetPcbColorParent ( ) const

inline

Definition at line 198 of file netclass.h.

◆ GetPriority()

int NETCLASS::GetPriority ( ) const

inline

Definition at line 239 of file netclass.h.

◆ GetSchematicColor()

COLOR4D NETCLASS::GetSchematicColor ( bool aIsForSave = false ) const

inline

Definition at line 216 of file netclass.h.

References KIGFX::COLOR4D::UNSPECIFIED.

Referenced by NET_SETTINGS::makeEffectiveNetclass().

◆ GetSchematicColorParent()

NETCLASS * NETCLASS::GetSchematicColorParent ( ) const

inline

Definition at line 228 of file netclass.h.

◆ GetTrackWidth()

int NETCLASS::GetTrackWidth ( ) const

inline

Definition at line 122 of file netclass.h.

Referenced by DSN::SPECCTRA_DB::exportNETCLASS(), PCB_IO_EAGLE::LoadBoard(), and NET_SETTINGS::makeEffectiveNetclass().

◆ GetTrackWidthOpt()

std::optional< int > NETCLASS::GetTrackWidthOpt ( ) const

inline

Definition at line 123 of file netclass.h.

◆ GetTrackWidthParent()

NETCLASS * NETCLASS::GetTrackWidthParent ( ) const

inline

Definition at line 127 of file netclass.h.

◆ GetuViaDiameter()

int NETCLASS::GetuViaDiameter ( ) const

inline

Definition at line 146 of file netclass.h.

Referenced by EDIT_TOOL::ChangeTrackWidth(), NET_SETTINGS::makeEffectiveNetclass(), and PCB_EDIT_FRAME::SetTrackSegmentWidth().

◆ GetuViaDiameterOpt()

std::optional< int > NETCLASS::GetuViaDiameterOpt ( ) const

inline

Definition at line 147 of file netclass.h.

◆ GetuViaDiameterParent()

NETCLASS * NETCLASS::GetuViaDiameterParent ( ) const

inline

Definition at line 151 of file netclass.h.

◆ GetuViaDrill()

int NETCLASS::GetuViaDrill ( ) const

inline

Definition at line 154 of file netclass.h.

Referenced by EDIT_TOOL::ChangeTrackWidth(), PCB_VIA::GetDrillValue(), NET_SETTINGS::makeEffectiveNetclass(), and PCB_EDIT_FRAME::SetTrackSegmentWidth().

◆ GetuViaDrillOpt()

std::optional< int > NETCLASS::GetuViaDrillOpt ( ) const

inline

Definition at line 155 of file netclass.h.

◆ GetuViaDrillParent()

NETCLASS * NETCLASS::GetuViaDrillParent ( ) const

inline

Definition at line 159 of file netclass.h.

◆ GetViaDiameter()

int NETCLASS::GetViaDiameter ( ) const

inline

Definition at line 130 of file netclass.h.

Referenced by DSN::SPECCTRA_DB::exportNETCLASS(), PCB_IO_EAGLE::LoadBoard(), and NET_SETTINGS::makeEffectiveNetclass().

◆ GetViaDiameterOpt()

std::optional< int > NETCLASS::GetViaDiameterOpt ( ) const

inline

Definition at line 131 of file netclass.h.

◆ GetViaDiameterParent()

NETCLASS * NETCLASS::GetViaDiameterParent ( ) const

inline

Definition at line 135 of file netclass.h.

◆ GetViaDrill()

int NETCLASS::GetViaDrill ( ) const

inline

Definition at line 138 of file netclass.h.

Referenced by DSN::SPECCTRA_DB::exportNETCLASS(), PCB_VIA::GetDrillValue(), PCB_IO_EAGLE::LoadBoard(), and NET_SETTINGS::makeEffectiveNetclass().

◆ GetViaDrillOpt()

std::optional< int > NETCLASS::GetViaDrillOpt ( ) const

inline

Definition at line 139 of file netclass.h.

◆ GetViaDrillParent()

NETCLASS * NETCLASS::GetViaDrillParent ( ) const

inline

Definition at line 143 of file netclass.h.

◆ GetWireWidth()

int NETCLASS::GetWireWidth ( ) const

inline

Definition at line 201 of file netclass.h.

Referenced by NET_SETTINGS::makeEffectiveNetclass().

◆ GetWireWidthOpt()

std::optional< int > NETCLASS::GetWireWidthOpt ( ) const

inline

Definition at line 202 of file netclass.h.

◆ GetWireWidthParent()

NETCLASS * NETCLASS::GetWireWidthParent ( ) const

inline

Definition at line 206 of file netclass.h.

◆ HasBusWidth()

bool NETCLASS::HasBusWidth ( ) const

inline

Definition at line 208 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and NET_SETTINGS::makeEffectiveNetclass().

◆ HasClearance()

bool NETCLASS::HasClearance ( ) const

inline

Definition at line 113 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and NET_SETTINGS::makeEffectiveNetclass().

◆ HasDelayProfile()

bool NETCLASS::HasDelayProfile ( ) const

inline

Definition at line 241 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), NET_SETTINGS::makeEffectiveNetclass(), and Serialize().

◆ HasDiffPairGap()

bool NETCLASS::HasDiffPairGap ( ) const

inline

Definition at line 169 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and NET_SETTINGS::makeEffectiveNetclass().

◆ HasDiffPairViaGap()

bool NETCLASS::HasDiffPairViaGap ( ) const

inline

Definition at line 177 of file netclass.h.

Referenced by NET_SETTINGS::makeEffectiveNetclass().

◆ HasDiffPairWidth()

bool NETCLASS::HasDiffPairWidth ( ) const

inline

Definition at line 161 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and NET_SETTINGS::makeEffectiveNetclass().

◆ HasLineStyle()

bool NETCLASS::HasLineStyle ( ) const

inline

Definition at line 230 of file netclass.h.

Referenced by NET_SETTINGS::makeEffectiveNetclass().

◆ HasPcbColor()

bool NETCLASS::HasPcbColor ( ) const

inline

Definition at line 185 of file netclass.h.

References KIGFX::COLOR4D::UNSPECIFIED.

Referenced by PNS_KICAD_IFACE::DisplayRatline(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), and RATSNEST_VIEW_ITEM::ViewDraw().

◆ HasTrackWidth()

bool NETCLASS::HasTrackWidth ( ) const

inline

Definition at line 121 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and NET_SETTINGS::makeEffectiveNetclass().

◆ HasuViaDiameter()

bool NETCLASS::HasuViaDiameter ( ) const

inline

Definition at line 145 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and NET_SETTINGS::makeEffectiveNetclass().

◆ HasuViaDrill()

bool NETCLASS::HasuViaDrill ( ) const

inline

Definition at line 153 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and NET_SETTINGS::makeEffectiveNetclass().

◆ HasViaDiameter()

bool NETCLASS::HasViaDiameter ( ) const

inline

Definition at line 129 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and NET_SETTINGS::makeEffectiveNetclass().

◆ HasViaDrill()

int NETCLASS::HasViaDrill ( ) const

inline

Definition at line 137 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and NET_SETTINGS::makeEffectiveNetclass().

◆ HasWireWidth()

bool NETCLASS::HasWireWidth ( ) const

inline

Definition at line 200 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and NET_SETTINGS::makeEffectiveNetclass().

◆ IsDefault()

bool NETCLASS::IsDefault ( ) const

inline

@ brief Determines if this is marked as the default netclass

Definition at line 88 of file netclass.h.

◆ operator==()

bool NETCLASS::operator== ( const NETCLASS & other ) const

Definition at line 130 of file netclass.cpp.

References m_constituents.

◆ ResetParameters()

void NETCLASS::ResetParameters ( )

Resets all parameters (except Name and Description)

Definition at line 109 of file netclass.cpp.

References ResetParents(), SetBusWidth(), SetClearance(), SetDiffPairGap(), SetDiffPairViaGap(), SetDiffPairWidth(), SetLineStyle(), SetPcbColor(), SetSchematicColor(), SetTrackWidth(), SetuViaDiameter(), SetuViaDrill(), SetViaDiameter(), SetViaDrill(), and SetWireWidth().

◆ ResetParents()

void NETCLASS::ResetParents ( )

Resets all parent fields to point to this netclass.

Definition at line 89 of file netclass.cpp.

References SetBusWidthParent(), SetClearanceParent(), SetDelayProfileParent(), SetDiffPairGapParent(), SetDiffPairViaGapParent(), SetDiffPairWidthParent(), SetLineStyleParent(), SetPcbColorParent(), SetSchematicColorParent(), SetTrackWidthParent(), SetuViaDiameterParent(), SetuViaDrillParent(), SetViaDiameterParent(), SetViaDrillParent(), and SetWireWidthParent().

Referenced by NETCLASS(), and ResetParameters().

◆ Serialize()

void NETCLASS::Serialize ( google::protobuf::Any & aContainer ) const

overridevirtual

Serializes this object to the given Any message.

The Any message's concrete type will be specific to the object in question.

Parameters

aContainer will be filled with a message describing this object

Reimplemented from SERIALIZABLE.

Definition at line 136 of file netclass.cpp.

References HasDelayProfile(), m_busWidth, m_Clearance, m_constituents, m_DelayProfile, m_diffPairGap, m_diffPairViaGap, m_diffPairWidth, m_lineStyle, m_Name, m_pcbColor, m_Priority, m_schematicColor, m_TrackWidth, m_ViaDia, m_ViaDrill, and m_wireWidth.

Referenced by API_HANDLER_PCB::handleGetNetClassForNets().

◆ SetBusWidth() [1/2]

void NETCLASS::SetBusWidth ( int aWidth )

inline

Definition at line 211 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), NETCLASS(), and ResetParameters().

◆ SetBusWidth() [2/2]

void NETCLASS::SetBusWidth ( std::optional< int > aWidth )

inline

Definition at line 212 of file netclass.h.

◆ SetBusWidthParent()

void NETCLASS::SetBusWidthParent ( NETCLASS * parent )

inline

Definition at line 213 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and ResetParents().

◆ SetClearance() [1/2]

void NETCLASS::SetClearance ( int aClearance )

inline

Definition at line 116 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), NET_SETTINGS::makeEffectiveNetclass(), NETCLASS(), and ResetParameters().

◆ SetClearance() [2/2]

void NETCLASS::SetClearance ( std::optional< int > aClearance )

inline

Definition at line 117 of file netclass.h.

◆ SetClearanceParent()

void NETCLASS::SetClearanceParent ( NETCLASS * parent )

inline

Definition at line 118 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and ResetParents().

◆ SetConstituentNetclasses()

void NETCLASS::SetConstituentNetclasses ( std::vector< NETCLASS * > && constituents )

Sets the netclasses which make up this netclass.

Definition at line 278 of file netclass.cpp.

References m_constituents.

Referenced by Deserialize().

◆ SetDelayProfile()

void NETCLASS::SetDelayProfile ( const wxString & aDelayProfile )

inline

Definition at line 242 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and NETCLASS().

◆ SetDelayProfileParent()

void NETCLASS::SetDelayProfileParent ( NETCLASS * aParent )

inline

Definition at line 244 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and ResetParents().

◆ SetDescription()

void NETCLASS::SetDescription ( const wxString & aDesc )

inline

Definition at line 111 of file netclass.h.

◆ SetDiffPairGap() [1/2]

void NETCLASS::SetDiffPairGap ( int aSize )

inline

Definition at line 172 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), NETCLASS(), and ResetParameters().

◆ SetDiffPairGap() [2/2]

void NETCLASS::SetDiffPairGap ( std::optional< int > aSize )

inline

Definition at line 173 of file netclass.h.

◆ SetDiffPairGapParent()

void NETCLASS::SetDiffPairGapParent ( NETCLASS * parent )

inline

Definition at line 174 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and ResetParents().

◆ SetDiffPairViaGap() [1/2]

void NETCLASS::SetDiffPairViaGap ( int aSize )

inline

Definition at line 180 of file netclass.h.

Referenced by NETCLASS(), and ResetParameters().

◆ SetDiffPairViaGap() [2/2]

void NETCLASS::SetDiffPairViaGap ( std::optional< int > aSize )

inline

Definition at line 181 of file netclass.h.

◆ SetDiffPairViaGapParent()

void NETCLASS::SetDiffPairViaGapParent ( NETCLASS * parent )

inline

Definition at line 182 of file netclass.h.

Referenced by ResetParents().

◆ SetDiffPairWidth() [1/2]

void NETCLASS::SetDiffPairWidth ( int aSize )

inline

Definition at line 164 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), NETCLASS(), and ResetParameters().

◆ SetDiffPairWidth() [2/2]

void NETCLASS::SetDiffPairWidth ( std::optional< int > aSize )

inline

Definition at line 165 of file netclass.h.

◆ SetDiffPairWidthParent()

void NETCLASS::SetDiffPairWidthParent ( NETCLASS * parent )

inline

Definition at line 166 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and ResetParents().

◆ SetLineStyle() [1/2]

void NETCLASS::SetLineStyle ( int aStyle )

inline

Definition at line 233 of file netclass.h.

Referenced by NETCLASS(), and ResetParameters().

◆ SetLineStyle() [2/2]

void NETCLASS::SetLineStyle ( std::optional< int > aStyle )

inline

Definition at line 234 of file netclass.h.

◆ SetLineStyleParent()

void NETCLASS::SetLineStyleParent ( NETCLASS * parent )

inline

Definition at line 235 of file netclass.h.

Referenced by ResetParents().

◆ SetName()

void NETCLASS::SetName ( const wxString & aName )

inline

Set the name of this netclass.

Only relevant for root netclasses (i.e. those which are not an aggregate)

Definition at line 92 of file netclass.h.

Referenced by NETCLASS().

◆ SetPcbColor()

void NETCLASS::SetPcbColor ( const COLOR4D & aColor )

inline

Definition at line 196 of file netclass.h.

Referenced by NETCLASS(), and ResetParameters().

◆ SetPcbColorParent()

void NETCLASS::SetPcbColorParent ( NETCLASS * parent )

inline

Definition at line 197 of file netclass.h.

Referenced by ResetParents().

◆ SetPriority()

void NETCLASS::SetPriority ( int aPriority )

inline

Definition at line 238 of file netclass.h.

Referenced by NETCLASS().

◆ SetSchematicColor()

void NETCLASS::SetSchematicColor ( COLOR4D aColor )

inline

Definition at line 226 of file netclass.h.

Referenced by NETCLASS(), and ResetParameters().

◆ SetSchematicColorParent()

void NETCLASS::SetSchematicColorParent ( NETCLASS * parent )

inline

Definition at line 227 of file netclass.h.

Referenced by ResetParents().

◆ SetTrackWidth() [1/2]

void NETCLASS::SetTrackWidth ( int aWidth )

inline

Definition at line 124 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), NETCLASS(), and ResetParameters().

◆ SetTrackWidth() [2/2]

void NETCLASS::SetTrackWidth ( std::optional< int > aWidth )

inline

Definition at line 125 of file netclass.h.

◆ SetTrackWidthParent()

void NETCLASS::SetTrackWidthParent ( NETCLASS * parent )

inline

Definition at line 126 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and ResetParents().

◆ SetuViaDiameter() [1/2]

void NETCLASS::SetuViaDiameter ( int aSize )

inline

Definition at line 148 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), NETCLASS(), and ResetParameters().

◆ SetuViaDiameter() [2/2]

void NETCLASS::SetuViaDiameter ( std::optional< int > aSize )

inline

Definition at line 149 of file netclass.h.

◆ SetuViaDiameterParent()

void NETCLASS::SetuViaDiameterParent ( NETCLASS * parent )

inline

Definition at line 150 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and ResetParents().

◆ SetuViaDrill() [1/2]

void NETCLASS::SetuViaDrill ( int aSize )

inline

Definition at line 156 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), NETCLASS(), and ResetParameters().

◆ SetuViaDrill() [2/2]

void NETCLASS::SetuViaDrill ( std::optional< int > aSize )

inline

Definition at line 157 of file netclass.h.

◆ SetuViaDrillParent()

void NETCLASS::SetuViaDrillParent ( NETCLASS * parent )

inline

Definition at line 158 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and ResetParents().

◆ SetViaDiameter() [1/2]

void NETCLASS::SetViaDiameter ( int aDia )

inline

Definition at line 132 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), NETCLASS(), and ResetParameters().

◆ SetViaDiameter() [2/2]

void NETCLASS::SetViaDiameter ( std::optional< int > aDia )

inline

Definition at line 133 of file netclass.h.

◆ SetViaDiameterParent()

void NETCLASS::SetViaDiameterParent ( NETCLASS * parent )

inline

Definition at line 134 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and ResetParents().

◆ SetViaDrill() [1/2]

void NETCLASS::SetViaDrill ( int aSize )

inline

Definition at line 140 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), NETCLASS(), and ResetParameters().

◆ SetViaDrill() [2/2]

void NETCLASS::SetViaDrill ( std::optional< int > aSize )

inline

Definition at line 141 of file netclass.h.

◆ SetViaDrillParent()

void NETCLASS::SetViaDrillParent ( NETCLASS * parent )

inline

Definition at line 142 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and ResetParents().

◆ SetWireWidth() [1/2]

void NETCLASS::SetWireWidth ( int aWidth )

inline

Definition at line 203 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), NETCLASS(), and ResetParameters().

◆ SetWireWidth() [2/2]

void NETCLASS::SetWireWidth ( std::optional< int > aWidth )

inline

Definition at line 204 of file netclass.h.

◆ SetWireWidthParent()

void NETCLASS::SetWireWidthParent ( NETCLASS * parent )

inline

Definition at line 205 of file netclass.h.

Referenced by NET_SETTINGS::addMissingDefaults(), and ResetParents().

Member Data Documentation

◆ Default

const char NETCLASS::Default = "Default"

static

the name of the default NETCLASS

Definition at line 47 of file netclass.h.

Referenced by BOARD::BOARD(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DSN::SPECCTRA_DB::exportNETCLASS(), DSN::SPECCTRA_DB::FromBOARD(), NET_SETTINGS::GetEffectiveNetClass(), NET_SETTINGS::migrateSchema3to4(), NET_SETTINGS::NET_SETTINGS(), APPEARANCE_CONTROLS::onNetclassContextMenu(), PANEL_SETUP_NETCLASSES::OnRemoveNetclassClick(), and NET_SETTINGS::RecomputeEffectiveNetclasses().

◆ m_busWidth

std::optional<int> NETCLASS::m_busWidth

protected

Definition at line 270 of file netclass.h.

Referenced by Deserialize(), and Serialize().

◆ m_busWidthParent

NETCLASS* NETCLASS::m_busWidthParent

protected

Definition at line 290 of file netclass.h.

◆ m_Clearance

std::optional<int> NETCLASS::m_Clearance

protected

clearance when routing

Definition at line 256 of file netclass.h.

Referenced by Deserialize(), and Serialize().

◆ m_clearanceParent

NETCLASS* NETCLASS::m_clearanceParent

protected

Definition at line 279 of file netclass.h.

◆ m_constituents

std::vector<NETCLASS*> NETCLASS::m_constituents

protected

NETCLASSes contributing to an aggregate.

Definition at line 250 of file netclass.h.

Referenced by ContainsNetclassWithName(), GetConstituentNetclasses(), GetHumanReadableName(), GetName(), NETCLASS(), operator==(), Serialize(), and SetConstituentNetclasses().

◆ m_DelayProfile

wxString NETCLASS::m_DelayProfile

protected

The tuning profile name being used by this netclass.

Definition at line 276 of file netclass.h.

Referenced by Deserialize(), and Serialize().

◆ m_delayProfileParent

NETCLASS* NETCLASS::m_delayProfileParent

protected

Definition at line 293 of file netclass.h.

◆ m_Description

wxString NETCLASS::m_Description

protected

what this NETCLASS is for.

Definition at line 254 of file netclass.h.

◆ m_diffPairGap

std::optional<int> NETCLASS::m_diffPairGap

protected

Definition at line 266 of file netclass.h.

Referenced by Deserialize(), and Serialize().

◆ m_diffPairGapParent

NETCLASS* NETCLASS::m_diffPairGapParent

protected

Definition at line 286 of file netclass.h.

◆ m_diffPairViaGap

std::optional<int> NETCLASS::m_diffPairViaGap

protected

Definition at line 267 of file netclass.h.

Referenced by Deserialize(), and Serialize().

◆ m_diffPairViaGapParent

NETCLASS* NETCLASS::m_diffPairViaGapParent

protected

Definition at line 287 of file netclass.h.

◆ m_diffPairWidth

std::optional<int> NETCLASS::m_diffPairWidth

protected

Definition at line 265 of file netclass.h.

Referenced by Deserialize(), and Serialize().

◆ m_diffPairWidthParent

NETCLASS* NETCLASS::m_diffPairWidthParent

protected

Definition at line 285 of file netclass.h.

◆ m_isDefault

bool NETCLASS::m_isDefault

protected

Mark if this instance is the default netclass.

Definition at line 248 of file netclass.h.

◆ m_lineStyle

std::optional<int> NETCLASS::m_lineStyle

protected

Definition at line 272 of file netclass.h.

Referenced by Serialize().

◆ m_lineStyleParent

NETCLASS* NETCLASS::m_lineStyleParent

protected

Definition at line 292 of file netclass.h.

◆ m_Name

wxString NETCLASS::m_Name

protected

Name of the net class.

Definition at line 252 of file netclass.h.

Referenced by Deserialize(), GetHumanReadableName(), GetName(), and Serialize().

◆ m_pcbColor

COLOR4D NETCLASS::m_pcbColor

protected

Optional PCB color override for this netclass.

Definition at line 274 of file netclass.h.

Referenced by Deserialize(), and Serialize().

◆ m_pcbColorParent

NETCLASS* NETCLASS::m_pcbColorParent

protected

Definition at line 288 of file netclass.h.

◆ m_Priority

int NETCLASS::m_Priority

protected

The priority for multiple netclass resolution.

Definition at line 253 of file netclass.h.

Referenced by Deserialize(), and Serialize().

◆ m_schematicColor

COLOR4D NETCLASS::m_schematicColor

protected

Definition at line 271 of file netclass.h.

Referenced by Deserialize(), and Serialize().

◆ m_schematicColorParent

NETCLASS* NETCLASS::m_schematicColorParent

protected

Definition at line 291 of file netclass.h.

◆ m_TrackWidth

std::optional<int> NETCLASS::m_TrackWidth

protected

track width used to route nets

Definition at line 258 of file netclass.h.

Referenced by Deserialize(), and Serialize().

◆ m_trackWidthParent

NETCLASS* NETCLASS::m_trackWidthParent

protected

Definition at line 280 of file netclass.h.

◆ m_uViaDia

std::optional<int> NETCLASS::m_uViaDia

protected

microvia diameter

Definition at line 262 of file netclass.h.

◆ m_uViaDiaParent

NETCLASS* NETCLASS::m_uViaDiaParent

protected

Definition at line 283 of file netclass.h.

◆ m_uViaDrill

std::optional<int> NETCLASS::m_uViaDrill

protected

microvia drill hole diameter

Definition at line 263 of file netclass.h.

◆ m_uViaDrillParent

NETCLASS* NETCLASS::m_uViaDrillParent

protected

Definition at line 284 of file netclass.h.

◆ m_ViaDia

std::optional<int> NETCLASS::m_ViaDia

protected

via diameter

Definition at line 259 of file netclass.h.

Referenced by Deserialize(), and Serialize().

◆ m_viaDiameterParent

NETCLASS* NETCLASS::m_viaDiameterParent

protected

Definition at line 281 of file netclass.h.

◆ m_ViaDrill

std::optional<int> NETCLASS::m_ViaDrill

protected

via drill hole diameter

Definition at line 260 of file netclass.h.

Referenced by Deserialize(), and Serialize().

◆ m_viaDrillParent

NETCLASS* NETCLASS::m_viaDrillParent

protected

Definition at line 282 of file netclass.h.

◆ m_wireWidth

std::optional<int> NETCLASS::m_wireWidth

protected

Definition at line 269 of file netclass.h.

Referenced by Deserialize(), and Serialize().

◆ m_wireWidthParent

NETCLASS* NETCLASS::m_wireWidthParent

protected

Definition at line 289 of file netclass.h.

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

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NETCLASS()

◆ ~NETCLASS()

Member Function Documentation

◆ ContainsNetclassWithName()

◆ Deserialize()

◆ GetBusWidth()

◆ GetBusWidthOpt()

◆ GetBusWidthParent()

◆ GetClass()

◆ GetClearance()

◆ GetClearanceOpt()

◆ GetClearanceParent()

◆ GetConstituentNetclasses()

◆ GetDelayProfile()

◆ GetDelayProfileParent()

◆ GetDescription()

◆ GetDiffPairGap()

◆ GetDiffPairGapOpt()

◆ GetDiffPairGapParent()

◆ GetDiffPairViaGap()

◆ GetDiffPairViaGapOpt()

◆ GetDiffPairViaGapParent()

◆ GetDiffPairWidth()

◆ GetDiffPairWidthOpt()

◆ GetDiffPairWidthParent()

◆ GetHumanReadableName()

◆ GetLineStyle()

◆ GetLineStyleOpt()

◆ GetLineStyleParent()

◆ GetName()

◆ GetPcbColor()

◆ GetPcbColorParent()

◆ GetPriority()

◆ GetSchematicColor()

◆ GetSchematicColorParent()

◆ GetTrackWidth()

◆ GetTrackWidthOpt()

◆ GetTrackWidthParent()

◆ GetuViaDiameter()

◆ GetuViaDiameterOpt()

◆ GetuViaDiameterParent()

◆ GetuViaDrill()

◆ GetuViaDrillOpt()

◆ GetuViaDrillParent()

◆ GetViaDiameter()

◆ GetViaDiameterOpt()

◆ GetViaDiameterParent()

◆ GetViaDrill()

◆ GetViaDrillOpt()

◆ GetViaDrillParent()

◆ GetWireWidth()

◆ GetWireWidthOpt()

◆ GetWireWidthParent()

◆ HasBusWidth()

◆ HasClearance()

◆ HasDelayProfile()

◆ HasDiffPairGap()

◆ HasDiffPairViaGap()

◆ HasDiffPairWidth()

◆ HasLineStyle()

◆ HasPcbColor()

◆ HasTrackWidth()

◆ HasuViaDiameter()

◆ HasuViaDrill()

◆ HasViaDiameter()

◆ HasViaDrill()

◆ HasWireWidth()

◆ IsDefault()

◆ operator==()

◆ ResetParameters()

◆ ResetParents()

◆ Serialize()

◆ SetBusWidth() [1/2]

◆ SetBusWidth() [2/2]

◆ SetBusWidthParent()