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...

T	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 OPT. This class should be replaced with a simple typedef per type using std::optional when C++17 is published.

Definition at line 188 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 201 of file eagle_parser.h.

                              :
         m_isAvailable( false ),
         m_data( T() )
     {}

◆ OPTIONAL_XML_ATTRIBUTE() [2/3]

template<typename T>

OPTIONAL_XML_ATTRIBUTE< T >::OPTIONAL_XML_ATTRIBUTE ( const wxString & aData )

inline

Parameters

aData is 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 211 of file eagle_parser.h.

     {
         m_data = T();
         m_isAvailable = !aData.IsEmpty();
 
         if( m_isAvailable )
             Set( aData );
     }

◆ OPTIONAL_XML_ATTRIBUTE() [3/3]

template<typename T>

template<typename V = T>

OPTIONAL_XML_ATTRIBUTE< T >::OPTIONAL_XML_ATTRIBUTE ( T aData )

inline

Parameters

aData is the value of the XML attribute. If this constructor is called, the attribute is available.

Definition at line 225 of file eagle_parser.h.

                                       :
         m_isAvailable( true ),
         m_data( aData )
     {}

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 303 of file eagle_parser.h.

     {
         assert( m_isAvailable );
         return m_data;
     }

Referenced by ETEXT::ConvertSize(), SCH_EAGLE_PLUGIN::loadTextAttributes(), OPTIONAL_XML_ATTRIBUTE< bool >::operator *(), and OPTIONAL_XML_ATTRIBUTE< bool >::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 292 of file eagle_parser.h.

     {
         assert( m_isAvailable );
         return m_data;
     }

Referenced by SCH_EAGLE_PLUGIN::loadLibrary(), SCH_EAGLE_PLUGIN::loadPin(), OPTIONAL_XML_ATTRIBUTE< bool >::operator *(), and OPTIONAL_XML_ATTRIBUTE< bool >::operator->().

◆ 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 314 of file eagle_parser.h.

     {
         return 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 324 of file eagle_parser.h.

     {
         return CGet();
     }

◆ operator bool()

template<typename T>

OPTIONAL_XML_ATTRIBUTE< T >::operator bool ( ) const

inline

Returns: bool the availability of the attribute.

Definition at line 233 of file eagle_parser.h.

     {
         return m_isAvailable;
     }

◆ 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 334 of file eagle_parser.h.

     {
         return &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 344 of file eagle_parser.h.

     {
         return &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

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

Definition at line 244 of file eagle_parser.h.

     {
         m_isAvailable = !aData.IsEmpty();
 
         if( m_isAvailable )
             Set( aData );
 
         return *this;
     }

◆ operator=() [2/2]

template<typename T>

OPTIONAL_XML_ATTRIBUTE<T>& OPTIONAL_XML_ATTRIBUTE< T >::operator= ( T aData )

inline

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

Parameters

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

Definition at line 260 of file eagle_parser.h.

     {
         m_data = aData;
         m_isAvailable = true;
 
         return *this;
     }

◆ operator==()

template<typename T>

bool OPTIONAL_XML_ATTRIBUTE< T >::operator== ( const T & aOther ) const

inline

Parameters

aOther is the object of the base type that should be compared with this one.

Definition at line 271 of file eagle_parser.h.

     {
         return m_isAvailable && ( aOther == m_data );
     }

◆ Set()

template<typename T>

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

inline

Attempt to convert a string to the base type.

Parameters

aString is the string that will be converted to the base type.

Definition at line 281 of file eagle_parser.h.

     {
         m_data = Convert<T>( aString );
         m_isAvailable = !aString.IsEmpty();
     }

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

Member Data Documentation

◆ m_data

template<typename T>

T OPTIONAL_XML_ATTRIBUTE< T >::m_data

private

The actual data if m_isAvailable is true; otherwise, garbage.

Definition at line 195 of file eagle_parser.h.

Referenced by OPTIONAL_XML_ATTRIBUTE< bool >::CGet(), OPTIONAL_XML_ATTRIBUTE< bool >::Get(), OPTIONAL_XML_ATTRIBUTE< bool >::operator=(), OPTIONAL_XML_ATTRIBUTE< bool >::operator==(), OPTIONAL_XML_ATTRIBUTE< bool >::OPTIONAL_XML_ATTRIBUTE(), and OPTIONAL_XML_ATTRIBUTE< bool >::Set().

◆ m_isAvailable

template<typename T>

bool OPTIONAL_XML_ATTRIBUTE< T >::m_isAvailable

private

A boolean indicating if the data is present or not.

Definition at line 192 of file eagle_parser.h.

Referenced by OPTIONAL_XML_ATTRIBUTE< bool >::CGet(), OPTIONAL_XML_ATTRIBUTE< bool >::Get(), OPTIONAL_XML_ATTRIBUTE< bool >::operator bool(), OPTIONAL_XML_ATTRIBUTE< bool >::operator=(), OPTIONAL_XML_ATTRIBUTE< bool >::operator==(), OPTIONAL_XML_ATTRIBUTE< bool >::OPTIONAL_XML_ATTRIBUTE(), and OPTIONAL_XML_ATTRIBUTE< bool >::Set().

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

eagle_parser.h

Public Member Functions

Private Attributes

Detailed Description

template<typename T> class OPTIONAL_XML_ATTRIBUTE< T >

Constructor & Destructor Documentation

◆ OPTIONAL_XML_ATTRIBUTE() [1/3]

◆ OPTIONAL_XML_ATTRIBUTE() [2/3]

◆ OPTIONAL_XML_ATTRIBUTE() [3/3]

Member Function Documentation

◆ CGet()

◆ Get()

◆ operator *() [1/2]

◆ operator *() [2/2]

◆ operator bool()

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Set()

Member Data Documentation

◆ m_data

◆ m_isAvailable

template<typename T>
class OPTIONAL_XML_ATTRIBUTE< T >