CASM  1.1.0
A Clusters Approach to Statistical Mechanics
CASM::QueryCommand Class Reference

#include <query.hh>

+ Inheritance diagram for CASM::QueryCommand:

Detailed Description

'casm query' command

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

Definition at line 55 of file query.hh.

Public Types

using ImplBase = QueryCommandImplBase
 
template<typename ConfigType >
using Impl = QueryCommandImpl< ConfigType >
 
typedef Completer::QueryOption OptionType
 

Public Member Functions

 QueryCommand (const CommandArgs &_args, Completer::QueryOption &_opt)
 
 ~QueryCommand ()
 
int vm_count_check () const override
 
int help () const override
 
int desc () const override
 
int run () const override
 
QueryCommandImplBaseimpl () const
 
void print_names (std::ostream &sout) const
 
int count (std::string s) const
 
const po::variables_map & vm () const
 
const OptionTypeopt () const
 
const CommandArgsargs () const
 
fs::path root () const
 
bool in_project () const
 
PrimClexprimclex () const
 

Static Public Attributes

static const std::string name = "query"
 

Private Attributes

std::unique_ptr< QueryCommandImplBasem_impl
 
OptionTypem_opt
 
const CommandArgsm_args
 
bool m_in_project
 
std::unique_ptr< PrimClexm_primclex
 

Member Typedef Documentation

◆ Impl

template<typename ConfigType >
using CASM::QueryCommand::Impl = QueryCommandImpl<ConfigType>

Definition at line 59 of file query.hh.

◆ ImplBase

Definition at line 57 of file query.hh.

◆ OptionType

Definition at line 52 of file APICommand.hh.

Constructor & Destructor Documentation

◆ QueryCommand()

CASM::QueryCommand::QueryCommand ( const CommandArgs _args,
Completer::QueryOption _opt 
)

Definition at line 554 of file query.cc.

◆ ~QueryCommand()

CASM::QueryCommand::~QueryCommand ( )

Definition at line 558 of file query.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::QueryOption >::count ( std::string  s) const
inlineinherited

Definition at line 57 of file APICommand.hh.

◆ desc()

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

Implements CASM::APICommandBase.

Definition at line 596 of file query.cc.

◆ help()

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

Implements CASM::APICommandBase.

Definition at line 594 of file query.cc.

◆ impl()

QueryCommandImplBase & CASM::QueryCommand::impl ( ) const

Definition at line 600 of file query.cc.

◆ in_project()

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

Definition at line 15 of file APICommand.cc.

◆ opt()

const OptionType& CASM::APICommand< Completer::QueryOption >::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::QueryCommand::print_names ( std::ostream &  sout) const

Definition at line 620 of file query.cc.

◆ root()

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

Definition at line 13 of file APICommand.cc.

◆ run()

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

Implements CASM::APICommandBase.

Definition at line 598 of file query.cc.

◆ vm()

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

Definition at line 59 of file APICommand.hh.

◆ vm_count_check()

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

Implements CASM::APICommandBase.

Definition at line 560 of file query.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<QueryCommandImplBase> CASM::QueryCommand::m_impl
mutableprivate

Definition at line 82 of file query.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::QueryOption >::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::QueryCommand::name = "query"
static

Definition at line 61 of file query.hh.


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