#include <DatabaseNameIterator.hh>
Inheritance diagram for CASM::DB::DatabaseNameIterator< ValueType, DatabaseType, ObjIterator >:
Detailed Description
template<typename ValueType, typename DatabaseType, typename ObjIterator>
class CASM::DB::DatabaseNameIterator< ValueType, DatabaseType, ObjIterator >
DatabaseIterator for implementations using std::map<std::string, ObjIterator>
For example, jsonDatabase<Configuration>, stores:
- a std::set<Configuration> to efficiently check for unique Configuration
- and a std::map<std::string, std::set<Configuration>::iterator> to efficiently find Configuration by name. By iterating over the map, configurations will be iterated in name order rather than Configuration sort order.
DatabaseIterators must implement public methods:
- Default constructor
- std::string name() const
- std::unique_ptr<DatabaseIteratorBase<ValueType> > clone() const
DatabaseIterators must implement private methods:
- bool is_end() const
- void increment()
- reference dereference() const
- DatabaseIteratorBase *_clone() const
Definition at line 33 of file DatabaseNameIterator.hh.
Public Types | |
| typedef ValueType | value_type |
| typedef const value_type & | reference |
Public Member Functions | |
| DatabaseNameIterator () | |
| std::string | name () const override |
| std::unique_ptr< DatabaseIteratorBase< ValueType > > | clone () const |
Private Types | |
| typedef std::map< std::string, ObjIterator >::const_iterator | base_iterator |
Private Member Functions | |
| DatabaseNameIterator (base_iterator _it) | |
| base_iterator | base () const |
| bool | equal (const DatabaseIteratorBase< ValueType > &other) const override |
| void | increment () override |
| const ValueType & | dereference () const override |
| DatabaseNameIterator * | _clone () const override |
Private Attributes | |
| friend | DatabaseType |
| base_iterator | m_it |
| friend | DatabaseIterator< ValueType > |
Member Typedef Documentation
◆ base_iterator
|
private |
Definition at line 47 of file DatabaseNameIterator.hh.
◆ reference
|
inherited |
Definition at line 86 of file Database.hh.
◆ value_type
|
inherited |
Definition at line 85 of file Database.hh.
Constructor & Destructor Documentation
◆ DatabaseNameIterator() [1/2]
|
inline |
Definition at line 35 of file DatabaseNameIterator.hh.
◆ DatabaseNameIterator() [2/2]
|
inlineprivate |
Definition at line 49 of file DatabaseNameIterator.hh.
Member Function Documentation
◆ _clone()
|
inlineoverrideprivatevirtual |
Implements CASM::DB::DatabaseIteratorBase< ValueType >.
Definition at line 68 of file DatabaseNameIterator.hh.
◆ base()
|
inlineprivate |
Definition at line 51 of file DatabaseNameIterator.hh.
◆ clone()
|
inline |
Definition at line 39 of file DatabaseNameIterator.hh.
◆ dereference()
|
inlineoverrideprivatevirtual |
Implements CASM::DB::DatabaseIteratorBase< ValueType >.
Definition at line 59 of file DatabaseNameIterator.hh.
◆ equal()
|
inlineoverrideprivatevirtual |
Implements CASM::DB::DatabaseIteratorBase< ValueType >.
Definition at line 53 of file DatabaseNameIterator.hh.
◆ increment()
|
inlineoverrideprivatevirtual |
Implements CASM::DB::DatabaseIteratorBase< ValueType >.
Definition at line 57 of file DatabaseNameIterator.hh.
◆ name()
|
inlineoverridevirtual |
Implements CASM::DB::DatabaseIteratorBase< ValueType >.
Definition at line 37 of file DatabaseNameIterator.hh.
Member Data Documentation
◆ DatabaseIterator< ValueType >
|
privateinherited |
Definition at line 82 of file Database.hh.
◆ DatabaseType
|
private |
Definition at line 44 of file DatabaseNameIterator.hh.
◆ m_it
|
private |
Definition at line 72 of file DatabaseNameIterator.hh.
The documentation for this class was generated from the following file:
- /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/database/DatabaseNameIterator.hh
