CASM  1.1.0
A Clusters Approach to Statistical Mechanics
Public Types | Public Member Functions | Private Attributes | List of all members
CASM::APICommand< _OptionType > Class Template Referenceabstract

#include <APICommand.hh>

+ Inheritance diagram for CASM::APICommand< _OptionType >:

Detailed Description

template<typename _OptionType>
class CASM::APICommand< _OptionType >

Base class for implementing CASM API command classes

  • Includes access to Option class and variables_map

Definition at line 50 of file APICommand.hh.

Public Types

typedef _OptionType OptionType
 

Public Member Functions

 APICommand (const CommandArgs &_args, OptionType &_opt)
 
int count (std::string s) const
 
const po::variables_map & vm () const
 
const OptionType & opt () const
 
const CommandArgs & args () const
 
fs::path root () const
 
bool in_project () const
 
PrimClex & primclex () const
 
virtual int vm_count_check () const =0
 
virtual int help () const =0
 
virtual int desc () const =0
 
virtual int run () const =0
 

Private Attributes

OptionType & m_opt
 
const CommandArgs & m_args
 
bool m_in_project
 
std::unique_ptr< PrimClex > m_primclex
 

Member Typedef Documentation

◆ OptionType

template<typename _OptionType >
typedef _OptionType CASM::APICommand< _OptionType >::OptionType

Definition at line 52 of file APICommand.hh.

Constructor & Destructor Documentation

◆ APICommand()

template<typename _OptionType >
CASM::APICommand< _OptionType >::APICommand ( const CommandArgs &  _args,
OptionType &  _opt 
)
inline

Definition at line 54 of file APICommand.hh.

Member Function Documentation

◆ args()

const CommandArgs & CASM::APICommandBase::args ( ) const
inherited

Definition at line 11 of file APICommand.cc.

◆ count()

template<typename _OptionType >
int CASM::APICommand< _OptionType >::count ( std::string  s) const
inline

Definition at line 57 of file APICommand.hh.

◆ desc()

virtual int CASM::APICommandBase::desc ( ) const
pure virtualinherited

Implemented in CASM::UpdateCommand, CASM::SymCommand, CASM::SelectCommand, CASM::RmCommand, CASM::QueryCommand, CASM::InfoCommand, CASM::ImportCommand, CASM::EnumCommand, and CASM::BsetCommand.

◆ help()

virtual int CASM::APICommandBase::help ( ) const
pure virtualinherited

Implemented in CASM::UpdateCommand, CASM::SymCommand, CASM::SelectCommand, CASM::RmCommand, CASM::QueryCommand, CASM::InfoCommand, CASM::ImportCommand, CASM::EnumCommand, and CASM::BsetCommand.

◆ in_project()

bool CASM::APICommandBase::in_project ( ) const
inherited

Definition at line 15 of file APICommand.cc.

◆ opt()

template<typename _OptionType >
const OptionType& CASM::APICommand< _OptionType >::opt ( ) const
inline

Definition at line 61 of file APICommand.hh.

◆ primclex()

PrimClex & CASM::APICommandBase::primclex ( ) const
inherited

Definition at line 17 of file APICommand.cc.

◆ root()

fs::path CASM::APICommandBase::root ( ) const
inherited

Definition at line 13 of file APICommand.cc.

◆ run()

virtual int CASM::APICommandBase::run ( ) const
pure virtualinherited

Implemented in CASM::UpdateCommand, CASM::SymCommand, CASM::SelectCommand, CASM::RmCommand, CASM::QueryCommand, CASM::InfoCommand, CASM::ImportCommand, CASM::EnumCommand, and CASM::BsetCommand.

◆ vm()

template<typename _OptionType >
const po::variables_map& CASM::APICommand< _OptionType >::vm ( ) const
inline

Definition at line 59 of file APICommand.hh.

◆ vm_count_check()

virtual int CASM::APICommandBase::vm_count_check ( ) const
pure virtualinherited

Implemented in CASM::UpdateCommand, CASM::SymCommand, CASM::SelectCommand, CASM::RmCommand, CASM::QueryCommand, CASM::InfoCommand, CASM::ImportCommand, CASM::EnumCommand, and CASM::BsetCommand.

Member Data Documentation

◆ m_args

const CommandArgs& CASM::APICommandBase::m_args
privateinherited

Definition at line 41 of file APICommand.hh.

◆ m_in_project

bool CASM::APICommandBase::m_in_project
privateinherited

Definition at line 42 of file APICommand.hh.

◆ m_opt

template<typename _OptionType >
OptionType& CASM::APICommand< _OptionType >::m_opt
private

Definition at line 64 of file APICommand.hh.

◆ m_primclex

std::unique_ptr<PrimClex> CASM::APICommandBase::m_primclex
mutableprivateinherited

Definition at line 43 of file APICommand.hh.

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