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
 
bool IsValueDefined (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 509 of file property.h.

Constructor & Destructor Documentation

◆ ENUM_MAP()

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

Definition at line 569 of file property.h.

572 {
573 }

Member Function Documentation

◆ Choices()

◆ Instance()

◆ IsValueDefined()

template<typename T >
bool ENUM_MAP< T >::IsValueDefined ( value) const
inline

Definition at line 543 of file property.h.

544 {
545 int idx = m_choices.Index( static_cast<int>( value ) );
546
547 if( idx >= 0 && idx < (int) m_choices.GetCount() )
548 return true;
549
550 return false;
551 }

References ENUM_MAP< T >::m_choices.

◆ Map()

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

Definition at line 518 of file property.h.

519 {
520 m_choices.Add( aName, static_cast<int>( aValue ) );
521 m_reverseMap[ aName ] = aValue;
522 return *this;
523 }
std::unordered_map< wxString, T > m_reverseMap
Definition: property.h:568

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(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_EDIT_FRAME::onBoardLoaded(), 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 553 of file property.h.

554 {
555 if( m_reverseMap.count( value ) )
556 return m_reverseMap[ value ];
557 else
558 return m_undefined;
559 }
T m_undefined
Definition: property.h:569

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 531 of file property.h.

532 {
533 static const wxString s_undef = "UNDEFINED";
534
535 int idx = m_choices.Index( static_cast<int>( value ) );
536
537 if( idx >= 0 && idx < (int) m_choices.GetCount() )
538 return m_choices.GetLabel( static_cast<int>( idx ) );
539 else
540 return s_undef;
541 }

References ENUM_MAP< T >::m_choices.

◆ Undefined()

Member Data Documentation

◆ m_choices

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

◆ m_reverseMap

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

Definition at line 568 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 569 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: