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...
 

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 231 of file class_netclass.h.

Member Typedef Documentation

typedef NETCLASS_MAP::const_iterator NETCLASSES::const_iterator

Definition at line 255 of file class_netclass.h.

typedef NETCLASS_MAP::iterator NETCLASSES::iterator

Definition at line 251 of file class_netclass.h.

Constructor & Destructor Documentation

NETCLASSES::NETCLASSES ( )

Definition at line 87 of file class_netclass.cpp.

88 {
89 }
NETCLASSES::~NETCLASSES ( )

Definition at line 92 of file class_netclass.cpp.

93 {
94 }

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 97 of file class_netclass.cpp.

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

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

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

Definition at line 256 of file class_netclass.h.

256 { 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 246 of file class_netclass.h.

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

247  {
248  m_NetClasses.clear();
249  }
NETCLASS_MAP m_NetClasses
all the NETCLASSes except the default one.
const_iterator NETCLASSES::end ( ) const
inline

Definition at line 257 of file class_netclass.h.

257 { 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 141 of file class_netclass.cpp.

References NETCLASS::Default, GetDefault(), 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().

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

Function GetCount.

Returns
the number of netclasses, excluding the default one.

Definition at line 263 of file class_netclass.h.

Referenced by DIALOG_DESIGN_RULES::InitRulesList().

264  {
265  return m_NetClasses.size();
266  }
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 304 of file class_netclass.h.

References BOARD_DESIGN_SETTINGS::m_NetClasses.

304 { 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 126 of file class_netclass.cpp.

References m_NetClasses.

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

Member Data Documentation

NETCLASS_MAP NETCLASSES::m_NetClasses
private

all the NETCLASSes except the default one.

Definition at line 236 of file class_netclass.h.

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


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