#include <DataFormatterTools.hh>

Inheritance diagram for CASM::GenericDatumFormatter< ValueType, DataObject >:

Detailed Description

template<typename ValueType, typename DataObject>
singleton CASM::GenericDatumFormatter< ValueType, DataObject >

A DatumFormatter that returns a value of specified type, via functions that may be specified at runtime.

Definition at line 792 of file DataFormatterTools.hh.

Public Types
using	Evaluator = std::function< ValueType(const DataObject &)>

using	Validator = std::function< bool(const DataObject &)>

enum	FormatterType

typedef DataObject	DataObject

typedef long	difference_type

typedef DataFormatterDictionary < DataObject, BaseDatumFormatter< DataObject > >	DictType

Public Member Functions
	GenericDatumFormatter (const std::string &_init_name, const std::string &_desc, Evaluator _evaluator, Validator _validator=always_true< DataObject >)
	Constructor. More...

ValueType	evaluate (const DataObject &obj) const override
	Returns Container type piece of data about a DataObject, the result of the Evaluator. More...

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

bool	validate (const DataObject &obj) const override
	Returns boolean indicating if the _evaluator can be used successfully, the result of the Validator. More...

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

virtual void	inject (const DataObject &_data_obj, DataStream &_stream, Index pass_index=0) const override
	Default implementation injects each element, via operator<<. 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, via operator<<. More...

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 FormatterType	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 void	init (const DataObject &_template_obj) const

virtual std::vector< std::string >	col_header (const DataObject &_template_obj) const
	Returns a header string for each scalar produced by the formatter parsing the entries in the col_header should reproduce the exact query described by the formatter. Ex: "clex(formation_energy)" or "comp(a)", "comp(c)". 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

virtual bool	parse_args (const std::string &args)

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
GenericDatumFormatter *	_clone () const override
	Clone. More...

Private Attributes
Evaluator	m_evaluate

Validator	m_validate

Member Typedef Documentation

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

inherited

Definition at line 313 of file DataFormatter.hh.

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

inherited

Definition at line 316 of file DataFormatter.hh.

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

inherited

Definition at line 315 of file DataFormatter.hh.

template<typename ValueType, typename DataObject>

using CASM::GenericDatumFormatter< ValueType, DataObject >::Evaluator = std::function<ValueType(const DataObject &)>

Definition at line 796 of file DataFormatterTools.hh.

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

protectedinherited

Definition at line 435 of file DataFormatter.hh.

template<typename ValueType, typename DataObject>

using CASM::GenericDatumFormatter< ValueType, DataObject >::Validator = std::function<bool(const DataObject &)>

Definition at line 797 of file DataFormatterTools.hh.

Member Enumeration Documentation

enum CASM::BaseDatumFormatter::FormatterType

inherited

Definition at line 314 of file DataFormatter.hh.

Constructor & Destructor Documentation

template<typename ValueType, typename DataObject>

CASM::GenericDatumFormatter< ValueType, DataObject >::GenericDatumFormatter	(	const std::string &	_init_name,
		const std::string &	_desc,
		Evaluator	_evaluator,
		Validator	_validator = `always_true<DataObject>`
	)

inline

Constructor.

Parameters

_name	Name of formatter
_desc	Description of the formatter
_evaluator	Returns a ValueType type piece of data about a DataObject
_validator	Returns boolean indicating if the _evaluator can be used successfully

Definition at line 806 of file DataFormatterTools.hh.

Member Function Documentation

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

inlineprotectedinherited

Definition at line 447 of file DataFormatter.hh.

template<typename ValueType, typename DataObject>

GenericDatumFormatter* CASM::GenericDatumFormatter< ValueType, DataObject >::_clone ( ) const

inlineoverrideprivatevirtual

Clone.

Implements CASM::BaseValueFormatter< ValueType, DataObject >.

Definition at line 842 of file DataFormatterTools.hh.

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

inlineprotectedinherited

Definition at line 451 of file DataFormatter.hh.

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}}

template<typename ValueType, typename DataObject>

std::unique_ptr<GenericDatumFormatter> CASM::GenericDatumFormatter< ValueType, DataObject >::clone ( ) const

inline

Clone.

Definition at line 825 of file DataFormatterTools.hh.

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

inlinevirtualinherited

Returns a header string for each scalar produced by the formatter parsing the entries in the col_header should reproduce the exact query described by the formatter. Ex: "clex(formation_energy)" or "comp(a)", "comp(c)".

Default uses col_header

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

Definition at line 373 of file DataFormatter.hh.

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 332 of file DataFormatter.hh.

template<typename ValueType, typename DataObject>

ValueType CASM::GenericDatumFormatter< ValueType, DataObject >::evaluate ( const DataObject & obj ) const

inlineoverridevirtual

Returns Container type piece of data about a DataObject, the result of the Evaluator.

Implements CASM::BaseValueFormatter< ValueType, DataObject >.

Definition at line 820 of file DataFormatterTools.hh.

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

inlineinherited

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

Definition at line 341 of file DataFormatter.hh.

virtual void CASM::BaseDatumFormatter< DataObject >::init ( const DataObject & _template_obj ) const

inlinevirtualinherited

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

Definition at line 356 of file DataFormatter.hh.

template<typename ValueType, typename DataObject>

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

inlineoverridevirtualinherited

Default implementation injects each element, via operator<<.

sets DataStream::failbit if validation fails

Implements CASM::BaseDatumFormatter< DataObject >.

Reimplemented in CASM::Base1DDatumFormatter< Container, DataObject >.

Definition at line 747 of file DataFormatterTools.hh.

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 382 of file DataFormatter.hh.

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 326 of file DataFormatter.hh.

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::DatumFormatterAlias< DataObject >.

Definition at line 406 of file DataFormatter.hh.

template<typename ValueType, typename DataObject>

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

inlinevirtualinherited

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

Definition at line 729 of file DataFormatterTools.hh.

virtual bool CASM::BaseDatumFormatter< DataObject >::parse_args ( const std::string & args )

inlinevirtualinherited

If DatumFormatter accepts arguments, parse them here. Arguments are assumed to be passed from the command line via: formattername(argument1,argument2,...)

from which DerivedDatumFormatter::parse_args() receives the string "argument1,argument2,..." Returns true if parse is successful, false if not (e.g., takes no arguments, already initialized, malformed input, etc).

Reimplemented in CASM::Base1DDatumFormatter< Container, DataObject >, CASM::DatumFormatterAlias< DataObject >, CASM::ConfigIO::Clex, CASM::ConfigIO::Corr, CASM::ConfigIO::DoFStrain, CASM::ConfigIO::Comp, CASM::ConfigIO::Novelty, CASM::ConfigIO::RelaxationStrain, CASM::ConfigIO::StrucScore, CASM::DataFormatterOperator< ValueType, ArgType, DataObject >, CASM::ConfigIO::Selected, and CASM::ConfigIO_impl::MolDependent.

Definition at line 431 of file DataFormatter.hh.

template<typename ValueType, typename DataObject>

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

inlineoverridevirtualinherited

Default implementation prints each element in a column, via operator<<.

Prints "unknown" if validation fails

Implements CASM::BaseDatumFormatter< DataObject >.

Reimplemented in CASM::Base1DDatumFormatter< Container, DataObject >.

Definition at line 757 of file DataFormatterTools.hh.

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

inlineinherited

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

Definition at line 346 of file DataFormatter.hh.

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 400 of file DataFormatter.hh.

template<typename ValueType, typename DataObject>

virtual jsonParser& CASM::BaseValueFormatter< ValueType, 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 769 of file DataFormatterTools.hh.

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

inlinevirtualinherited

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

Definition at line 336 of file DataFormatter.hh.

template<typename ValueType, typename DataObject>

bool CASM::GenericDatumFormatter< ValueType, DataObject >::validate ( const DataObject & obj ) const

inlineoverridevirtual

Returns boolean indicating if the _evaluator can be used successfully, the result of the Validator.

Reimplemented from CASM::BaseDatumFormatter< DataObject >.

Definition at line 834 of file DataFormatterTools.hh.

Member Data Documentation

template<typename ValueType, typename DataObject>

Evaluator CASM::GenericDatumFormatter< ValueType, DataObject >::m_evaluate

private

Definition at line 846 of file DataFormatterTools.hh.

template<typename ValueType, typename DataObject>

Validator CASM::GenericDatumFormatter< ValueType, DataObject >::m_validate

private

Definition at line 847 of file DataFormatterTools.hh.

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

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

Detailed Description

template<typename ValueType, typename DataObject> singleton CASM::GenericDatumFormatter< ValueType, DataObject >

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Private Attributes

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename ValueType, typename DataObject>
singleton CASM::GenericDatumFormatter< ValueType, DataObject >