CASM
AClustersApproachtoStatisticalMechanics
|
#include <ConfigIOSelected.hh>
Returns true if configuration is specified in given selection (default: MASTER)
Ex: 'selected_in', 'selected_in(myselection.txt)'
Definition at line 20 of file ConfigIOSelected.hh.
Public Types | |
enum | FormatterType |
typedef DataObject | DataObject |
typedef long | difference_type |
typedef DataFormatterDictionary < DataObject, BaseDatumFormatter< DataObject > > | DictType |
Public Member Functions | |
Selected () | |
Selected (const Selected &)=default | |
template<bool IsConst> | |
Selected (ConfigSelection< IsConst > _selection) | |
std::unique_ptr< Selected > | clone () const |
bool | evaluate (const Configuration &_config) const override |
void | init (const Configuration &_tmplt) const override |
std::string | short_header (const Configuration &_config) const override |
bool | parse_args (const std::string &args) override |
virtual ValueType | operator() (const DataObject &obj) const |
Return requested data from obj, throwing std::runtime_error if not valid. More... | |
virtual ValueType | evaluate (const DataObject &obj) const =0 |
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 bool | validate (const DataObject &_data_obj) const |
Returns true if _data_obj has valid values for requested data. 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 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 | |
Selected * | _clone () const override |
Clone. More... | |
Private Attributes | |
std::string | m_selection_name |
ConstConfigSelection | m_selection |
|
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 22 of file ConfigIOSelected.hh.
|
default |
|
inlineexplicit |
Definition at line 28 of file ConfigIOSelected.hh.
|
inlineprotectedinherited |
Definition at line 447 of file DataFormatter.hh.
|
overrideprivatevirtual |
Clone.
Implements CASM::BaseValueFormatter< ValueType, DataObject >.
Definition at line 23 of file ConfigIOSelected.cc.
|
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}}
std::unique_ptr< Selected > CASM::ConfigIO::Selected::clone | ( | ) | const |
Definition at line 19 of file ConfigIOSelected.cc.
|
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::Base1DDatumFormatter< Container, DataObject >, and CASM::DatumFormatterAlias< DataObject >.
Definition at line 373 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 332 of file DataFormatter.hh.
|
override |
Definition at line 31 of file ConfigIOSelected.cc.
|
pure virtualinherited |
|
inlineinherited |
const Access the dictionary containing this formatter, set during DictType::lookup
Definition at line 341 of file DataFormatter.hh.
|
override |
Definition at line 6 of file ConfigIOSelected.cc.
|
inlinevirtualinherited |
Reimplemented in CASM::Base1DDatumFormatter< Container, DataObject >, and CASM::DatumFormatterAlias< DataObject >.
Definition at line 356 of file DataFormatter.hh.
|
inlineoverridevirtualinherited |
Default implementation injects each element, via operator<<.
Implements CASM::BaseDatumFormatter< DataObject >.
Reimplemented in CASM::Base1DDatumFormatter< Container, DataObject >.
Definition at line 747 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.
|
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.
|
inlinevirtualinherited |
Return requested data from obj, throwing std::runtime_error if not valid.
Definition at line 729 of file DataFormatterTools.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 35 of file ConfigIOSelected.cc.
|
inlineoverridevirtualinherited |
Default implementation prints each element in a column, via operator<<.
Implements CASM::BaseDatumFormatter< DataObject >.
Reimplemented in CASM::Base1DDatumFormatter< Container, DataObject >.
Definition at line 757 of file DataFormatterTools.hh.
|
inlineinherited |
Set the dictionary containing this formatter, set during DictType::lookup.
Definition at line 346 of file DataFormatter.hh.
|
override |
Definition at line 27 of file ConfigIOSelected.cc.
|
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.
|
inlineoverridevirtualinherited |
Default implementation calls jsonParser& to_json(const ValueType&, jsonParser&)
Implements CASM::BaseDatumFormatter< DataObject >.
Definition at line 769 of file DataFormatterTools.hh.
|
inlinevirtualinherited |
Reimplemented in CASM::DatumFormatterAlias< DataObject >, and CASM::DataFormatterOperator< ValueType, ArgType, DataObject >.
Definition at line 336 of file DataFormatter.hh.
|
inlinevirtualinherited |
Returns true if _data_obj has valid values for requested data.
Default implementation always returns true
Reimplemented in CASM::Generic1DDatumFormatter< Container, DataObject >, CASM::GenericDatumFormatter< ValueType, DataObject >, CASM::DatumFormatterAlias< DataObject >, and CASM::DataFormatterOperator< ValueType, ArgType, DataObject >.
Definition at line 363 of file DataFormatter.hh.
|
mutableprivate |
Definition at line 60 of file ConfigIOSelected.hh.
|
mutableprivate |
Definition at line 59 of file ConfigIOSelected.hh.