CASM
1.1.0
A Clusters Approach to Statistical Mechanics
|
#include <DataFormatterTools.hh>
DataFormatters that operate on the results of other DataFormatters.
Definition at line 30 of file DataFormatterTools.hh.
Public Types | |
using | Evaluator = std::function< ValueType(const std::vector< ArgType > &)> |
typedef DataObject | DataObject |
typedef long | difference_type |
typedef DataFormatterDictionary< DataObject, BaseDatumFormatter< DataObject > > | DictType |
Public Member Functions | |
DataFormatterOperator (const std::string &_init_name, const std::string &_desc, Evaluator evaluator) | |
std::unique_ptr< DataFormatterOperator > | clone () const |
DatumFormatterClass | type () const override |
std::string | short_header (const DataObject &_template_obj) const override |
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... | |
bool | validate (const DataObject &_data_obj) const override |
Returns true if _data_obj has valid values for requested data. More... | |
bool | parse_args (const std::string &_args) override |
void | inject (const DataObject &_data_obj, DataStream &_stream, Index pass_index) const override |
void | print (const DataObject &_data_obj, std::ostream &_stream, Index pass_index) const override |
jsonParser & | to_json (const DataObject &_data_obj, jsonParser &json) const override |
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... | |
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 | init (const DataObject &_template_obj) const |
Perform all initialization steps using _template_obj. Returns true if initialization is successful and false if _template_obj has insufficient data to complete initialization. More... | |
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 Index | num_passes (const DataObject &_data_obj) const |
Protected Types | |
typedef multivector< Index >::X< 2 > | IndexContainer |
Protected Member Functions | |
ValueType | _evaluate (const DataObject &_data_obj) const |
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 | |
DataFormatterOperator * | _clone () const override |
Make an exact copy of the formatter (including any initialized members) More... | |
Private Attributes | |
Evaluator | m_evaluate |
DataFormatter< DataObject > | m_arg_formatter |
std::string | m_name |
std::string | m_description |
IndexContainer | m_index_rules |
const DictType * | m_home |
|
inherited |
Definition at line 334 of file DataFormatter.hh.
|
inherited |
Definition at line 337 of file DataFormatter.hh.
|
inherited |
Definition at line 335 of file DataFormatter.hh.
using CASM::DataFormatterOperator< ValueType, ArgType, DataObject >::Evaluator = std::function<ValueType(const std::vector<ArgType> &)> |
Definition at line 33 of file DataFormatterTools.hh.
|
protectedinherited |
Definition at line 459 of file DataFormatter.hh.
|
inline |
Definition at line 37 of file DataFormatterTools.hh.
|
inlineprotectedinherited |
Definition at line 472 of file DataFormatter.hh.
|
inlineoverrideprivatevirtual |
Make an exact copy of the formatter (including any initialized members)
Implements CASM::BaseDatumFormatter< DataObject >.
Definition at line 91 of file DataFormatterTools.hh.
|
inlineprotected |
Definition at line 84 of file DataFormatterTools.hh.
|
inlineprotectedinherited |
Definition at line 476 of file DataFormatter.hh.
|
protectedinherited |
Derived DatumFormatters have some optional functionality for parsing index expressions in order to make it easy to handle ranges such as:
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.
|
inline |
Definition at line 42 of file DataFormatterTools.hh.
|
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)".
Reimplemented in CASM::Base2DDatumFormatter< Container, DataObject >, CASM::Base1DDatumFormatter< Container, DataObject >, and CASM::DatumFormatterAlias< DataObject >.
Definition at line 389 of file DataFormatter.hh.
|
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.
|
inlineinherited |
const Access the dictionary containing this formatter, set during DictType::lookup
Definition at line 360 of file DataFormatter.hh.
|
inlinevirtualinherited |
Perform all initialization steps using _template_obj. Returns true if initialization is successful and false if _template_obj has insufficient data to complete initialization.
Reimplemented in CASM::Base2DDatumFormatter< Container, DataObject >, CASM::Base1DDatumFormatter< Container, DataObject >, and CASM::DatumFormatterAlias< DataObject >.
Definition at line 376 of file DataFormatter.hh.
|
inlineoverridevirtual |
Stream selected data from _data_obj to _stream, while specifying which output pass is requested If implementation does not depend on pass_index, it may safely be ignored
Implements CASM::BaseDatumFormatter< DataObject >.
Definition at line 58 of file DataFormatterTools.hh.
|
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)".
Definition at line 399 of file DataFormatter.hh.
|
inlineinherited |
Returns a name for the formatter, which becomes the tag used for parsing.
Definition at line 347 of file DataFormatter.hh.
|
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.
|
overridevirtual |
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 from CASM::BaseDatumFormatter< DataObject >.
Definition at line 12 of file DataFormatterTools_impl.hh.
|
inlineoverridevirtual |
Print formatted data from _data_obj to _stream, while specifying which output pass is requested If implementation does not depend on pass_index, it may safely be ignored
Implements CASM::BaseDatumFormatter< DataObject >.
Definition at line 67 of file DataFormatterTools.hh.
|
inlineinherited |
Set the dictionary containing this formatter, set during DictType::lookup.
Definition at line 364 of file DataFormatter.hh.
|
overridevirtual |
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 from CASM::BaseDatumFormatter< DataObject >.
Definition at line 77 of file DataFormatterTools_impl.hh.
|
inlineoverridevirtual |
Assumes that 'json' object is simply assigned, and it is the job of DataFormatter (or some other managing entity) to pass the correct 'json' object. Ex: DerivedDatumFormatter my_formatter; initialize(my_formatter); // does some set of initialization steps jsonParser my_big_data_object; my_formatter.to_json(my_data_object, my_big_data_object["place_to_write"]["my_formatter_data"]);
Implements CASM::BaseDatumFormatter< DataObject >.
Definition at line 77 of file DataFormatterTools.hh.
|
inlineoverridevirtual |
Reimplemented from CASM::BaseDatumFormatter< DataObject >.
Definition at line 46 of file DataFormatterTools.hh.
|
inlineoverridevirtual |
Returns true if _data_obj has valid values for requested data.
Default implementation always returns true
Reimplemented from CASM::BaseDatumFormatter< DataObject >.
Definition at line 52 of file DataFormatterTools.hh.
|
private |
Definition at line 96 of file DataFormatterTools.hh.
|
privateinherited |
Definition at line 486 of file DataFormatter.hh.
|
private |
Definition at line 95 of file DataFormatterTools.hh.
|
mutableprivateinherited |
Definition at line 488 of file DataFormatter.hh.
|
mutableprivateinherited |
Definition at line 487 of file DataFormatter.hh.
|
privateinherited |
{ return notstd::make_unique<DerivedDatumFormatter>(*this);}
Definition at line 485 of file DataFormatter.hh.