COMPONENT_CLASS Class Reference

#include <component_class_manager.h>

Public Member Functions
	COMPONENT_CLASS (const wxString &name)
wxString	GetName () const
	Fetches the display name of this component class.
const wxString &	GetFullName () const
	Fetches the full name of this component class.
void	AddConstituentClass (COMPONENT_CLASS *componentClass)
	Adds a constituent component class to an effective component class.
bool	ContainsClassName (const wxString &className) const
	Determines if this (effective) component class contains a specific sub-class.
bool	IsEmpty () const
	Determines if this (effective) component class is empty (i.e. no classes defined)
const std::vector< COMPONENT_CLASS * > &	GetConstituentClasses () const
	Fetches a vector of the constituent classes for this (effective) class.

Private Attributes
wxString	m_name
	The full name of the component class.
std::vector< COMPONENT_CLASS * >	m_constituentClasses
	The COMPONENT_CLASS objects contributing to this complete component class.

Detailed Description

Definition at line 42 of file component_class_manager.h.

Constructor & Destructor Documentation

COMPONENT_CLASS()

COMPONENT_CLASS::COMPONENT_CLASS ( const wxString &  name )

inline

Definition at line 45 of file component_class_manager.h.

Member Function Documentation

AddConstituentClass()

void COMPONENT_CLASS::AddConstituentClass

(

COMPONENT_CLASS *

componentClass

)

Adds a constituent component class to an effective component class.

Definition at line 25 of file component_class_manager.cpp.

References m_constituentClasses.

ContainsClassName()

bool COMPONENT_CLASS::ContainsClassName

(

const wxString &

className

)

const

Determines if this (effective) component class contains a specific sub-class.

Definition at line 31 of file component_class_manager.cpp.

References m_constituentClasses, and m_name.

Referenced by hasComponentClassFunc().

GetConstituentClasses()

const std::vector< COMPONENT_CLASS * > & COMPONENT_CLASS::GetConstituentClasses ( ) const

inline

Fetches a vector of the constituent classes for this (effective) class.

Definition at line 63 of file component_class_manager.h.

References m_constituentClasses.

Referenced by PCB_IO_KICAD_SEXPR::format(), COMPONENT_CLASS_MANAGER::GetEffectiveComponentClass(), and MULTICHANNEL_TOOL::QuerySheetsAndComponentClasses().

GetFullName()

const wxString & COMPONENT_CLASS::GetFullName ( ) const

inline

Fetches the full name of this component class.

Definition at line 51 of file component_class_manager.h.

References m_name.

Referenced by FOOTPRINT::GetComponentClassAsString(), and BOARD_NETLIST_UPDATER::updateComponentClass().

GetName()

wxString COMPONENT_CLASS::GetName

(

)

const

Fetches the display name of this component class.

Definition at line 47 of file component_class_manager.cpp.

References _, GetName(), m_constituentClasses, m_name, and name.

Referenced by FOOTPRINT::GetMsgPanelInfo(), and GetName().

IsEmpty()

bool COMPONENT_CLASS::IsEmpty

(

)

const

Determines if this (effective) component class is empty (i.e. no classes defined)

Definition at line 80 of file component_class_manager.cpp.

References m_constituentClasses.

Member Data Documentation

m_constituentClasses

std::vector<COMPONENT_CLASS*> COMPONENT_CLASS::m_constituentClasses

private

The COMPONENT_CLASS objects contributing to this complete component class.

Definition at line 73 of file component_class_manager.h.

Referenced by AddConstituentClass(), ContainsClassName(), GetConstituentClasses(), GetName(), and IsEmpty().

m_name

wxString COMPONENT_CLASS::m_name

private

The full name of the component class.

Definition at line 70 of file component_class_manager.h.

Referenced by ContainsClassName(), GetFullName(), and GetName().

---

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

• component_class_manager.h
• component_class_manager.cpp