CASM  1.1.0
A Clusters Approach to Statistical Mechanics
Public Types | Public Member Functions | Static Public Attributes | Private Attributes | List of all members
CASM::SelectCommand Class Reference

#include <select.hh>

+ Inheritance diagram for CASM::SelectCommand:

Detailed Description

'casm select' command

This class wraps a pointer to an implementation class SelectCommandImpl<DataObject> which does most of the work. The implementation classes are defined in the source file.

Definition at line 50 of file select.hh.

Public Types

using ImplBase = SelectCommandImplBase
 
template<typename ConfigType >
using Impl = SelectCommandImpl< ConfigType >
 
typedef Completer::SelectOption OptionType
 

Public Member Functions

 SelectCommand (const CommandArgs &_args, Completer::SelectOption &_opt)
 
 ~SelectCommand ()
 
int vm_count_check () const override
 
int help () const override
 
int desc () const override
 
int run () const override
 
SelectCommandImplBase & impl () const
 
void print_names (std::ostream &sout) const
 
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
 

Static Public Attributes

static const std::string name = "select"
 

Private Attributes

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

Member Typedef Documentation

◆ Impl

template<typename ConfigType >
using CASM::SelectCommand::Impl = SelectCommandImpl<ConfigType>

Definition at line 54 of file select.hh.

◆ ImplBase

using CASM::SelectCommand::ImplBase = SelectCommandImplBase

Definition at line 52 of file select.hh.

◆ OptionType

typedef Completer::SelectOption CASM::APICommand< Completer::SelectOption >::OptionType
inherited

Definition at line 52 of file APICommand.hh.

Constructor & Destructor Documentation

◆ SelectCommand()

CASM::SelectCommand::SelectCommand ( const CommandArgs &  _args,
Completer::SelectOption &  _opt 
)

Definition at line 418 of file select.cc.

◆ ~SelectCommand()

CASM::SelectCommand::~SelectCommand ( )

Definition at line 422 of file select.cc.

Member Function Documentation

◆ args()

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

Definition at line 11 of file APICommand.cc.

◆ count()

int CASM::APICommand< Completer::SelectOption >::count ( std::string  s) const
inlineinherited

Definition at line 57 of file APICommand.hh.

◆ desc()

int CASM::SelectCommand::desc ( ) const
overridevirtual

Implements CASM::APICommandBase.

Definition at line 486 of file select.cc.

◆ help()

int CASM::SelectCommand::help ( ) const
overridevirtual

Implements CASM::APICommandBase.

Definition at line 484 of file select.cc.

◆ impl()

SelectCommandImplBase & CASM::SelectCommand::impl ( ) const

Definition at line 490 of file select.cc.

◆ in_project()

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

Definition at line 15 of file APICommand.cc.

◆ opt()

const OptionType& CASM::APICommand< Completer::SelectOption >::opt ( ) const
inlineinherited

Definition at line 61 of file APICommand.hh.

◆ primclex()

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

Definition at line 17 of file APICommand.cc.

◆ print_names()

void CASM::SelectCommand::print_names ( std::ostream &  sout) const

Definition at line 510 of file select.cc.

◆ root()

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

Definition at line 13 of file APICommand.cc.

◆ run()

int CASM::SelectCommand::run ( ) const
overridevirtual

Implements CASM::APICommandBase.

Definition at line 488 of file select.cc.

◆ vm()

const po::variables_map& CASM::APICommand< Completer::SelectOption >::vm ( ) const
inlineinherited

Definition at line 59 of file APICommand.hh.

◆ vm_count_check()

int CASM::SelectCommand::vm_count_check ( ) const
overridevirtual

Implements CASM::APICommandBase.

Definition at line 424 of file select.cc.

Member Data Documentation

◆ m_args

const CommandArgs& CASM::APICommandBase::m_args
privateinherited

Definition at line 41 of file APICommand.hh.

◆ m_impl

std::unique_ptr<SelectCommandImplBase> CASM::SelectCommand::m_impl
mutableprivate

Definition at line 77 of file select.hh.

◆ m_in_project

bool CASM::APICommandBase::m_in_project
privateinherited

Definition at line 42 of file APICommand.hh.

◆ m_opt

OptionType& CASM::APICommand< Completer::SelectOption >::m_opt
privateinherited

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.

◆ name

const std::string CASM::SelectCommand::name = "select"
static

Definition at line 56 of file select.hh.

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