CASM
AClustersApproachtoStatisticalMechanics
|
#include <DataFormatterTools.hh>
Implements a DatumFormatter that is an alias for a combination of others.
Definition at line 489 of file DataFormatterTools.hh.
Public Types | |
enum | FormatterType |
typedef DataObject | DataObject |
typedef long | difference_type |
typedef DataFormatterDictionary < DataObject, BaseDatumFormatter< DataObject > > | DictType |
Public Member Functions | |
DatumFormatterAlias (const std::string &_name, const std::string &_command, const DataFormatterDictionary< DataObject > &_dict, const std::string &_help="") | |
DatumFormatterAlias (const std::string &_name, const BaseDatumFormatter< DataObject > &_rhs, const std::string &_help="") | |
BaseDatumFormatter< DataObject > ::FormatterType | type () const override |
std::unique_ptr < DatumFormatterAlias > | clone () const |
void | init (const DataObject &_template_obj) const override |
bool | validate (const DataObject &_data_obj) const override |
Returns true if _data_obj has valid values for requested data. More... | |
std::vector< std::string > | col_header (const DataObject &_template_obj) const override |
Returns a std::vector<std::string> with each column header. More... | |
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... | |
Index | num_passes (const DataObject &_data_obj) const override |
void | print (const DataObject &_data_obj, std::ostream &_stream, Index pass_index=0) const override |
void | inject (const DataObject &_data_obj, DataStream &_stream, Index pass_index=0) const override |
jsonParser & | to_json (const DataObject &_data_obj, jsonParser &json) const override |
bool | parse_args (const std::string &args) 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 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... | |
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 | |
DatumFormatterAlias * | _clone () const override |
Make an exact copy of the formatter (including any initialized members) More... | |
Private Attributes | |
std::vector< std::string > | m_format_tags |
std::vector< std::string > | m_subexprs |
notstd::cloneable_ptr < BaseDatumFormatter < DataObject > > | m_formatter |
|
inherited |
Definition at line 313 of file DataFormatter.hh.
|
inherited |
Definition at line 316 of file DataFormatter.hh.
|
inherited |
Definition at line 315 of file DataFormatter.hh.
|
protectedinherited |
Definition at line 435 of file DataFormatter.hh.
|
inherited |
Definition at line 314 of file DataFormatter.hh.
|
inline |
Definition at line 493 of file DataFormatterTools.hh.
|
inline |
Definition at line 505 of file DataFormatterTools.hh.
|
inlineprotectedinherited |
Definition at line 447 of file DataFormatter.hh.
|
inlineoverrideprivatevirtual |
Make an exact copy of the formatter (including any initialized members)
Implements CASM::BaseDatumFormatter< DataObject >.
Definition at line 606 of file DataFormatterTools.hh.
|
inlineprotectedinherited |
Definition at line 451 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}}
|
inline |
Definition at line 513 of file DataFormatterTools.hh.
|
inlineoverridevirtual |
Returns a std::vector<std::string> with each column header.
$NAME
if only 1 column, $NAME(i)
if >1 column Reimplemented from CASM::BaseDatumFormatter< DataObject >.
Definition at line 529 of file DataFormatterTools.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 332 of file DataFormatter.hh.
|
inlineinherited |
const Access the dictionary containing this formatter, set during DictType::lookup
Definition at line 341 of file DataFormatter.hh.
|
inlineoverridevirtual |
Reimplemented from CASM::BaseDatumFormatter< DataObject >.
Definition at line 517 of file DataFormatterTools.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 569 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 382 of file DataFormatter.hh.
|
inlineinherited |
Returns a name for the formatter, which becomes the tag used for parsing.
Definition at line 326 of file DataFormatter.hh.
|
inlineoverridevirtual |
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 from CASM::BaseDatumFormatter< DataObject >.
Definition at line 557 of file DataFormatterTools.hh.
|
inlineoverridevirtual |
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 588 of file DataFormatterTools.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 563 of file DataFormatterTools.hh.
|
inlineinherited |
Set the dictionary containing this formatter, set during DictType::lookup.
Definition at line 346 of file DataFormatter.hh.
|
inlineoverridevirtual |
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 551 of file DataFormatterTools.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 580 of file DataFormatterTools.hh.
|
inlineoverridevirtual |
Reimplemented from CASM::BaseDatumFormatter< DataObject >.
Definition at line 509 of file DataFormatterTools.hh.
|
inlineoverridevirtual |
Returns true if _data_obj has valid values for requested data.
Reimplemented from CASM::BaseDatumFormatter< DataObject >.
Definition at line 522 of file DataFormatterTools.hh.
|
private |
Definition at line 610 of file DataFormatterTools.hh.
|
private |
Definition at line 611 of file DataFormatterTools.hh.
|
private |
Definition at line 610 of file DataFormatterTools.hh.