KiCad PCB EDA Suite
Loading...
Searching...
No Matches
OPTIONAL_XML_ATTRIBUTE< T > Class Template Reference

Model an optional XML attribute. More...

#include <eagle_parser.h>

Public Member Functions

 OPTIONAL_XML_ATTRIBUTE ()
 Construct a default OPTIONAL_XML_ATTRIBUTE, whose data is not available. More...
 
 OPTIONAL_XML_ATTRIBUTE (const wxString &aData)
 
template<typename V = T>
 OPTIONAL_XML_ATTRIBUTE (T aData)
 
 operator bool () const
 
OPTIONAL_XML_ATTRIBUTE< T > & operator= (const wxString &aData)
 Assign to a string (optionally) containing the data. More...
 
OPTIONAL_XML_ATTRIBUTE< T > & operator= (T aData)
 Assign to an object of the base type containing the data. More...
 
bool operator== (const T &aOther) const
 
void Set (const wxString &aString)
 Attempt to convert a string to the base type. More...
 
T & Get ()
 Return a reference to the value of the attribute assuming it is available. More...
 
const T & CGet () const
 Return a constant reference to the value of the attribute assuming it is available. More...
 
T & operator* ()
 Return a reference to the value of the attribute assuming it is available. More...
 
const T & operator* () const
 Return a constant reference to the value of the attribute assuming it is available. More...
 
T * operator-> ()
 Return a pointer to the value of the attribute assuming it is available. More...
 
const T * operator-> () const
 Return a constant pointer to the value of the attribute assuming it is available. More...
 

Private Attributes

bool m_isAvailable
 A boolean indicating if the data is present or not. More...
 
m_data
 The actual data if m_isAvailable is true; otherwise, garbage. More...
 

Detailed Description

template<typename T>
class OPTIONAL_XML_ATTRIBUTE< T >

Model an optional XML attribute.

This was implemented as an alternative to std::optional. This class should be replaced with a simple typedef per type using std::optional when C++17 is published.

Definition at line 196 of file eagle_parser.h.

Constructor & Destructor Documentation

◆ OPTIONAL_XML_ATTRIBUTE() [1/3]

template<typename T >
OPTIONAL_XML_ATTRIBUTE< T >::OPTIONAL_XML_ATTRIBUTE ( )
inline

Construct a default OPTIONAL_XML_ATTRIBUTE, whose data is not available.

Definition at line 209 of file eagle_parser.h.

◆ OPTIONAL_XML_ATTRIBUTE() [2/3]

template<typename T >
OPTIONAL_XML_ATTRIBUTE< T >::OPTIONAL_XML_ATTRIBUTE ( const wxString &  aData)
inline
Parameters
aDatais a wxString containing the value that should be converted to type T. If aData is empty, the attribute is understood as unavailable; otherwise, the conversion to T is tried.

Definition at line 219 of file eagle_parser.h.

References OPTIONAL_XML_ATTRIBUTE< T >::m_data, OPTIONAL_XML_ATTRIBUTE< T >::m_isAvailable, and OPTIONAL_XML_ATTRIBUTE< T >::Set().

◆ OPTIONAL_XML_ATTRIBUTE() [3/3]

template<typename T >
template<typename V = T>
OPTIONAL_XML_ATTRIBUTE< T >::OPTIONAL_XML_ATTRIBUTE ( aData)
inline
Parameters
aDatais the value of the XML attribute. If this constructor is called, the attribute is available.

Definition at line 233 of file eagle_parser.h.

Member Function Documentation

◆ CGet()

template<typename T >
const T & OPTIONAL_XML_ATTRIBUTE< T >::CGet ( ) const
inline

Return a constant reference to the value of the attribute assuming it is available.

Returns
const T& - the value of the attribute.

Definition at line 311 of file eagle_parser.h.

References OPTIONAL_XML_ATTRIBUTE< T >::m_data, and OPTIONAL_XML_ATTRIBUTE< T >::m_isAvailable.

Referenced by ETEXT::ConvertSize(), SCH_IO_EAGLE::loadTextAttributes(), OPTIONAL_XML_ATTRIBUTE< T >::operator*(), and OPTIONAL_XML_ATTRIBUTE< T >::operator->().

◆ Get()

template<typename T >
T & OPTIONAL_XML_ATTRIBUTE< T >::Get ( )
inline

Return a reference to the value of the attribute assuming it is available.

Returns
T& - the value of the attribute.

Definition at line 300 of file eagle_parser.h.

References OPTIONAL_XML_ATTRIBUTE< T >::m_data, and OPTIONAL_XML_ATTRIBUTE< T >::m_isAvailable.

Referenced by SCH_IO_EAGLE::loadInstance(), SCH_IO_EAGLE::loadLibrary(), SCH_IO_EAGLE::loadPin(), PCB_IO_EAGLE::loadPolygon(), OPTIONAL_XML_ATTRIBUTE< T >::operator*(), and OPTIONAL_XML_ATTRIBUTE< T >::operator->().

◆ operator bool()

template<typename T >
OPTIONAL_XML_ATTRIBUTE< T >::operator bool ( ) const
inline
Returns
bool the availability of the attribute.

Definition at line 241 of file eagle_parser.h.

References OPTIONAL_XML_ATTRIBUTE< T >::m_isAvailable.

◆ operator*() [1/2]

template<typename T >
T & OPTIONAL_XML_ATTRIBUTE< T >::operator* ( )
inline

Return a reference to the value of the attribute assuming it is available.

Returns
T& - the value of the attribute.

Definition at line 322 of file eagle_parser.h.

References OPTIONAL_XML_ATTRIBUTE< T >::Get().

◆ operator*() [2/2]

template<typename T >
const T & OPTIONAL_XML_ATTRIBUTE< T >::operator* ( ) const
inline

Return a constant reference to the value of the attribute assuming it is available.

Returns
const T& - the value of the attribute.

Definition at line 332 of file eagle_parser.h.

References OPTIONAL_XML_ATTRIBUTE< T >::CGet().

◆ operator->() [1/2]

template<typename T >
T * OPTIONAL_XML_ATTRIBUTE< T >::operator-> ( )
inline

Return a pointer to the value of the attribute assuming it is available.

Returns
T* - the value of the attribute.

Definition at line 342 of file eagle_parser.h.

References OPTIONAL_XML_ATTRIBUTE< T >::Get().

◆ operator->() [2/2]

template<typename T >
const T * OPTIONAL_XML_ATTRIBUTE< T >::operator-> ( ) const
inline

Return a constant pointer to the value of the attribute assuming it is available.

Returns
const T* - the value of the attribute.

Definition at line 352 of file eagle_parser.h.

References OPTIONAL_XML_ATTRIBUTE< T >::CGet().

◆ operator=() [1/2]

template<typename T >
OPTIONAL_XML_ATTRIBUTE< T > & OPTIONAL_XML_ATTRIBUTE< T >::operator= ( const wxString &  aData)
inline

Assign to a string (optionally) containing the data.

Parameters
aDatais a wxString that should be converted to T. If the string is empty, the attribute is set to unavailable.

Definition at line 252 of file eagle_parser.h.

References OPTIONAL_XML_ATTRIBUTE< T >::m_isAvailable, and OPTIONAL_XML_ATTRIBUTE< T >::Set().

◆ operator=() [2/2]

template<typename T >
OPTIONAL_XML_ATTRIBUTE< T > & OPTIONAL_XML_ATTRIBUTE< T >::operator= ( aData)
inline

Assign to an object of the base type containing the data.

Parameters
aDatais the actual value of the attribute. Calling this assignment, the attribute is automatically made available.

Definition at line 268 of file eagle_parser.h.

References OPTIONAL_XML_ATTRIBUTE< T >::m_data, and OPTIONAL_XML_ATTRIBUTE< T >::m_isAvailable.

◆ operator==()

template<typename T >
bool OPTIONAL_XML_ATTRIBUTE< T >::operator== ( const T &  aOther) const
inline
Parameters
aOtheris the object of the base type that should be compared with this one.

Definition at line 279 of file eagle_parser.h.

References OPTIONAL_XML_ATTRIBUTE< T >::m_data, and OPTIONAL_XML_ATTRIBUTE< T >::m_isAvailable.

◆ Set()

template<typename T >
void OPTIONAL_XML_ATTRIBUTE< T >::Set ( const wxString &  aString)
inline

Attempt to convert a string to the base type.

Parameters
aStringis the string that will be converted to the base type.

Definition at line 289 of file eagle_parser.h.

References OPTIONAL_XML_ATTRIBUTE< T >::m_data, and OPTIONAL_XML_ATTRIBUTE< T >::m_isAvailable.

Referenced by OPTIONAL_XML_ATTRIBUTE< T >::operator=(), and OPTIONAL_XML_ATTRIBUTE< T >::OPTIONAL_XML_ATTRIBUTE().

Member Data Documentation

◆ m_data

◆ m_isAvailable


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