KiCad PCB EDA Suite
ENUM_MAP< T > Class Template Reference

#include <property.h>

Public Member Functions

ENUM_MAPMap (T aValue, const wxString &aName)
 
ENUM_MAPUndefined (T aValue)
 
const wxString & ToString (T value) const
 
const T ToEnum (const wxString value)
 
wxPGChoices & Choices ()
 

Static Public Member Functions

static ENUM_MAP< T > & Instance ()
 

Private Member Functions

 ENUM_MAP ()
 

Private Attributes

wxPGChoices m_choices
 
std::unordered_map< wxString, T > m_reverseMap
 
m_undefined
 

Detailed Description

template<typename T>
class ENUM_MAP< T >

Definition at line 41 of file property.h.

Constructor & Destructor Documentation

◆ ENUM_MAP()

template<typename T>
ENUM_MAP< T >::ENUM_MAP ( )
inlineprivate

Definition at line 567 of file property.h.

568  {
569  }

Member Function Documentation

◆ Choices()

template<typename T>
wxPGChoices& ENUM_MAP< T >::Choices ( )
inline

◆ Instance()

◆ Map()

template<typename T>
ENUM_MAP& ENUM_MAP< T >::Map ( aValue,
const wxString &  aName 
)
inline

Definition at line 523 of file property.h.

524  {
525  wxASSERT_MSG( m_choices.Index( aName ) == wxNOT_FOUND, "Redefined string for a value in ENUM_MAP" );
526  m_choices.Add( aName, static_cast<int>( aValue ) );
527  m_reverseMap[ aName ] = aValue;
528  return *this;
529  }
std::unordered_map< wxString, T > m_reverseMap
Definition: property.h:564
wxPGChoices m_choices
Definition: property.h:563

References ENUM_MAP< T >::m_choices, and ENUM_MAP< T >::m_reverseMap.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), MODULE_DESC::MODULE_DESC(), TRACK_VIA_DESC::TRACK_VIA_DESC(), and PCB_EDIT_FRAME::UpdateUserInterface().

◆ ToEnum()

template<typename T>
const T ENUM_MAP< T >::ToEnum ( const wxString  value)
inline

Definition at line 549 of file property.h.

550  {
551  if( m_reverseMap.count( value ) )
552  return m_reverseMap[ value ];
553  else
554  return m_undefined;
555  }
T m_undefined
Definition: property.h:565
std::unordered_map< wxString, T > m_reverseMap
Definition: property.h:564

References ENUM_MAP< T >::m_reverseMap, and ENUM_MAP< T >::m_undefined.

◆ ToString()

template<typename T>
const wxString& ENUM_MAP< T >::ToString ( value) const
inline

Definition at line 537 of file property.h.

538  {
539  static const wxString s_undef = "UNDEFINED";
540 
541  int idx = m_choices.Index( static_cast<int>( value ) );
542 
543  if( idx >= 0 && idx < (int) m_choices.GetCount() )
544  return m_choices.GetLabel( static_cast<int>( idx ) );
545  else
546  return s_undef;
547  }
wxPGChoices m_choices
Definition: property.h:563

References ENUM_MAP< T >::m_choices.

Referenced by PCB_INSPECTION_TOOL::reportZoneConnection().

◆ Undefined()

template<typename T>
ENUM_MAP& ENUM_MAP< T >::Undefined ( aValue)
inline

Member Data Documentation

◆ m_choices

template<typename T>
wxPGChoices ENUM_MAP< T >::m_choices
private

Definition at line 563 of file property.h.

Referenced by ENUM_MAP< T >::Choices(), ENUM_MAP< T >::Map(), and ENUM_MAP< T >::ToString().

◆ m_reverseMap

template<typename T>
std::unordered_map<wxString, T> ENUM_MAP< T >::m_reverseMap
private

Definition at line 564 of file property.h.

Referenced by ENUM_MAP< T >::Map(), and ENUM_MAP< T >::ToEnum().

◆ m_undefined

template<typename T>
T ENUM_MAP< T >::m_undefined
private

Definition at line 565 of file property.h.

Referenced by ENUM_MAP< T >::ToEnum(), and ENUM_MAP< T >::Undefined().


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