NETCLASSES Class Reference

A container for NETCLASS instances. More...

#include <netclass.h>

Public Types
typedef NETCLASS_MAP::iterator	iterator
typedef NETCLASS_MAP::const_iterator	const_iterator

Public Member Functions
	NETCLASSES ()
	~NETCLASSES ()
void	Clear ()
	Destroy any contained NETCLASS instances except the default one, and clears any members from the default one. More...
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
unsigned	GetCount () const
NETCLASSPTR	GetDefault () const
NETCLASS *	GetDefaultPtr () const
bool	Add (const NETCLASSPTR &aNetclass)
	Add aNetclass and puts it into this NETCLASSES container. More...
NETCLASSPTR	Remove (const wxString &aNetName)
	Remove a NETCLASS from this container but does not destroy/delete it. More...
NETCLASSPTR	Find (const wxString &aName) const
	Search 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
NETCLASSPTR	m_default

Detailed Description

A container for NETCLASS instances.

It owns all its NETCLASSes. This container will always have a default NETCLASS with the name given by const NETCLASS::Default.

Definition at line 218 of file netclass.h.

Member Typedef Documentation

const_iterator

typedef NETCLASS_MAP::const_iterator NETCLASSES::const_iterator

Definition at line 238 of file netclass.h.

iterator

typedef NETCLASS_MAP::iterator NETCLASSES::iterator

Definition at line 234 of file netclass.h.

Constructor & Destructor Documentation

NETCLASSES()

NETCLASSES::NETCLASSES

(

)

Definition at line 79 of file netclass.cpp.

{
    m_default = std::make_shared<NETCLASS>( NETCLASS::Default );
}

References NETCLASS::Default, and m_default.

~NETCLASSES()

NETCLASSES::~NETCLASSES

(

)

Definition at line 85 of file netclass.cpp.

{
}

Member Function Documentation

Add()

bool NETCLASSES::Add

(

const NETCLASSPTR &

aNetclass

)

Add aNetclass and puts it into this NETCLASSES container.

Parameters

aNetclass

is 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 90 of file netclass.cpp.

{
    const wxString& name = aNetClass->GetName();

    if( name == NETCLASS::Default )
    {
        m_default = aNetClass;
        return true;
    }

    // Test for an existing netclass:
    if( !Find( name ) )
    {
        // name not found, take ownership
        m_NetClasses[name] = aNetClass;

        return true;
    }
    else
    {
        // name already exists
        // do not "take ownership" and return false telling caller such.
        return false;
    }
}

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

Referenced by LEGACY_PLUGIN::loadNETCLASS(), NET_SETTINGS::NET_SETTINGS(), ALTIUM_PCB::ParseClasses6Data(), and PANEL_SETUP_NETCLASSES::TransferDataFromWindow().

begin() [1/2]

iterator NETCLASSES::begin ( )

inline

Definition at line 235 of file netclass.h.

{ return m_NetClasses.begin(); }

Referenced by DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), DSN::SPECCTRA_DB::FromBOARD(), NET_SETTINGS::NET_SETTINGS(), and PANEL_SETUP_NETCLASSES::TransferDataToWindow().

begin() [2/2]

const_iterator NETCLASSES::begin ( ) const

inline

Definition at line 239 of file netclass.h.

{ return m_NetClasses.begin(); }

Clear()

void NETCLASSES::Clear ( )

inline

Destroy any contained NETCLASS instances except the default one, and clears any members from the default one.

Definition at line 228 of file netclass.h.

    {
        m_NetClasses.clear();
        m_default->Clear();
    }

Referenced by PCB_CONTROL::AppendBoard(), NET_SETTINGS::NET_SETTINGS(), and PANEL_SETUP_NETCLASSES::TransferDataFromWindow().

end() [1/2]

iterator NETCLASSES::end ( )

inline

Definition at line 236 of file netclass.h.

{ return m_NetClasses.end(); }

Referenced by DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), DSN::SPECCTRA_DB::FromBOARD(), and PANEL_SETUP_NETCLASSES::TransferDataToWindow().

end() [2/2]

const_iterator NETCLASSES::end ( ) const

inline

Definition at line 240 of file netclass.h.

{ return m_NetClasses.end(); }

Find()

NETCLASSPTR NETCLASSES::Find

(

const wxString &

aName

)

const

Search this container for a NETCLASS given by aName.

Parameters

aName

is the name of the NETCLASS to search for.

Returns

a pointer to the NETCLASS if found, else NULL.

Definition at line 132 of file netclass.cpp.

{
    if( aName == NETCLASS::Default )
        return GetDefault();

    NETCLASS_MAP::const_iterator found = m_NetClasses.find( aName );

    if( found == m_NetClasses.end() )
        return NETCLASSPTR();
    else
        return found->second;
}

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

Referenced by Add(), SCH_EDITOR_CONTROL::AssignNetclass(), BOARD_DESIGN_SETTINGS::GetCurrentMicroViaDrill(), BOARD_DESIGN_SETTINGS::GetCurrentMicroViaSize(), SCH_EDIT_FRAME::KiwayMailIn(), SCH_ITEM::NetClass(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::showNetclass(), BOARD::SynchronizeNetsAndNetClasses(), and PANEL_SETUP_NETCLASSES::TransferDataFromWindow().

GetCount()

unsigned NETCLASSES::GetCount ( ) const

inline

Returns

the number of netclasses excluding the default one.

Definition at line 245 of file netclass.h.

    {
        return m_NetClasses.size();
    }

Referenced by DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildNetclassesGrid(), NET_SETTINGS::NET_SETTINGS(), and PANEL_SETUP_NETCLASSES::TransferDataToWindow().

GetDefault()

NETCLASSPTR NETCLASSES::GetDefault ( ) const

inline

Returns

the default net class.

Definition at line 253 of file netclass.h.

    {
        return m_default;
    }

Referenced by Find(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::FromSESSION(), DRC_ENGINE::loadImplicitRules(), NET_SETTINGS::NET_SETTINGS(), NETINFO_ITEM::NETINFO_ITEM(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::rebuildNets(), NETINFO_ITEM::SetNetClass(), APPEARANCE_CONTROLS::showNetclass(), BOARD::SynchronizeNetsAndNetClasses(), PANEL_SETUP_NETCLASSES::TransferDataFromWindow(), and PANEL_SETUP_NETCLASSES::TransferDataToWindow().

GetDefaultPtr()

NETCLASS* NETCLASSES::GetDefaultPtr ( ) const

inline

Definition at line 258 of file netclass.h.

    {
        return m_default.get();
    }

Referenced by DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), BOARD_DESIGN_SETTINGS::GetCurrentDiffPairGap(), BOARD_DESIGN_SETTINGS::GetCurrentDiffPairViaGap(), BOARD_DESIGN_SETTINGS::GetCurrentDiffPairWidth(), BOARD_DESIGN_SETTINGS::GetCurrentTrackWidth(), BOARD_DESIGN_SETTINGS::GetCurrentViaDrill(), BOARD_DESIGN_SETTINGS::GetCurrentViaSize(), BOARD_DESIGN_SETTINGS::GetDefault(), SCH_LINE::GetMsgPanelInfo(), and APPEARANCE_CONTROLS::showNetclass().

NetClasses()

NETCLASS_MAP& NETCLASSES::NetClasses ( )

inline

Provide public access to m_NetClasses so it gets swigged.

Definition at line 290 of file netclass.h.

{ return m_NetClasses; }

Referenced by APPEARANCE_CONTROLS::onNetclassContextMenu(), and APPEARANCE_CONTROLS::rebuildNets().

Remove()

NETCLASSPTR NETCLASSES::Remove

(

const wxString &

aNetName

)

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

Parameters

aNetName

is the name of the net to delete, and it may not be NETCLASS::Default.

Returns

a pointer to the NETCLASS associated with aNetName if found and removed, else NULL.

Definition at line 117 of file netclass.cpp.

{
    NETCLASS_MAP::iterator found = m_NetClasses.find( aNetName );

    if( found != m_NetClasses.end() )
    {
        std::shared_ptr<NETCLASS> netclass = found->second;
        m_NetClasses.erase( found );
        return netclass;
    }

    return NETCLASSPTR();
}

References m_NetClasses.

Member Data Documentation

m_default

NETCLASSPTR NETCLASSES::m_default

private

Definition at line 294 of file netclass.h.

Referenced by Add(), and NETCLASSES().

m_NetClasses

NETCLASS_MAP NETCLASSES::m_NetClasses

private

Definition at line 293 of file netclass.h.

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

---

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

• netclass.h
• netclass.cpp