#include <ScelDatabase.hh>

Inheritance diagram for CASM::DB::Database< Supercell >:

Detailed Description

Supercell references and pointers must remain valid, therefore the ScelDatabase implementation should typically be the same for different backends, differing only for open, commit, and close. This class should be inherited by those classes to implement all other required methods.

Database insert and emplace methods by convention do not enforce canonical forms. That logic is included in Supercell::insert, which is the safest way to insert new Supercell in the database. But in cases where it is known that a Supercell is generated in canonical form, the Database insert and emplace methods may be used directly.

Derived ScelDatabase must implement public methods:

Definition at line 32 of file ScelDatabase.hh.

Public Types
typedef DatabaseIterator< Supercell >	iterator

typedef Supercell	value_type

typedef Index	size_type

typedef Base::MostDerived	MostDerived

Public Member Functions
	Database (const PrimClex &_primclex)

virtual	~Database ()

iterator	begin () const override

iterator	end () const override

size_type	size () const override

std::pair< iterator, bool >	insert (const Supercell &obj) override

std::pair< iterator, bool >	insert (const Supercell &&obj) override

template<typename... Args>
std::pair< iterator, bool >	emplace (Args &&... args)

iterator	erase (iterator pos) override

iterator	find (const std::string &name_or_alias) const override

bool	empty () const

std::pair< iterator, bool >	set_alias (const std::string &name_or_alias, const std::string &alias)
	For setting an alias. More...

std::string	name (const std::string &name_or_alias) const

std::string	alias (const std::string &name_or_alias) const
	Get alias from name_or_alias. More...

void	insert (InputIt first, InputIt last)

virtual iterator	erase (iterator pos)=0

size_type	erase (const std::string &name_or_alias)

size_type	erase (const Supercell &obj)

virtual size_type	count (const std::string &name_or_alias) const

virtual void	commit ()=0

Selection< Supercell > &	master_selection ()

const Selection< Supercell > &	master_selection () const

virtual DatabaseBase &	open ()=0

virtual void	close ()=0

const PrimClex &	primclex () const

const Structure &	prim () const

double	crystallography_tol () const

Protected Types
typedef std::set< Supercell >::iterator	base_iterator

Protected Member Functions
std::pair< iterator, bool >	_on_insert_or_emplace (const std::pair< base_iterator, bool > &result)

void	clear ()

iterator	_iterator (base_iterator base_it) const

void	read_aliases ()

void	write_aliases ()

void	clear_name (const _ValueType &obj) const
	Only ValDatabase<ValueType> is allowed to do clear_name. More...

void	set_id (const _ValueType &obj, Index id) const
	Only ValDatabase<ValueType> is allowed to do a const id change. More...

void	set_id (const _ValueType &obj, std::string id) const
	Only ValDatabase<ValueType> is allowed to do a const id change. More...

MostDerived &	derived ()

const MostDerived &	derived () const

Protected Attributes
std::map< std::string, base_iterator >	m_name_to_scel

std::set< Supercell >	m_scel_list

Private Attributes
std::map< std::string, std::string >	m_name_to_alias

std::map< std::string, std::string >	m_alias_to_name

Selection< Supercell >	m_master_selection

const PrimClex *	m_primclex

Member Typedef Documentation

◆ base_iterator

typedef std::set<Supercell>::iterator CASM::DB::Database< Supercell >::base_iterator

protected

Definition at line 61 of file ScelDatabase.hh.

◆ iterator

typedef DatabaseIterator<Supercell > CASM::DB::ValDatabase< Supercell >::iterator

inherited

Definition at line 223 of file Database.hh.

◆ MostDerived

typedef Base::MostDerived CASM::HasPrimClex< CRTPBase< DatabaseBase > >::MostDerived

inherited

Definition at line 16 of file HasPrimClex.hh.

◆ size_type

typedef Index CASM::DB::ValDatabase< Supercell >::size_type

inherited

Definition at line 225 of file Database.hh.

◆ value_type

typedef Supercell CASM::DB::ValDatabase< Supercell >::value_type

inherited

Definition at line 224 of file Database.hh.

Constructor & Destructor Documentation

◆ Database()

CASM::DB::Database< Supercell >::Database ( const PrimClex & _primclex )

inline

Definition at line 34 of file ScelDatabase.hh.

◆ ~Database()

virtual CASM::DB::Database< Supercell >::~Database ( )

inlinevirtual

Definition at line 36 of file ScelDatabase.hh.

Member Function Documentation

◆ _iterator()

Database< Supercell >::iterator CASM::DB::Database< Supercell >::_iterator ( base_iterator base_it ) const

protected

Definition at line 66 of file ScelDatabase.cc.

◆ _on_insert_or_emplace()

std::pair< Database< Supercell >::iterator, bool > CASM::DB::Database< Supercell >::_on_insert_or_emplace ( const std::pair< base_iterator, bool > & result )

protected

Definition at line 48 of file ScelDatabase.cc.

◆ alias()

std::string CASM::DB::ValDatabase< Supercell >::alias ( const std::string & name_or_alias ) const

inherited

Get alias from name_or_alias.

Get alias from name_or_alias

Checks if name_or_alias is a known alias
If yes, returns name_or_alias
If no, checks if name_or_alias is a name corresponding to a known alias
- If yes, returns alias
- If no, (because name_or_alias is an invalid name, or because name_or_alias is a valid name without an alias), returns empty string

Definition at line 250 of file Database_impl.hh.

◆ begin()

Database< Supercell >::iterator CASM::DB::Database< Supercell >::begin ( ) const

overridevirtual

Implements CASM::DB::ValDatabase< Supercell >.

Definition at line 6 of file ScelDatabase.cc.

◆ clear()

void CASM::DB::Database< Supercell >::clear ( )

protected

Definition at line 61 of file ScelDatabase.cc.

◆ clear_name()

void CASM::DB::ValDatabase< Supercell >::clear_name ( const _ValueType & obj ) const

inlineprotectedinherited

Only ValDatabase<ValueType> is allowed to do clear_name.

Definition at line 298 of file Database.hh.

◆ close()

virtual void CASM::DB::DatabaseBase::close ( )

pure virtualinherited

Implemented in CASM::DB::jsonPropertiesDatabase, CASM::DB::jsonDatabase< Configuration >, and CASM::DB::jsonDatabase< Supercell >.

◆ commit()

virtual void CASM::DB::ValDatabase< Supercell >::commit ( )

pure virtualinherited

Implements CASM::DB::DatabaseBase.

Implemented in CASM::DB::jsonDatabase< Supercell >.

◆ count()

virtual size_type CASM::DB::ValDatabase< Supercell >::count ( const std::string & name_or_alias ) const

inlinevirtualinherited

Definition at line 268 of file Database.hh.

◆ crystallography_tol()

double CASM::HasPrimClex< CRTPBase< DatabaseBase > >::crystallography_tol

inherited

Definition at line 21 of file HasPrimClex_impl.hh.

◆ derived() [1/2]

template<typename _MostDerived >

MostDerived& notstd::CRTPBase< _MostDerived >::derived ( )

inlineprotectedinherited

Definition at line 13 of file CRTPBase.hh.

◆ derived() [2/2]

template<typename _MostDerived >

const MostDerived& notstd::CRTPBase< _MostDerived >::derived ( ) const

inlineprotectedinherited

Definition at line 15 of file CRTPBase.hh.

◆ emplace()

template<typename... Args>

std::pair<iterator, bool> CASM::DB::Database< Supercell >::emplace ( Args &&... args )

inline

Definition at line 49 of file ScelDatabase.hh.

◆ empty()

bool CASM::DB::ValDatabase< Supercell >::empty ( ) const

inlineinherited

Definition at line 236 of file Database.hh.

◆ end()

Database< Supercell >::iterator CASM::DB::Database< Supercell >::end ( ) const

overridevirtual

Implements CASM::DB::ValDatabase< Supercell >.

Definition at line 10 of file ScelDatabase.cc.

◆ erase() [1/4]

size_type CASM::DB::ValDatabase< Supercell >::erase ( const std::string & name_or_alias )

inlineinherited

Definition at line 262 of file Database.hh.

◆ erase() [2/4]

size_type CASM::DB::ValDatabase< Supercell >::erase ( const ValueType & obj )

inlineinherited

Definition at line 266 of file Database.hh.

◆ erase() [3/4]

Database< Supercell >::iterator CASM::DB::Database< Supercell >::erase ( iterator pos )

override

Definition at line 28 of file ScelDatabase.cc.

◆ erase() [4/4]

virtual iterator CASM::DB::ValDatabase< Supercell >::erase ( iterator pos )

pure virtualinherited

◆ find()

Database< Supercell >::iterator CASM::DB::Database< Supercell >::find ( const std::string & name_or_alias ) const

overridevirtual

Implements CASM::DB::ValDatabase< Supercell >.

Definition at line 36 of file ScelDatabase.cc.

◆ insert() [1/3]

std::pair< Database< Supercell >::iterator, bool > CASM::DB::Database< Supercell >::insert ( const Supercell && obj )

overridevirtual

Implements CASM::DB::ValDatabase< Supercell >.

Definition at line 23 of file ScelDatabase.cc.

◆ insert() [2/3]

std::pair< Database< Supercell >::iterator, bool > CASM::DB::Database< Supercell >::insert ( const Supercell & obj )

overridevirtual

Implements CASM::DB::ValDatabase< Supercell >.

Definition at line 18 of file ScelDatabase.cc.

◆ insert() [3/3]

void CASM::DB::ValDatabase< Supercell >::insert	(	InputIt	first,
		InputIt	last
	)

inlineinherited

Definition at line 256 of file Database.hh.

◆ master_selection() [1/2]

Selection<Supercell >& CASM::DB::ValDatabase< Supercell >::master_selection ( )

inlineinherited

Definition at line 285 of file Database.hh.

◆ master_selection() [2/2]

const Selection<Supercell >& CASM::DB::ValDatabase< Supercell >::master_selection ( ) const

inlineinherited

Definition at line 287 of file Database.hh.

◆ name()

std::string CASM::DB::ValDatabase< Supercell >::name ( const std::string & name_or_alias ) const

inherited

Get name from name_or_alias

Checks if name_or_alias is a known alias
If known alias, returns associated name
If not known alias, assumed to be a name and returns name_or_alias

Definition at line 247 of file Database_impl.hh.

◆ open()

virtual DatabaseBase& CASM::DB::DatabaseBase::open ( )

pure virtualinherited

Implemented in CASM::DB::jsonPropertiesDatabase, CASM::DB::jsonDatabase< Configuration >, and CASM::DB::jsonDatabase< Supercell >.

◆ prim()

const Structure & CASM::HasPrimClex< CRTPBase< DatabaseBase > >::prim

inherited

Definition at line 19 of file HasPrimClex_impl.hh.

◆ primclex()

const PrimClex& CASM::DB::DatabaseBase::primclex ( ) const

inlineinherited

Definition at line 35 of file Database.hh.

◆ read_aliases()

void CASM::DB::ValDatabase< Supercell >::read_aliases

protectedinherited

Definition at line 292 of file Database_impl.hh.

◆ set_alias()

std::pair< typename ValDatabase< Supercell >::iterator, bool > CASM::DB::ValDatabase< Supercell >::set_alias	(	const std::string &	name_or_alias,
		const std::string &	alias
	)

inherited

For setting an alias.

Definition at line 239 of file Database_impl.hh.

◆ set_id() [1/2]

void CASM::DB::ValDatabase< Supercell >::set_id	(	const _ValueType &	obj,
		Index	id
	)		const

inlineprotectedinherited

Only ValDatabase<ValueType> is allowed to do a const id change.

Definition at line 304 of file Database.hh.

◆ set_id() [2/2]

void CASM::DB::ValDatabase< Supercell >::set_id	(	const _ValueType &	obj,
		std::string	id
	)		const

inlineprotectedinherited

Only ValDatabase<ValueType> is allowed to do a const id change.

Definition at line 310 of file Database.hh.

◆ size()

Database< Supercell >::size_type CASM::DB::Database< Supercell >::size ( ) const

overridevirtual

Implements CASM::DB::ValDatabase< Supercell >.

Definition at line 14 of file ScelDatabase.cc.

◆ write_aliases()

void CASM::DB::ValDatabase< Supercell >::write_aliases

protectedinherited

Definition at line 294 of file Database_impl.hh.

Member Data Documentation

◆ m_alias_to_name

std::map<std::string, std::string> CASM::DB::ValDatabase< Supercell >::m_alias_to_name

privateinherited

Definition at line 319 of file Database.hh.

◆ m_master_selection

Selection<Supercell > CASM::DB::ValDatabase< Supercell >::m_master_selection

privateinherited

Definition at line 322 of file Database.hh.

◆ m_name_to_alias

std::map<std::string, std::string> CASM::DB::ValDatabase< Supercell >::m_name_to_alias

privateinherited

Definition at line 316 of file Database.hh.

◆ m_name_to_scel

std::map<std::string, base_iterator> CASM::DB::Database< Supercell >::m_name_to_scel

protected

Definition at line 70 of file ScelDatabase.hh.

◆ m_primclex

const PrimClex* CASM::DB::DatabaseBase::m_primclex

privateinherited

Definition at line 38 of file Database.hh.

◆ m_scel_list

std::set<Supercell> CASM::DB::Database< Supercell >::m_scel_list

protected

Definition at line 71 of file ScelDatabase.hh.

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

/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/database/ScelDatabase.hh
/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/src/casm/database/ScelDatabase.cc

Detailed Description

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Attributes

Member Typedef Documentation

◆ base_iterator

◆ iterator

◆ MostDerived

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ Database()

◆ ~Database()

Member Function Documentation

◆ _iterator()

◆ _on_insert_or_emplace()

◆ alias()

◆ begin()

◆ clear()

◆ clear_name()

◆ close()

◆ commit()

◆ count()

◆ crystallography_tol()

◆ derived() [1/2]

◆ derived() [2/2]

◆ emplace()

◆ empty()

◆ end()

◆ erase() [1/4]

◆ erase() [2/4]

◆ erase() [3/4]

◆ erase() [4/4]

◆ find()

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ master_selection() [1/2]

◆ master_selection() [2/2]

◆ name()

◆ open()

◆ prim()

◆ primclex()

◆ read_aliases()

◆ set_alias()

◆ set_id() [1/2]

◆ set_id() [2/2]

◆ size()

◆ write_aliases()

Member Data Documentation

◆ m_alias_to_name

◆ m_master_selection

◆ m_name_to_alias

◆ m_name_to_scel

◆ m_primclex

◆ m_scel_list