NSVD Reader  0.0.1
nodamushi::svd::Enumeration< STR > Struct Template Reference

<enumeratedValues> element. iterable More...

#include <Enumeration.hpp>

Inheritance diagram for nodamushi::svd::Enumeration< STR >:

Public Types

using iterator = typename std::vector< EnumeratedValue< STR > >::iterator
 
using const_iterator = typename std::vector< EnumeratedValue< STR > >::const_iterator
 

Public Member Functions

bool empty () const noexcept
 <enumeratedValue> is empty More...
 
size_t size () const noexcept
 count of <enumeratedValue> More...
 
size_t length () const noexcept
 count of <enumeratedValue> More...
 
iterator begin () noexcept
 enumeratedValue iterator. More...
 
iterator end () noexcept
 enumeratedValue iterator. More...
 
const_iterator begin () const noexcept
 enumeratedValue iterator. More...
 
const_iterator end () const noexcept
 enumeratedValue iterator. More...
 

Public Attributes

value< path< std::string >,ATTR > derivedFrom
 derivedFrom attribute More...
 
value< STR,ELEMENT > name
 <name> More...
 
value< STR,ELEMENT > headerEnumName
 <headerEnumName> More...
 
value< EnumUsage,ELEMENT > usage
 <usage> More...
 
value< std::vector< EnumeratedValue< STR > >,ELEMENT > enumeratedValue
 <enumeratedValue> list More...
 

Detailed Description

template<typename STR>
struct nodamushi::svd::Enumeration< STR >

<enumeratedValues> element. iterable

Note
This class name is Enumeration because <enumeratedValues> element type is defined as enumerationType in the SVD Schema File.
See also
http://www.keil.com/pack/doc/CMSIS/SVD/html/elem_registers.html#elem_enumeratedValues
http://www.keil.com/pack/doc/CMSIS/SVD/html/schema_1_2_gr.html

Definition at line 35 of file Enumeration.hpp.

Member Typedef Documentation

◆ const_iterator

template<typename STR>
using nodamushi::svd::Enumeration< STR >::const_iterator = typename std::vector<EnumeratedValue<STR> >::const_iterator

Definition at line 74 of file Enumeration.hpp.

◆ iterator

template<typename STR>
using nodamushi::svd::Enumeration< STR >::iterator = typename std::vector<EnumeratedValue<STR> >::iterator

Definition at line 73 of file Enumeration.hpp.

Member Function Documentation

◆ begin() [1/2]

template<typename STR>
iterator nodamushi::svd::Enumeration< STR >::begin ( )
inlinenoexcept

enumeratedValue iterator.

Definition at line 76 of file Enumeration.hpp.

◆ begin() [2/2]

template<typename STR>
const_iterator nodamushi::svd::Enumeration< STR >::begin ( ) const
inlinenoexcept

enumeratedValue iterator.

Definition at line 86 of file Enumeration.hpp.

◆ empty()

template<typename STR>
bool nodamushi::svd::Enumeration< STR >::empty ( ) const
inlinenoexcept

<enumeratedValue> is empty

Returns
<enumeratedValue> is empty

Definition at line 53 of file Enumeration.hpp.

◆ end() [1/2]

template<typename STR>
iterator nodamushi::svd::Enumeration< STR >::end ( )
inlinenoexcept

enumeratedValue iterator.

Definition at line 81 of file Enumeration.hpp.

◆ end() [2/2]

template<typename STR>
const_iterator nodamushi::svd::Enumeration< STR >::end ( ) const
inlinenoexcept

enumeratedValue iterator.

Definition at line 91 of file Enumeration.hpp.

◆ length()

template<typename STR>
size_t nodamushi::svd::Enumeration< STR >::length ( ) const
inlinenoexcept

count of <enumeratedValue>

Returns
count of <enumeratedValue>

Definition at line 69 of file Enumeration.hpp.

◆ size()

template<typename STR>
size_t nodamushi::svd::Enumeration< STR >::size ( ) const
inlinenoexcept

count of <enumeratedValue>

Returns
count of <enumeratedValue>

Definition at line 61 of file Enumeration.hpp.

Member Data Documentation

◆ derivedFrom

template<typename STR>
value< path<std::string> ,ATTR> nodamushi::svd::Enumeration< STR >::derivedFrom

derivedFrom attribute

Definition at line 38 of file Enumeration.hpp.

◆ enumeratedValue

template<typename STR>
value< std::vector<EnumeratedValue<STR> > ,ELEMENT> nodamushi::svd::Enumeration< STR >::enumeratedValue

<enumeratedValue> list

Definition at line 46 of file Enumeration.hpp.

◆ headerEnumName

template<typename STR>
value< STR ,ELEMENT> nodamushi::svd::Enumeration< STR >::headerEnumName

<headerEnumName>

Definition at line 42 of file Enumeration.hpp.

◆ name

template<typename STR>
value< STR ,ELEMENT> nodamushi::svd::Enumeration< STR >::name

<name>

Definition at line 40 of file Enumeration.hpp.

◆ usage

template<typename STR>
value< EnumUsage ,ELEMENT> nodamushi::svd::Enumeration< STR >::usage

<usage>

Definition at line 44 of file Enumeration.hpp.


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