CASM::InterfaceBase< OptionType > Class Template Reference

#include <casm_functions.hh>

Detailed Description

template<typename OptionType>
class CASM::InterfaceBase< OptionType >

Base class for generic use of algorithms through the API.

Definition at line 119 of file casm_functions.hh.

Public Member Functions
	InterfaceBase ()
virtual	~InterfaceBase ()
virtual std::string	help () const =0
virtual std::string	name () const =0
virtual int	run (PrimClex const &primclex, jsonParser const &json_options) const =0
std::unique_ptr< InterfaceBase >	clone () const

Private Member Functions
virtual InterfaceBase *	_clone () const =0

Constructor & Destructor Documentation

InterfaceBase()

template<typename OptionType >

CASM::InterfaceBase< OptionType >::InterfaceBase ( )

inline

Definition at line 121 of file casm_functions.hh.

~InterfaceBase()

template<typename OptionType >

virtual CASM::InterfaceBase< OptionType >::~InterfaceBase ( )

inlinevirtual

Definition at line 123 of file casm_functions.hh.

Member Function Documentation

_clone()

template<typename OptionType >

virtual InterfaceBase* CASM::InterfaceBase< OptionType >::_clone ( ) const

privatepure virtual

clone()

template<typename OptionType >

std::unique_ptr<InterfaceBase> CASM::InterfaceBase< OptionType >::clone ( ) const

inline

Definition at line 132 of file casm_functions.hh.

help()

template<typename OptionType >

virtual std::string CASM::InterfaceBase< OptionType >::help ( ) const

pure virtual

name()

template<typename OptionType >

virtual std::string CASM::InterfaceBase< OptionType >::name ( ) const

pure virtual

run()

template<typename OptionType >

virtual int CASM::InterfaceBase< OptionType >::run ( PrimClex const &  primclex, jsonParser const &  json_options  ) const

pure virtual

---

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

• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/app/casm_functions.hh