CASM::DB::PropertiesDatabaseIteratorBase Class Reference

#include <PropertiesDatabase.hh>

Inheritance diagram for CASM::DB::PropertiesDatabaseIteratorBase:

Detailed Description

Dereferencing PropertiesDatabaseIteratorBase only provides const references, whether the underlying resource is persistent (jsonPropertiesDatabase) or temporary (other database types). Changing database entries must be done via copy then insert, or update.

PropertiesDatabaseIteratorBase should always be dereferenceable (except end or when default constructed), though the reference may be invalidated when a second PropertiesDatabaseIteratorBase is dereferenced, dereferencing the first again should be valid (though it may require re-allocation):

DerivedDatabaseIterator A = ... get from DerivedDatabase ...;
const MappedProperties& A_ref1 = *A;  // ok
A_ref1.method();  // ok
A->method(); // ok
 
DerivedDatabaseIterator B = ... get from DerivedDatabase ...;
const MappedProperties& B_ref = *B;  // ok, but now A_ref1 may be
invalidated A_ref1.method();  // maybe not ok A->method(); // ok
B->method(); // ok
 
const MappedProperties& A_ref2 = *A;  // ok, but now B_ref may be
invalidated A_ref1.method();  // maybe not ok A_ref2.method();  // ok
B_ref.method(); // maybe not ok
A->method(); // ok
B->method(); // ok

Derived classes must implement private methods:

• std::string name() const
• void increment()
• reference dereference() const
• PropertiesDatabaseIteratorBase *_clone() const

Definition at line 52 of file PropertiesDatabase.hh.

Public Types
typedef MappedProperties	value_type
typedef const value_type &	reference

Public Member Functions
	PropertiesDatabaseIteratorBase ()
virtual	~PropertiesDatabaseIteratorBase ()
std::unique_ptr< PropertiesDatabaseIteratorBase >	clone () const

Private Member Functions
virtual void	increment ()=0
virtual reference	dereference () const =0
virtual bool	equal (const PropertiesDatabaseIteratorBase &other) const =0
virtual PropertiesDatabaseIteratorBase *	_clone () const =0
virtual long	distance_to (const PropertiesDatabaseIteratorBase &other) const =0

Private Attributes
friend	PropertiesDatabaseIterator

Member Typedef Documentation

reference

typedef const value_type& CASM::DB::PropertiesDatabaseIteratorBase::reference

Definition at line 57 of file PropertiesDatabase.hh.

value_type

typedef MappedProperties CASM::DB::PropertiesDatabaseIteratorBase::value_type

Definition at line 56 of file PropertiesDatabase.hh.

Constructor & Destructor Documentation

PropertiesDatabaseIteratorBase()

CASM::DB::PropertiesDatabaseIteratorBase::PropertiesDatabaseIteratorBase ( )

inline

Definition at line 59 of file PropertiesDatabase.hh.

~PropertiesDatabaseIteratorBase()

virtual CASM::DB::PropertiesDatabaseIteratorBase::~PropertiesDatabaseIteratorBase ( )

inlinevirtual

Definition at line 60 of file PropertiesDatabase.hh.

Member Function Documentation

_clone()

virtual PropertiesDatabaseIteratorBase* CASM::DB::PropertiesDatabaseIteratorBase::_clone ( ) const

privatepure virtual

Implemented in CASM::DB::jsonPropertiesDatabaseIterator.

clone()

std::unique_ptr<PropertiesDatabaseIteratorBase> CASM::DB::PropertiesDatabaseIteratorBase::clone ( ) const

inline

Definition at line 62 of file PropertiesDatabase.hh.

dereference()

virtual reference CASM::DB::PropertiesDatabaseIteratorBase::dereference ( ) const

privatepure virtual

Implemented in CASM::DB::jsonPropertiesDatabaseIterator.

distance_to()

virtual long CASM::DB::PropertiesDatabaseIteratorBase::distance_to ( const PropertiesDatabaseIteratorBase &  other ) const

privatepure virtual

Implemented in CASM::DB::jsonPropertiesDatabaseIterator.

equal()

virtual bool CASM::DB::PropertiesDatabaseIteratorBase::equal ( const PropertiesDatabaseIteratorBase &  other ) const

privatepure virtual

Implemented in CASM::DB::jsonPropertiesDatabaseIterator.

increment()

virtual void CASM::DB::PropertiesDatabaseIteratorBase::increment ( )

privatepure virtual

Implemented in CASM::DB::jsonPropertiesDatabaseIterator.

Member Data Documentation

PropertiesDatabaseIterator

friend CASM::DB::PropertiesDatabaseIteratorBase::PropertiesDatabaseIterator

private

Definition at line 53 of file PropertiesDatabase.hh.

---

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

• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/database/PropertiesDatabase.hh