CASM::QueryData< ValueType > Struct Template Reference

#include <QueryIO.hh>

Detailed Description

template<typename ValueType>
struct CASM::QueryData< ValueType >

Data structure to collect value (Supercell, Configuration, etc.) and data for query formatting

Definition at line 25 of file QueryIO.hh.

Public Member Functions
	QueryData (PrimClex const &_primclex, ValueType const &_value, bool _include_equivalents=false, Index _equivalent_index=0, PermuteIterator const *_permute_it=nullptr)

Public Attributes
PrimClex const &	primclex
	Provides access to project data. More...
ValueType const &	value
	The object under consideration (Supercell, Configuration, etc.) More...
bool	include_equivalents
	True if non-canonical equivalents are also being queried. More...
Index	equivalent_index
	Index incremented for each non-canonical equivalent. More...
PermuteIterator const *	permute_it

Constructor & Destructor Documentation

QueryData()

template<typename ValueType >

CASM::QueryData< ValueType >::QueryData	(	PrimClex const &	_primclex,
		ValueType const &	_value,
		bool	_include_equivalents = false,
		Index	_equivalent_index = 0,
		PermuteIterator const *	_permute_it = nullptr
	)

Definition at line 25 of file QueryIO_impl.hh.

Member Data Documentation

equivalent_index

template<typename ValueType >

Index CASM::QueryData< ValueType >::equivalent_index

Index incremented for each non-canonical equivalent.

Definition at line 40 of file QueryIO.hh.

include_equivalents

template<typename ValueType >

bool CASM::QueryData< ValueType >::include_equivalents

True if non-canonical equivalents are also being queried.

Definition at line 37 of file QueryIO.hh.

permute_it

template<typename ValueType >

PermuteIterator const* CASM::QueryData< ValueType >::permute_it

Permutation that transforms the canonical form to the current non-canonical equivalent value

Definition at line 44 of file QueryIO.hh.

primclex

template<typename ValueType >

PrimClex const& CASM::QueryData< ValueType >::primclex

Provides access to project data.

Definition at line 31 of file QueryIO.hh.

value

template<typename ValueType >

ValueType const& CASM::QueryData< ValueType >::value

The object under consideration (Supercell, Configuration, etc.)

Definition at line 34 of file QueryIO.hh.

---

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

• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/app/query/QueryIO.hh
• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/app/query/QueryIO_impl.hh