KiCad PCB EDA Suite
NETCLASSES Class Reference

Class NETCLASSES is a container for NETCLASS instances. More...

#include <class_netclass.h>

Public Types

typedef NETCLASS_MAP::iterator iterator
 
typedef NETCLASS_MAP::const_iterator const_iterator
 

Public Member Functions

 NETCLASSES ()
 
 ~NETCLASSES ()
 
void Clear ()
 Function Clear destroys any contained NETCLASS instances except the Default one. More...
 
iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
unsigned GetCount () const
 Function GetCount. More...
 
NETCLASSPTR GetDefault () const
 Function GetDefault. More...
 
bool Add (NETCLASSPTR aNetclass)
 Function Add takes aNetclass and puts it into this NETCLASSES container. More...
 
NETCLASSPTR Remove (const wxString &aNetName)
 Function Remove removes a NETCLASS from this container but does not destroy/delete it. More...
 
NETCLASSPTR Find (const wxString &aName) const
 Function Find searches this container for a NETCLASS given by aName. More...
 
NETCLASS_MAP & NetClasses ()
 Provide public access to m_NetClasses so it gets swigged. More...
 

Private Attributes

NETCLASS_MAP m_NetClasses
 all the NETCLASSes except the default one. More...
 
NETCLASSPTR m_Default
 the default NETCLASS. More...
 

Detailed Description

Class NETCLASSES is a container for NETCLASS instances.

It owns all its NETCLASSes (=> it will delete them at time of destruction). This container will always have a default NETCLASS with the name given by const NETCLASS::Default.

Definition at line 232 of file class_netclass.h.

Member Typedef Documentation

typedef NETCLASS_MAP::const_iterator NETCLASSES::const_iterator

Definition at line 259 of file class_netclass.h.

typedef NETCLASS_MAP::iterator NETCLASSES::iterator

Definition at line 255 of file class_netclass.h.

Constructor & Destructor Documentation

NETCLASSES::NETCLASSES ( )

Definition at line 87 of file class_netclass.cpp.

References NETCLASS::Default, and m_Default.

88 {
89  m_Default = std::make_shared<NETCLASS>( NETCLASS::Default );
90 }
NETCLASSPTR m_Default
the default NETCLASS.
static const char Default[]
the name of the default NETCLASS
NETCLASSES::~NETCLASSES ( )

Definition at line 93 of file class_netclass.cpp.

94 {
95 }

Member Function Documentation

bool NETCLASSES::Add ( NETCLASSPTR  aNetclass)

Function Add takes aNetclass and puts it into this NETCLASSES container.

Parameters
aNetclassis netclass to add
Returns
true if the name within aNetclass is unique and it could be inserted OK, else false because the name was not unique.

Definition at line 98 of file class_netclass.cpp.

References NETCLASS::Default, Find(), m_Default, m_NetClasses, and name.

Referenced by DIALOG_DESIGN_RULES::CopyRulesListToBoard(), and LEGACY_PLUGIN::loadNETCLASS().

99 {
100  const wxString& name = aNetClass->GetName();
101 
102  if( name == NETCLASS::Default )
103  {
104  // invoke operator=(), which is currently generated by compiler.
105  m_Default = aNetClass;
106 
107  return true;
108  }
109 
110  // Test for an existing netclass:
111  if( !Find( name ) )
112  {
113  // name not found, take ownership
114  m_NetClasses[name] = aNetClass;
115 
116  return true;
117  }
118  else
119  {
120  // name already exists
121  // do not "take ownership" and return false telling caller such.
122  return false;
123  }
124 }
NETCLASSPTR Find(const wxString &aName) const
Function Find searches this container for a NETCLASS given by aName.
NETCLASSPTR m_Default
the default NETCLASS.
static const char Default[]
the name of the default NETCLASS
const char * name
NETCLASS_MAP m_NetClasses
all the NETCLASSes except the default one.
const_iterator NETCLASSES::begin ( ) const
inline

Definition at line 260 of file class_netclass.h.

260 { return m_NetClasses.begin(); }
NETCLASS_MAP m_NetClasses
all the NETCLASSes except the default one.
void NETCLASSES::Clear ( )
inline

Function Clear destroys any contained NETCLASS instances except the Default one.

Definition at line 250 of file class_netclass.h.

Referenced by PCBNEW_CONTROL::AppendBoard(), PCB_EDIT_FRAME::AppendBoardFile(), and DIALOG_DESIGN_RULES::CopyRulesListToBoard().

251  {
252  m_NetClasses.clear();
253  }
NETCLASS_MAP m_NetClasses
all the NETCLASSes except the default one.
const_iterator NETCLASSES::end ( ) const
inline

Definition at line 261 of file class_netclass.h.

261 { return m_NetClasses.end(); }
NETCLASS_MAP m_NetClasses
all the NETCLASSes except the default one.
NETCLASSPTR NETCLASSES::Find ( const wxString &  aName) const

Function Find searches this container for a NETCLASS given by aName.

Parameters
aNameis the name of the NETCLASS to search for.
Returns
NETCLASSPTR - if found, else NULL.

Definition at line 142 of file class_netclass.cpp.

References NETCLASS::Default, m_Default, and m_NetClasses.

Referenced by Add(), DIALOG_DESIGN_RULES::CopyRulesListToBoard(), BOARD_DESIGN_SETTINGS::GetCurrentMicroViaDrill(), BOARD_DESIGN_SETTINGS::GetCurrentMicroViaSize(), ROUTER_TOOL::getNetclassDimensions(), PNS::SIZES_SETTINGS::Init(), PNS_PCBNEW_RULE_RESOLVER::PNS_PCBNEW_RULE_RESOLVER(), BOARD_DESIGN_SETTINGS::SetCurrentNetClass(), and BOARD::SynchronizeNetsAndNetClasses().

143 {
144  if( aName == NETCLASS::Default )
145  return m_Default;
146 
147  NETCLASS_MAP::const_iterator found = m_NetClasses.find( aName );
148 
149  if( found == m_NetClasses.end() )
150  return NETCLASSPTR();
151  else
152  return found->second;
153 }
NETCLASSPTR m_Default
the default NETCLASS.
static const char Default[]
the name of the default NETCLASS
NETCLASS_MAP m_NetClasses
all the NETCLASSes except the default one.
unsigned NETCLASSES::GetCount ( ) const
inline

Function GetCount.

Returns
the number of netclasses, excluding the default one.

Definition at line 267 of file class_netclass.h.

Referenced by DIALOG_DESIGN_RULES::InitRulesList().

268  {
269  return m_NetClasses.size();
270  }
NETCLASS_MAP m_NetClasses
all the NETCLASSes except the default one.
NETCLASS_MAP& NETCLASSES::NetClasses ( )
inline

Provide public access to m_NetClasses so it gets swigged.

Definition at line 307 of file class_netclass.h.

References BOARD_DESIGN_SETTINGS::m_NetClasses.

307 { return m_NetClasses; }
NETCLASS_MAP m_NetClasses
all the NETCLASSes except the default one.
NETCLASSPTR NETCLASSES::Remove ( const wxString &  aNetName)

Function Remove removes a NETCLASS from this container but does not destroy/delete it.

Parameters
aNetNameis the name of the net to delete, and it may not be NETCLASS::Default.
Returns
NETCLASSPTR - the NETCLASS associated with aNetName if found and removed, else NULL.

Definition at line 127 of file class_netclass.cpp.

References m_NetClasses.

128 {
129  NETCLASS_MAP::iterator found = m_NetClasses.find( aNetName );
130 
131  if( found != m_NetClasses.end() )
132  {
133  std::shared_ptr<NETCLASS> netclass = found->second;
134  m_NetClasses.erase( found );
135  return netclass;
136  }
137 
138  return NETCLASSPTR();
139 }
NETCLASS_MAP m_NetClasses
all the NETCLASSes except the default one.

Member Data Documentation

NETCLASSPTR NETCLASSES::m_Default
private

the default NETCLASS.

Definition at line 240 of file class_netclass.h.

Referenced by Add(), Find(), and NETCLASSES().

NETCLASS_MAP NETCLASSES::m_NetClasses
private

all the NETCLASSes except the default one.

Definition at line 237 of file class_netclass.h.

Referenced by Add(), Find(), DSN::SPECCTRA_DB::FromBOARD(), and Remove().


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