CASM::SymCommand Class Reference

#include <sym.hh>

Inheritance diagram for CASM::SymCommand:

Detailed Description

'casm sym' implementation

Implements:

• (default) write / print prim symmetry
• symmetrize a POSCAR
• DoF space analysis

Definition at line 16 of file sym.hh.

Public Types
typedef Completer::SymOption	OptionType

Public Member Functions
	SymCommand (const CommandArgs &_args, Completer::SymOption &_opt)
int	vm_count_check () const override
int	help () const override
int	desc () const override
int	run () const override
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 = "sym"

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

Member Typedef Documentation

OptionType

typedef Completer::SymOption CASM::APICommand< Completer::SymOption >::OptionType

inherited

Definition at line 52 of file APICommand.hh.

Constructor & Destructor Documentation

SymCommand()

CASM::SymCommand::SymCommand	(	const CommandArgs &	_args,
		Completer::SymOption &	_opt
	)

Definition at line 62 of file sym.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::SymOption >::count ( std::string  s ) const

inlineinherited

Definition at line 57 of file APICommand.hh.

desc()

int CASM::SymCommand::desc ( ) const

overridevirtual

Implements CASM::APICommandBase.

Definition at line 91 of file sym.cc.

help()

int CASM::SymCommand::help ( ) const

overridevirtual

Implements CASM::APICommandBase.

Definition at line 84 of file sym.cc.

in_project()

bool CASM::APICommandBase::in_project ( ) const

inherited

Definition at line 15 of file APICommand.cc.

opt()

const OptionType& CASM::APICommand< Completer::SymOption >::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.

root()

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

inherited

Definition at line 13 of file APICommand.cc.

run()

int CASM::SymCommand::run ( ) const

overridevirtual

Implements CASM::APICommandBase.

Definition at line 102 of file sym.cc.

vm()

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

inlineinherited

Definition at line 59 of file APICommand.hh.

vm_count_check()

int CASM::SymCommand::vm_count_check ( ) const

overridevirtual

Implements CASM::APICommandBase.

Definition at line 65 of file sym.cc.

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

OptionType& CASM::APICommand< Completer::SymOption >::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::SymCommand::name = "sym"

static

Definition at line 18 of file sym.hh.

---

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

• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/app/sym.hh
• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/src/casm/app/sym.cc