KiCad PCB EDA Suite
Loading...
Searching...
No Matches
STRING_ANY_MAP Class Reference

A name/value tuple with unique names and wxAny values. More...

#include <string_any_map.h>

Inheritance diagram for STRING_ANY_MAP:

Public Member Functions

 STRING_ANY_MAP (double aIUScale=1.0)
 
template<typename T >
bool get_to (const std::string &aKey, T &aVar) const
 
template<typename T >
bool get_to_iu (const std::string &aKey, T &aVar) const
 
template<typename T >
void set (const std::string &aKey, const T &aVar)
 
template<typename T >
void set_iu (const std::string &aKey, const T &aVar)
 
bool contains (const std::string &aKey) const
 
template<typename T >
std::optional< T > get_opt (const std::string &aKey) const
 

Public Attributes

keys
 STL member.
 
elements
 STL member.
 

Private Attributes

double m_iuScale
 

Detailed Description

A name/value tuple with unique names and wxAny values.

The names may be iterated alphabetically.

Definition at line 35 of file string_any_map.h.

Constructor & Destructor Documentation

◆ STRING_ANY_MAP()

STRING_ANY_MAP::STRING_ANY_MAP ( double  aIUScale = 1.0)
inline

Definition at line 41 of file string_any_map.h.

Member Function Documentation

◆ contains()

bool STRING_ANY_MAP::contains ( const std::string &  aKey) const
inline

Definition at line 92 of file string_any_map.h.

References find.

Referenced by get_opt(), get_to(), and get_to_iu().

◆ get_opt()

template<typename T >
std::optional< T > STRING_ANY_MAP::get_opt ( const std::string &  aKey) const
inline

Definition at line 98 of file string_any_map.h.

References contains().

Referenced by PCB_TUNING_PATTERN::SetProperties().

◆ get_to()

template<typename T >
bool STRING_ANY_MAP::get_to ( const std::string &  aKey,
T &  aVar 
) const
inline

Definition at line 44 of file string_any_map.h.

References contains().

Referenced by PCB_GENERATOR::SetProperties(), and PCB_TUNING_PATTERN::SetProperties().

◆ get_to_iu()

template<typename T >
bool STRING_ANY_MAP::get_to_iu ( const std::string &  aKey,
T &  aVar 
) const
inline

Definition at line 53 of file string_any_map.h.

References contains(), and m_iuScale.

Referenced by PCB_TUNING_PATTERN::SetProperties().

◆ set()

template<typename T >
void STRING_ANY_MAP::set ( const std::string &  aKey,
const T &  aVar 
)
inline

◆ set_iu()

template<typename T >
void STRING_ANY_MAP::set_iu ( const std::string &  aKey,
const T &  aVar 
)
inline

Definition at line 87 of file string_any_map.h.

References m_iuScale.

Referenced by PCB_TUNING_PATTERN::GetProperties().

Member Data Documentation

◆ elements

T std::map< K, T >::elements
inherited

STL member.

◆ keys

K std::map< K, T >::keys
inherited

STL member.

◆ m_iuScale

double STRING_ANY_MAP::m_iuScale
private

Definition at line 37 of file string_any_map.h.

Referenced by get_to_iu(), and set_iu().


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