CASM::APICommandBase Class Reference

#include <APICommand.hh>

Inheritance diagram for CASM::APICommandBase:

Detailed Description

Base class for implementing CASM API command classes

• Do not inherit from this directly, instead inherit from APICommand<OptionType>
• See the run_api_command function for context when implementing virtual functions

Definition at line 18 of file APICommand.hh.

Public Member Functions
	APICommandBase (const CommandArgs &_args)
virtual	~APICommandBase ()
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
const CommandArgs &	m_args
bool	m_in_project
std::unique_ptr< PrimClex >	m_primclex

Constructor & Destructor Documentation

APICommandBase()

CASM::APICommandBase::APICommandBase

(

const CommandArgs &

_args

)

Definition at line 8 of file APICommand.cc.

~APICommandBase()

virtual CASM::APICommandBase::~APICommandBase ( )

inlinevirtual

Definition at line 22 of file APICommand.hh.

Member Function Documentation

args()

const CommandArgs & CASM::APICommandBase::args

(

)

const

Definition at line 11 of file APICommand.cc.

desc()

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

pure virtual

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 virtual

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

Definition at line 15 of file APICommand.cc.

primclex()

PrimClex & CASM::APICommandBase::primclex

(

)

const

Definition at line 17 of file APICommand.cc.

root()

fs::path CASM::APICommandBase::root

(

)

const

Definition at line 13 of file APICommand.cc.

run()

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

pure virtual

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

vm_count_check()

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

pure virtual

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

private

Definition at line 41 of file APICommand.hh.

m_in_project

bool CASM::APICommandBase::m_in_project

private

Definition at line 42 of file APICommand.hh.

m_primclex

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

mutableprivate

Definition at line 43 of file APICommand.hh.

---

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

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