You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
277 lines
13 KiB
277 lines
13 KiB
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2009 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
|
|
* Copyright (C) 2009 Jean-Pierre Charras, jean-pierre.charras@inpg.fr
|
|
* Copyright (C) 2009-2022 KiCad Developers, see change_log.txt for contributors.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
#ifndef CLASS_NETCLASS_H
|
|
#define CLASS_NETCLASS_H
|
|
|
|
#include <optional>
|
|
|
|
#include <gal/color4d.h>
|
|
#include <kicommon.h>
|
|
#include <macros_swig.h>
|
|
#include <stroke_params.h>
|
|
|
|
using KIGFX::COLOR4D;
|
|
|
|
DECL_SET_FOR_SWIG( STRINGSET, wxString )
|
|
|
|
/**
|
|
* A collection of nets and the parameters used to route or test these nets.
|
|
*/
|
|
class KICOMMON_API NETCLASS
|
|
{
|
|
public:
|
|
static const char Default[]; ///< the name of the default NETCLASS
|
|
|
|
/**
|
|
* Create a NETCLASS instance with \a aName.
|
|
* The units on the optional parameters are Internal Units (1 nm)
|
|
* @param aName is the name of this new netclass.
|
|
* @param aInitWithDefaults if true, initalise the netclass with default values
|
|
*/
|
|
NETCLASS( const wxString& aName, bool aInitWithDefaults = true );
|
|
|
|
~NETCLASS(){};
|
|
|
|
bool operator==( const NETCLASS& other ) const;
|
|
|
|
wxString GetClass() const
|
|
{
|
|
return wxT( "NETCLASS" );
|
|
}
|
|
|
|
/// @brief Resets all parent fields to point to this netclass
|
|
void ResetParents();
|
|
|
|
/// @brief Resets all parameters (except Name and Description)
|
|
void ResetParameters();
|
|
|
|
/// @brief Gets the netclasses which make up this netclass
|
|
// For a root netcless, this is the netclass this pointer, for aggregate netclasses is contains
|
|
// all constituent netclasses, in order of priority.
|
|
const std::vector<NETCLASS*>& GetConstituentNetclasses() const;
|
|
|
|
/// @brief Sets the netclasses which make up this netclass
|
|
void SetConstituentNetclasses( std::vector<NETCLASS*>&& constituents );
|
|
|
|
/// @brief Gets the name of this (maybe aggregate) netclass in a format for label variable
|
|
/// substitutions
|
|
const wxString GetVariableSubstitutionName() const;
|
|
|
|
/// @brief Determines if the given netclass name is a constituent of this (maybe aggregate)
|
|
/// netclass
|
|
bool ContainsNetclassWithName( const wxString& netclass ) const;
|
|
|
|
/// @ brief Determines if this is marked as the default netclass
|
|
bool IsDefault() const { return m_isDefault; }
|
|
|
|
/// @brief Gets the consolidated name of this netclass (which may be an aggregate)
|
|
const wxString GetName() const;
|
|
void SetName( const wxString& aName )
|
|
{
|
|
m_Name = aName;
|
|
|
|
if( aName == Default )
|
|
m_isDefault = true;
|
|
}
|
|
|
|
const wxString& GetDescription() const { return m_Description; }
|
|
void SetDescription( const wxString& aDesc ) { m_Description = aDesc; }
|
|
|
|
bool HasClearance() const { return (bool) m_Clearance; }
|
|
int GetClearance() const { return m_Clearance.value_or(-1); }
|
|
std::optional<int> GetClearanceOpt() const { return m_Clearance; }
|
|
void SetClearance( int aClearance ) { m_Clearance = aClearance; }
|
|
void SetClearance( std::optional<int> aClearance ) { m_Clearance = aClearance; }
|
|
void SetClearanceParent( NETCLASS* parent) { m_clearanceParent = parent; }
|
|
NETCLASS* GetClearanceParent() const { return m_clearanceParent; }
|
|
|
|
bool HasTrackWidth() const { return (bool) m_TrackWidth; }
|
|
int GetTrackWidth() const { return m_TrackWidth.value_or( -1 ); }
|
|
std::optional<int> GetTrackWidthOpt() const { return m_TrackWidth; }
|
|
void SetTrackWidth( int aWidth ) { m_TrackWidth = aWidth; }
|
|
void SetTrackWidth( std::optional<int> aWidth ) { m_TrackWidth = aWidth; }
|
|
void SetTrackWidthParent( NETCLASS* parent) { m_trackWidthParent = parent; }
|
|
NETCLASS* GetTrackWidthParent() const { return m_trackWidthParent; }
|
|
|
|
bool HasViaDiameter() const { return (bool) m_ViaDia; }
|
|
int GetViaDiameter() const { return m_ViaDia.value_or( -1 ); }
|
|
std::optional<int> GetViaDiameterOpt() const { return m_ViaDia; }
|
|
void SetViaDiameter( int aDia ) { m_ViaDia = aDia; }
|
|
void SetViaDiameter( std::optional<int> aDia ) { m_ViaDia = aDia; }
|
|
void SetViaDiameterParent( NETCLASS* parent) { m_viaDiameterParent = parent; }
|
|
NETCLASS* GetViaDiameterParent() const { return m_viaDiameterParent; }
|
|
|
|
int HasViaDrill() const { return (bool) m_ViaDrill; }
|
|
int GetViaDrill() const { return m_ViaDrill.value_or( -1 ); }
|
|
std::optional<int> GetViaDrillOpt() const { return m_ViaDrill; }
|
|
void SetViaDrill( int aSize ) { m_ViaDrill = aSize; }
|
|
void SetViaDrill( std::optional<int> aSize ) { m_ViaDrill = aSize; }
|
|
void SetViaDrillParent( NETCLASS* parent) { m_viaDrillParent = parent; }
|
|
NETCLASS* GetViaDrillParent() const { return m_viaDrillParent; }
|
|
|
|
bool HasuViaDiameter() const { return (bool) m_uViaDia; }
|
|
int GetuViaDiameter() const { return m_uViaDia.value_or( -1 ); }
|
|
std::optional<int> GetuViaDiameterOpt() const { return m_uViaDia; }
|
|
void SetuViaDiameter( int aSize ) { m_uViaDia = aSize; }
|
|
void SetuViaDiameter( std::optional<int> aSize ) { m_uViaDia = aSize; }
|
|
void SetuViaDiameterParent( NETCLASS* parent) { m_uViaDiaParent = parent; }
|
|
NETCLASS* GetuViaDiameterParent() const { return m_uViaDiaParent; }
|
|
|
|
bool HasuViaDrill() const { return (bool) m_uViaDrill; }
|
|
int GetuViaDrill() const { return m_uViaDrill.value_or( -1 ); }
|
|
std::optional<int> GetuViaDrillOpt() const { return m_uViaDrill; }
|
|
void SetuViaDrill( int aSize ) { m_uViaDrill = aSize; }
|
|
void SetuViaDrill( std::optional<int> aSize ) { m_uViaDrill = aSize; }
|
|
void SetuViaDrillParent( NETCLASS* parent) { m_uViaDrillParent = parent; }
|
|
NETCLASS* GetuViaDrillParent() const { return m_uViaDrillParent; }
|
|
|
|
bool HasDiffPairWidth() const { return (bool) m_diffPairWidth; }
|
|
int GetDiffPairWidth() const { return m_diffPairWidth.value_or( -1 ); }
|
|
std::optional<int> GetDiffPairWidthOpt() const { return m_diffPairWidth; }
|
|
void SetDiffPairWidth( int aSize ) { m_diffPairWidth = aSize; }
|
|
void SetDiffPairWidth( std::optional<int> aSize ) { m_diffPairWidth = aSize; }
|
|
void SetDiffPairWidthParent( NETCLASS* parent) { m_diffPairWidthParent = parent; }
|
|
NETCLASS* GetDiffPairWidthParent() const { return m_diffPairWidthParent; }
|
|
|
|
bool HasDiffPairGap() const { return (bool) m_diffPairGap; }
|
|
int GetDiffPairGap() const { return m_diffPairGap.value_or( -1 ); }
|
|
std::optional<int> GetDiffPairGapOpt() const { return m_diffPairGap; }
|
|
void SetDiffPairGap( int aSize ) { m_diffPairGap = aSize; }
|
|
void SetDiffPairGap( std::optional<int> aSize ) { m_diffPairGap = aSize; }
|
|
void SetDiffPairGapParent( NETCLASS* parent) { m_diffPairGapParent = parent; }
|
|
NETCLASS* GetDiffPairGapParent() const { return m_diffPairGapParent; }
|
|
|
|
bool HasDiffPairViaGap() const { return (bool) m_diffPairViaGap; }
|
|
int GetDiffPairViaGap() const { return m_diffPairViaGap.value_or( -1 ); }
|
|
std::optional<int> GetDiffPairViaGapOpt() const { return m_diffPairViaGap; }
|
|
void SetDiffPairViaGap( int aSize ) { m_diffPairViaGap = aSize; }
|
|
void SetDiffPairViaGap( std::optional<int> aSize ) { m_diffPairViaGap = aSize; }
|
|
void SetDiffPairViaGapParent( NETCLASS* parent) { m_diffPairViaGapParent = parent; }
|
|
NETCLASS* GetDiffPairViaGapParent() const { return m_diffPairViaGapParent; }
|
|
|
|
bool HasPcbColor() const { return m_isDefault ? false : m_pcbColor != COLOR4D::UNSPECIFIED; }
|
|
COLOR4D GetPcbColor( bool aIsForSave = false ) const
|
|
{
|
|
// If we are saving netclases, return the underlying color (which may be set from an old
|
|
// schematic with a default color set - this allows us to roll back the no-default-colors
|
|
// changes later if required)
|
|
if( aIsForSave || !m_isDefault )
|
|
return m_pcbColor;
|
|
|
|
return COLOR4D::UNSPECIFIED;
|
|
}
|
|
void SetPcbColor( const COLOR4D& aColor ) { m_pcbColor = aColor; }
|
|
void SetPcbColorParent( NETCLASS* parent) { m_pcbColorParent = parent; }
|
|
NETCLASS* GetPcbColorParent() const { return m_pcbColorParent; }
|
|
|
|
bool HasWireWidth() const { return (bool) m_wireWidth; }
|
|
int GetWireWidth() const { return m_wireWidth.value_or( -1 ); }
|
|
std::optional<int> GetWireWidthOpt() const { return m_wireWidth; }
|
|
void SetWireWidth( int aWidth ) { m_wireWidth = aWidth; }
|
|
void SetWireWidth( std::optional<int> aWidth ) { m_wireWidth = aWidth; }
|
|
void SetWireWidthParent( NETCLASS* parent) { m_wireWidthParent = parent; }
|
|
NETCLASS* GetWireWidthParent() const { return m_wireWidthParent; }
|
|
|
|
bool HasBusWidth() const { return (bool) m_busWidth; }
|
|
int GetBusWidth() const { return m_busWidth.value_or( -1 ); }
|
|
std::optional<int> GetBusWidthOpt() const { return m_busWidth; }
|
|
void SetBusWidth( int aWidth ) { m_busWidth = aWidth; }
|
|
void SetBusWidth( std::optional<int> aWidth ) { m_busWidth = aWidth; }
|
|
void SetBusWidthParent( NETCLASS* parent) { m_busWidthParent = parent; }
|
|
NETCLASS* GetBusWidthParent() const { return m_busWidthParent; }
|
|
|
|
COLOR4D GetSchematicColor( bool aIsForSave = false ) const
|
|
{
|
|
// If we are saving netclases, return the underlying color (which may be set from an old
|
|
// schematic with a default color set - this allows us to roll back the no-default-colors
|
|
// changes later if required)
|
|
if( aIsForSave || !m_isDefault )
|
|
return m_schematicColor;
|
|
|
|
return COLOR4D::UNSPECIFIED;
|
|
}
|
|
void SetSchematicColor( COLOR4D aColor ) { m_schematicColor = aColor; }
|
|
void SetSchematicColorParent( NETCLASS* parent) { m_schematicColorParent = parent; }
|
|
NETCLASS* GetSchematicColorParent() const { return m_schematicColorParent; }
|
|
|
|
bool HasLineStyle() const { return (bool) m_lineStyle; }
|
|
int GetLineStyle() const { return m_lineStyle.value_or( 0 ); }
|
|
std::optional<int> GetLineStyleOpt() const { return m_lineStyle; }
|
|
void SetLineStyle( int aStyle ) { m_lineStyle = aStyle; }
|
|
void SetLineStyle( std::optional<int> aStyle ) { m_lineStyle = aStyle; }
|
|
void SetLineStyleParent( NETCLASS* parent) { m_lineStyleParent = parent; }
|
|
NETCLASS* GetLineStyleParent() const { return m_lineStyleParent; }
|
|
|
|
void SetPriority( int aPriority ) { m_Priority = aPriority; }
|
|
int GetPriority() const { return m_Priority; }
|
|
|
|
protected:
|
|
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
|
|
|
|
// The NETCLASS providing each parameter
|
|
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;
|
|
};
|
|
|
|
#endif // CLASS_NETCLASS_H
|