CASM::QueryHandler< _DataObject > Class Template Reference

#include <QueryHandler.hh>

Inheritance diagram for CASM::QueryHandler< _DataObject >:

Detailed Description

template<typename _DataObject>
class CASM::QueryHandler< _DataObject >

Definition at line 18 of file QueryHandler.hh.

Public Types
typedef _DataObject	DataObject

Public Member Functions
	QueryHandler (const ProjectSettings &set)
	~QueryHandler ()
DataFormatterDictionary < DataObject > &	dict ()
const DataFormatterDictionary < DataObject > &	dict () const
void	set_selected (const typename QueryTraits< DataObject >::Selected &selection)
	Set the selection to be used for the 'selected' column. More...
void	set_selected (const typename QueryTraits< DataObject >::Selection &selection)
	Set the selection to be used for the 'selected' column. More...
void	add_alias (const std::string &alias_name, const std::string &alias_command)
	Add user-defined query alias. More...
const std::map< std::string, std::string > &	aliases () const
	const Access aliases map More...
std::unique_ptr< QueryHandler < DataObject > >	clone () const

Private Member Functions
std::map< std::string, std::string > &	_aliases ()
	Access aliases map. More...
QueryHandler< DataObject > *	_clone () const override

Private Attributes
const ProjectSettings *	m_set
std::map< std::string, std::string >	m_aliases
DataFormatterDictionary < DataObject >	m_dict
std::map< std::string, std::shared_ptr < RuntimeLibrary > >	m_lib

Member Typedef Documentation

template<typename _DataObject>

typedef _DataObject CASM::QueryHandler< _DataObject >::DataObject

Definition at line 22 of file QueryHandler.hh.

Constructor & Destructor Documentation

template<typename DataObject >

CASM::QueryHandler< DataObject >::QueryHandler

(

const ProjectSettings &

set

)

Definition at line 9 of file QueryHandler_impl.hh.

template<typename DataObject >

CASM::QueryHandler< DataObject >::~QueryHandler

(

)

Definition at line 21 of file QueryHandler_impl.hh.

Member Function Documentation

template<typename _DataObject>

std::map<std::string, std::string>& CASM::QueryHandler< _DataObject >::_aliases ( )

inlineprivate

Access aliases map.

• key: alias name
• value: alias command

Definition at line 66 of file QueryHandler.hh.

template<typename _DataObject>

QueryHandler<DataObject>* CASM::QueryHandler< _DataObject >::_clone ( ) const

inlineoverrideprivatevirtual

Implements notstd::Cloneable.

Definition at line 70 of file QueryHandler.hh.

template<typename DataObject >

void CASM::QueryHandler< DataObject >::add_alias	(	const std::string &	alias_name,
		const std::string &	alias_command
	)

Add user-defined query alias.

• Aliases are added to memory, but not saved to file until ProjectSettings is saved
• Aliases are added to the dictionary and ProjectSettings, but not saved to file

Definition at line 68 of file QueryHandler_impl.hh.

template<typename _DataObject>

const std::map<std::string, std::string>& CASM::QueryHandler< _DataObject >::aliases ( ) const

inline

const Access aliases map

• key: alias name
• mapped value: alias command

Definition at line 52 of file QueryHandler.hh.

template<typename _DataObject>

std::unique_ptr<QueryHandler<DataObject> > CASM::QueryHandler< _DataObject >::clone ( ) const

inline

Definition at line 56 of file QueryHandler.hh.

template<typename DataObject >

DataFormatterDictionary< DataObject > & CASM::QueryHandler< DataObject >::dict

(

)

Definition at line 28 of file QueryHandler_impl.hh.

template<typename DataObject >

const DataFormatterDictionary< DataObject > & CASM::QueryHandler< DataObject >::dict

(

)

const

Definition at line 33 of file QueryHandler_impl.hh.

template<typename DataObject >

void CASM::QueryHandler< DataObject >::set_selected

(

const typename QueryTraits< DataObject >::Selected &

selection

)

Set the selection to be used for the 'selected' column.

• ToDo: generalize ConfigIO::Selected

Definition at line 41 of file QueryHandler_impl.hh.

template<typename DataObject >

void CASM::QueryHandler< DataObject >::set_selected

(

const typename QueryTraits< DataObject >::Selection &

selection

)

Set the selection to be used for the 'selected' column.

• ToDo: generalize ConstConfigSelection

Definition at line 58 of file QueryHandler_impl.hh.

Member Data Documentation

template<typename _DataObject>

std::map<std::string, std::string> CASM::QueryHandler< _DataObject >::m_aliases

private

Definition at line 76 of file QueryHandler.hh.

template<typename _DataObject>

DataFormatterDictionary<DataObject> CASM::QueryHandler< _DataObject >::m_dict

private

Definition at line 78 of file QueryHandler.hh.

template<typename _DataObject>

std::map<std::string, std::shared_ptr<RuntimeLibrary> > CASM::QueryHandler< _DataObject >::m_lib

private

Definition at line 80 of file QueryHandler.hh.

template<typename _DataObject>

const ProjectSettings* CASM::QueryHandler< _DataObject >::m_set

private

Definition at line 74 of file QueryHandler.hh.

---

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

• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/app/QueryHandler.hh
• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/app/QueryHandler_impl.hh