#include <DataFormatterTools.hh>

Inheritance diagram for CASM::Base1DDatumFormatter< Container, DataObject >:

Detailed Description

template<typename Container, typename DataObject>
class CASM::Base1DDatumFormatter< Container, DataObject >

Abstract base class for creating 1D DatumFormatter.

A 1D DatumFormatter accepts an object of type DataObject and returns a one-dimensional Container object.

To implement My1DDatumFormatter, you must:

Write the My1DDatumFormatter class:
class My1DDatumFormatter : public Base1dDatumFormatter<DataObject,

Container> {

... include implementations here ...

};
Specialize the ContainerTraits class if it does not already exist:
template<>

struct ContainerTraits<Container> {

... include specializations here ...

};

The ContainerTraits specialization requires specifying:

typename Container
typename value_type
typename size_type
typename Access // such as CASM_TMP::BracketAccess or CASM_TMP::ParenthesesAccess
size_type size(const Container&) const;

The My1DDatumFormatter class is required to provide an implementation for:

Container evaluate(const DataObject& obj) const;
BaseDatumFormatter<DataObject> *clone() const;

See BaseDatumFormatter and BaseValueFormatter for default implementations which may be specialized.

\seealso Generic1DDatumFormatter to specialize a 1D DatumFormatter at runtime.

Definition at line 1002 of file DataFormatterTools.hh.

Public Types
typedef ContainerTraits< Container >::Access	Access
	Access methods for Container. More...

typedef ContainerTraits< Container >::value_type	ValueType

typedef DataObject	DataObject

typedef long	difference_type

typedef DataFormatterDictionary< DataObject, BaseDatumFormatter< DataObject > >	DictType

Public Member Functions
	Base1DDatumFormatter (const std::string &_name, const std::string &_desc)
	Constructor. More...

virtual	~Base1DDatumFormatter ()
	Destructor. More...

std::unique_ptr< Base1DDatumFormatter >	clone () const
	Clone. More...

virtual bool	init (const DataObject &_template_obj) const override
	Default initialization adds rules for each element. More...

virtual std::vector< std::string >	col_header (const DataObject &_template_obj) const override
	Default col_header uses 'name(index)' for each column. More...

virtual bool	parse_args (const std::string &args) override
	Default implementation calls _parse_index_expression. More...

virtual void	inject (const DataObject &_data_obj, DataStream &_stream, Index pass_index=0) const override
	Default implementation injects each element. More...

virtual void	print (const DataObject &_data_obj, std::ostream &_stream, Index pass_index=0) const override
	Default implementation prints each element in a column. More...

virtual Container	operator() (const DataObject &obj) const
	Return requested data from obj, throwing std::runtime_error if not valid. More...

virtual Container	evaluate (const DataObject &obj) const=0

virtual jsonParser &	to_json (const DataObject &_data_obj, jsonParser &json) const override
	Default implementation calls jsonParser& to_json(const ValueType&, jsonParser&) More...

const std::string &	name () const
	Returns a name for the formatter, which becomes the tag used for parsing. More...

const std::string &	description () const
	Returns a short description of the formatter and its allowed arguments (if any). This description is used to automatically generate help screens. More...

virtual DatumFormatterClass	type () const

const DictType &	home () const
	const Access the dictionary containing this formatter, set during DictType::lookup More...

void	set_home (const DictType &home) const
	Set the dictionary containing this formatter, set during DictType::lookup. More...

virtual bool	validate (const DataObject &_data_obj) const
	Returns true if _data_obj has valid values for requested data. More...

virtual std::string	long_header (const DataObject &_template_obj) const
	Returns a long expression for each scalar produced by the formatter parsing the long_header should reproduce the exact query described by the formatter Ex: "clex(formation_energy)" or "comp(a) comp(c)". More...

virtual std::string	short_header (const DataObject &_template_obj) const
	Returns a short expression for the formatter parsing the short_header should allow the formatter to be recreated (but the short header does not specify a subset of the elements) Ex: "clex(formation_energy)" or "comp". More...

virtual Index	num_passes (const DataObject &_data_obj) const

Protected Types
typedef multivector< Index >::X< 2 >	IndexContainer

Protected Member Functions
void	_parse_index_expression (const std::string &_expr)

void	_add_rule (const std::vector< Index > &new_rule) const

const IndexContainer &	_index_rules () const

Private Member Functions
virtual Base1DDatumFormatter *	_clone () const override=0
	Clone. More...

Private Attributes
std::string	m_name

std::string	m_description

IndexContainer	m_index_rules

const DictType *	m_home

Member Typedef Documentation

◆ Access

template<typename Container , typename DataObject >

typedef ContainerTraits<Container>::Access CASM::Base1DDatumFormatter< Container, DataObject >::Access

Access methods for Container.

Definition at line 1006 of file DataFormatterTools.hh.

◆ DataObject

typedef DataObject CASM::BaseDatumFormatter< DataObject >::DataObject

inherited

Definition at line 334 of file DataFormatter.hh.

◆ DictType

typedef DataFormatterDictionary<DataObject, BaseDatumFormatter<DataObject> > CASM::BaseDatumFormatter< DataObject >::DictType

inherited

Definition at line 337 of file DataFormatter.hh.

◆ difference_type

typedef long CASM::BaseDatumFormatter< DataObject >::difference_type

inherited

Definition at line 335 of file DataFormatter.hh.

◆ IndexContainer

typedef multivector<Index>::X<2> CASM::BaseDatumFormatter< DataObject >::IndexContainer

protectedinherited

Definition at line 459 of file DataFormatter.hh.

◆ ValueType

template<typename Container , typename DataObject >

typedef ContainerTraits<Container>::value_type CASM::Base1DDatumFormatter< Container, DataObject >::ValueType

Definition at line 1007 of file DataFormatterTools.hh.

Constructor & Destructor Documentation

◆ Base1DDatumFormatter()

template<typename Container , typename DataObject >

CASM::Base1DDatumFormatter< Container, DataObject >::Base1DDatumFormatter	(	const std::string &	_name,
		const std::string &	_desc
	)

inline

Constructor.

Definition at line 1010 of file DataFormatterTools.hh.

◆ ~Base1DDatumFormatter()

template<typename Container , typename DataObject >

virtual CASM::Base1DDatumFormatter< Container, DataObject >::~Base1DDatumFormatter ( )

inlinevirtual

Destructor.

Definition at line 1014 of file DataFormatterTools.hh.

Member Function Documentation

◆ _add_rule()

void CASM::BaseDatumFormatter< DataObject >::_add_rule ( const std::vector< Index > & new_rule ) const

inlineprotectedinherited

Definition at line 472 of file DataFormatter.hh.

◆ _clone()

template<typename Container , typename DataObject >

virtual Base1DDatumFormatter* CASM::Base1DDatumFormatter< Container, DataObject >::_clone ( ) const

overrideprivatepure virtual

Clone.

Implements CASM::BaseValueFormatter< Container, DataObject >.

Implemented in CASM::ScelIO::TransfMat, CASM::ConfigIO::StrucScore, CASM::ConfigIO::DoFStrain, CASM::ConfigIO::RelaxationStrain, CASM::ConfigIO::PointCorr, CASM::ConfigIO::CorrContribution, CASM::ConfigIO::Corr, CASM::ConfigIO::AtomFrac, CASM::ConfigIO::SiteFrac, CASM::ConfigIO::CompN, CASM::ConfigIO::Comp, and CASM::Generic1DDatumFormatter< Container, DataObject >.

◆ _index_rules()

const IndexContainer& CASM::BaseDatumFormatter< DataObject >::_index_rules ( ) const

inlineprotectedinherited

Definition at line 476 of file DataFormatter.hh.

◆ _parse_index_expression()

void CASM::BaseDatumFormatter< DataObject >::_parse_index_expression ( const std::string & _expr )

protectedinherited

Derived DatumFormatters have some optional functionality for parsing index expressions in order to make it easy to handle ranges such as:

formatter_name(3,4:8)

in which case, DerivedDatumFormatter::parse_args() is called with the string "3,4:8" by dispatching that string to BaseDatumFormatter::_parse_index_expression(), m_index_rules will be populated with {{3,4},{3,5},{3,6},{3,7},{3,8}}

Definition at line 470 of file DataFormatter_impl.hh.

◆ clone()

template<typename Container , typename DataObject >

std::unique_ptr<Base1DDatumFormatter> CASM::Base1DDatumFormatter< Container, DataObject >::clone ( ) const

inline

Clone.

Definition at line 1017 of file DataFormatterTools.hh.

◆ col_header()

template<typename Container , typename DataObject >

virtual std::vector<std::string> CASM::Base1DDatumFormatter< Container, DataObject >::col_header ( const DataObject & _template_obj ) const

inlineoverridevirtual

Default col_header uses 'name(index)' for each column.

Ex: "corr(0)" "corr(1)" "corr(5)" "corr(6)"

Reimplemented from CASM::BaseDatumFormatter< DataObject >.

Definition at line 1041 of file DataFormatterTools.hh.

◆ description()

const std::string& CASM::BaseDatumFormatter< DataObject >::description ( ) const

inlineinherited

Returns a short description of the formatter and its allowed arguments (if any). This description is used to automatically generate help screens.

Definition at line 352 of file DataFormatter.hh.

◆ evaluate()

virtual Container CASM::BaseValueFormatter< Container , DataObject >::evaluate ( const DataObject & obj ) const

pure virtualinherited

Implemented in CASM::Generic2DDatumFormatter< Container, DataObject >, and CASM::Generic1DDatumFormatter< Container, DataObject >.

◆ home()

const DictType& CASM::BaseDatumFormatter< DataObject >::home ( ) const

inlineinherited

const Access the dictionary containing this formatter, set during DictType::lookup

Definition at line 360 of file DataFormatter.hh.

◆ init()

template<typename Container , typename DataObject >

virtual bool CASM::Base1DDatumFormatter< Container, DataObject >::init ( const DataObject & _template_obj ) const

inlineoverridevirtual

Default initialization adds rules for each element.

Reimplemented from CASM::BaseDatumFormatter< DataObject >.

Definition at line 1025 of file DataFormatterTools.hh.

◆ inject()

template<typename Container , typename DataObject >

virtual void CASM::Base1DDatumFormatter< Container, DataObject >::inject	(	const DataObject &	_data_obj,
		DataStream &	_stream,
		Index	pass_index = `0`
	)		const

inlineoverridevirtual

Default implementation injects each element.

sets DataStream::failbit if validation fails

Reimplemented from CASM::BaseValueFormatter< Container, DataObject >.

Definition at line 1063 of file DataFormatterTools.hh.

◆ long_header()

virtual std::string CASM::BaseDatumFormatter< DataObject >::long_header ( const DataObject & _template_obj ) const

inlinevirtualinherited

Returns a long expression for each scalar produced by the formatter parsing the long_header should reproduce the exact query described by the formatter Ex: "clex(formation_energy)" or "comp(a) comp(c)".

Default uses col_header

Definition at line 399 of file DataFormatter.hh.

◆ name()

const std::string& CASM::BaseDatumFormatter< DataObject >::name ( ) const

inlineinherited

Returns a name for the formatter, which becomes the tag used for parsing.

Definition at line 347 of file DataFormatter.hh.

◆ num_passes()

virtual Index CASM::BaseDatumFormatter< DataObject >::num_passes ( const DataObject & _data_obj ) const

inlinevirtualinherited

If data must be printed on multiple rows, returns number of rows needed to output all data from _data_obj DataFormatter class will subsequently pass over _data_obj multiple times to complete printing (if necessary)

Reimplemented in CASM::Base2DDatumFormatter< Container, DataObject >, and CASM::DatumFormatterAlias< DataObject >.

Definition at line 424 of file DataFormatter.hh.

◆ operator()()

virtual Container CASM::BaseValueFormatter< Container , DataObject >::operator() ( const DataObject & obj ) const

inlinevirtualinherited

Return requested data from obj, throwing std::runtime_error if not valid.

Definition at line 803 of file DataFormatterTools.hh.

◆ parse_args()

template<typename Container , typename DataObject >

virtual bool CASM::Base1DDatumFormatter< Container, DataObject >::parse_args ( const std::string & args )

inlineoverridevirtual

Default implementation calls _parse_index_expression.

Reimplemented from CASM::BaseDatumFormatter< DataObject >.

Reimplemented in CASM::ConfigIO::StrucScore, CASM::ScelIO::TransfMat, CASM::ScelIO::SupercellCheckBase< VectorXiAttribute< Supercell > >, CASM::ConfigIO::DoFStrain, CASM::ConfigIO::RelaxationStrain, CASM::ConfigIO::PointCorr, CASM::ConfigIO::CorrContribution, CASM::ConfigIO::Corr, CASM::ConfigIO::Comp, and CASM::ConfigIO_impl::MolDependent.

Definition at line 1055 of file DataFormatterTools.hh.

◆ print()

template<typename Container , typename DataObject >

virtual void CASM::Base1DDatumFormatter< Container, DataObject >::print	(	const DataObject &	_data_obj,
		std::ostream &	_stream,
		Index	pass_index = `0`
	)		const

inlineoverridevirtual

Default implementation prints each element in a column.

Prints "unknown" if validation fails

Reimplemented from CASM::BaseValueFormatter< Container, DataObject >.

Definition at line 1087 of file DataFormatterTools.hh.

◆ set_home()

void CASM::BaseDatumFormatter< DataObject >::set_home ( const DictType & home ) const

inlineinherited

Set the dictionary containing this formatter, set during DictType::lookup.

Definition at line 364 of file DataFormatter.hh.

◆ short_header()

virtual std::string CASM::BaseDatumFormatter< DataObject >::short_header ( const DataObject & _template_obj ) const

inlinevirtualinherited

Returns a short expression for the formatter parsing the short_header should allow the formatter to be recreated (but the short header does not specify a subset of the elements) Ex: "clex(formation_energy)" or "comp".

Reimplemented in CASM::DatumFormatterAlias< DataObject >, and CASM::DataFormatterOperator< ValueType, ArgType, DataObject >.

Definition at line 417 of file DataFormatter.hh.

◆ to_json()

virtual jsonParser& CASM::BaseValueFormatter< Container , DataObject >::to_json	(	const DataObject &	_data_obj,
		jsonParser &	json
	)		const

inlineoverridevirtualinherited

Default implementation calls jsonParser& to_json(const ValueType&, jsonParser&)

Does nothing if validation fails

Implements CASM::BaseDatumFormatter< DataObject >.

Definition at line 847 of file DataFormatterTools.hh.

◆ type()

virtual DatumFormatterClass CASM::BaseDatumFormatter< DataObject >::type ( ) const

inlinevirtualinherited

Reimplemented in CASM::DatumFormatterAlias< DataObject >, and CASM::DataFormatterOperator< ValueType, ArgType, DataObject >.

Definition at line 354 of file DataFormatter.hh.

◆ validate()

virtual bool CASM::BaseDatumFormatter< DataObject >::validate ( const DataObject & _data_obj ) const

inlinevirtualinherited

Returns true if _data_obj has valid values for requested data.

Default implementation always returns true

Reimplemented in CASM::Generic2DDatumFormatter< Container, DataObject >, CASM::Generic1DDatumFormatter< Container, DataObject >, CASM::GenericDatumFormatter< ValueType, DataObject >, CASM::DatumFormatterAlias< DataObject >, and CASM::DataFormatterOperator< ValueType, ArgType, DataObject >.

Definition at line 381 of file DataFormatter.hh.

Member Data Documentation

◆ m_description

std::string CASM::BaseDatumFormatter< DataObject >::m_description

privateinherited

Definition at line 486 of file DataFormatter.hh.

◆ m_home

const DictType* CASM::BaseDatumFormatter< DataObject >::m_home

mutableprivateinherited

Definition at line 488 of file DataFormatter.hh.

◆ m_index_rules

IndexContainer CASM::BaseDatumFormatter< DataObject >::m_index_rules

mutableprivateinherited

Definition at line 487 of file DataFormatter.hh.

◆ m_name

std::string CASM::BaseDatumFormatter< DataObject >::m_name

privateinherited

{ return notstd::make_unique<DerivedDatumFormatter>(*this);}

Definition at line 485 of file DataFormatter.hh.

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

/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/casm_io/dataformatter/DataFormatterDecl.hh
/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/casm_io/dataformatter/DataFormatterTools.hh

Detailed Description

template<typename Container, typename DataObject> class CASM::Base1DDatumFormatter< Container, DataObject >

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ Access

◆ DataObject

◆ DictType

◆ difference_type

◆ IndexContainer

◆ ValueType

Constructor & Destructor Documentation

◆ Base1DDatumFormatter()

◆ ~Base1DDatumFormatter()

Member Function Documentation

◆ _add_rule()

◆ _clone()

◆ _index_rules()

◆ _parse_index_expression()

◆ clone()

◆ col_header()

◆ description()

◆ evaluate()

◆ home()

◆ init()

◆ inject()

◆ long_header()

◆ name()

◆ num_passes()

◆ operator()()

◆ parse_args()

◆ print()

◆ set_home()

◆ short_header()

◆ to_json()

◆ type()

◆ validate()

Member Data Documentation

◆ m_description

◆ m_home

◆ m_index_rules

◆ m_name

template<typename Container, typename DataObject>
class CASM::Base1DDatumFormatter< Container, DataObject >