KiCad PCB EDA Suite
BUS_ALIAS Class Reference

#include <bus_alias.h>

Public Member Functions

 BUS_ALIAS (SCH_SCREEN *aParent=nullptr)
 
 ~BUS_ALIAS ()
 
std::shared_ptr< BUS_ALIASClone () const
 
wxString GetName ()
 
void SetName (const wxString &aName)
 
const std::vector< wxString > & Members () const
 
std::vector< wxString > & Members ()
 
SCH_SCREENGetParent ()
 
void SetParent (SCH_SCREEN *aParent)
 

Protected Attributes

wxString m_name
 
std::vector< wxString > m_members
 
SCH_SCREENm_parent
 Schematic Setup can edit aliases from all sheets, so we have to store a reference back to our parent so that the dialog can update the parent if aliases are changed or removed. More...
 

Detailed Description

Definition at line 33 of file bus_alias.h.

Constructor & Destructor Documentation

◆ BUS_ALIAS()

BUS_ALIAS::BUS_ALIAS ( SCH_SCREEN aParent = nullptr)
inline

Definition at line 36 of file bus_alias.h.

36 :
37 m_parent( aParent )
38 { }
SCH_SCREEN * m_parent
Schematic Setup can edit aliases from all sheets, so we have to store a reference back to our parent ...
Definition: bus_alias.h:65

◆ ~BUS_ALIAS()

BUS_ALIAS::~BUS_ALIAS ( )
inline

Definition at line 40 of file bus_alias.h.

41 { }

Member Function Documentation

◆ Clone()

std::shared_ptr< BUS_ALIAS > BUS_ALIAS::Clone ( ) const
inline

Definition at line 43 of file bus_alias.h.

44 {
45 return std::make_shared<BUS_ALIAS>( *this );
46 }

◆ GetName()

wxString BUS_ALIAS::GetName ( void  )
inline

Definition at line 48 of file bus_alias.h.

48{ return m_name; }
wxString m_name
Definition: bus_alias.h:58

References m_name.

◆ GetParent()

SCH_SCREEN * BUS_ALIAS::GetParent ( void  )
inline

Definition at line 54 of file bus_alias.h.

54{ return m_parent; }

References m_parent.

◆ Members() [1/2]

std::vector< wxString > & BUS_ALIAS::Members ( )
inline

Definition at line 52 of file bus_alias.h.

52{ return m_members; }
std::vector< wxString > m_members
Definition: bus_alias.h:59

References m_members.

◆ Members() [2/2]

const std::vector< wxString > & BUS_ALIAS::Members ( ) const
inline

Definition at line 51 of file bus_alias.h.

51{ return m_members; }

References m_members.

◆ SetName()

void BUS_ALIAS::SetName ( const wxString &  aName)
inline

Definition at line 49 of file bus_alias.h.

49{ m_name = aName; }

References m_name.

◆ SetParent()

void BUS_ALIAS::SetParent ( SCH_SCREEN aParent)
inline

Definition at line 55 of file bus_alias.h.

55{ m_parent = aParent; }

References m_parent.

Member Data Documentation

◆ m_members

std::vector<wxString> BUS_ALIAS::m_members
protected

Definition at line 59 of file bus_alias.h.

Referenced by Members().

◆ m_name

wxString BUS_ALIAS::m_name
protected

Definition at line 58 of file bus_alias.h.

Referenced by GetName(), and SetName().

◆ m_parent

SCH_SCREEN* BUS_ALIAS::m_parent
protected

Schematic Setup can edit aliases from all sheets, so we have to store a reference back to our parent so that the dialog can update the parent if aliases are changed or removed.

Definition at line 65 of file bus_alias.h.

Referenced by GetParent(), and SetParent().


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