CASM  1.1.0
A Clusters Approach to Statistical Mechanics
CASM::ConfigEnumStrainInterface Class Referenceabstract

#include <ConfigEnumStrainInterface.hh>

+ Inheritance diagram for CASM::ConfigEnumStrainInterface:

Detailed Description

Interface for ConfigEnumStrain.

Definition at line 9 of file ConfigEnumStrainInterface.hh.

Public Member Functions

std::string desc () const override
 
std::string name () const override
 Enumeration method name (i.e. "ConfigEnumAllOccupations") More...
 
void run (PrimClex &primclex, jsonParser const &json_options, jsonParser const &cli_options_as_json) const override
 
std::unique_ptr< Cloneable > clone () const
 
std::unique_ptr< Cloneable > move ()
 

Private Member Functions

virtual Cloneable * _clone () const =0
 
virtual Cloneable * _move ()=0
 

Member Function Documentation

◆ _clone()

virtual Cloneable* notstd::Cloneable::_clone ( ) const
privatepure virtualinherited

◆ _move()

virtual Cloneable* notstd::Cloneable::_move ( )
privatepure virtualinherited

◆ clone()

std::unique_ptr<Cloneable> notstd::Cloneable::clone ( ) const
inlineinherited

Definition at line 92 of file cloneable_ptr.hh.

◆ desc()

std::string CASM::ConfigEnumStrainInterface::desc ( ) const
overridevirtual

Enumeration method description. What will be printed by casm enum --desc MethodName.

Implements CASM::EnumInterfaceBase.

Definition at line 62 of file ConfigEnumStrainInterface.cc.

◆ move()

std::unique_ptr<Cloneable> notstd::Cloneable::move ( )
inlineinherited

Definition at line 95 of file cloneable_ptr.hh.

◆ name()

std::string CASM::ConfigEnumStrainInterface::name ( ) const
overridevirtual

Enumeration method name (i.e. "ConfigEnumAllOccupations")

Implements CASM::EnumInterfaceBase.

Definition at line 176 of file ConfigEnumStrainInterface.cc.

◆ run()

void CASM::ConfigEnumStrainInterface::run ( PrimClex primclex,
jsonParser const &  json_options,
jsonParser const &  cli_options_as_json 
) const
overridevirtual

Enumeration method implementation

Parameters
primclexPrimClex gives access to project resources
json_optionsJSON input, as by –input or –settings CLI options
cli_options_as_jsonCLI options converted to JSON. Includes: –desc as "desc": array of string (method names to print help for) –help as "help": bool (print/return help, including list of available methods) –method as "method": string (name of enumeration method) –settings as "settings": string (path to settings JSON file) –input as "input": string (a JSON string) –min as "min": int (meaning depends on method, if any) –max as "max": int (meaning depends on method, if any) –all as "all": bool (meaning depends on method, if any) –scelnames as "scelnames": array of string (meaning depends on method, if any) –confignames as "confignames": array of string (meaning depends on method, if any) –verbosity as "verbosity": string (requested verbosity level) –filter as "filter": array of string (query expression used filter results) –dry-run as "dry_run": bool (if true, do not commit database upon completion)

Notes:

  • It is up to the individual method to determine how to combine and use json_options and cli_options_as_json, but by convention prefer using CLI input in case of collisions.

Implements CASM::EnumInterfaceBase.

Definition at line 364 of file ConfigEnumStrainInterface.cc.


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