CASM
AClustersApproachtoStatisticalMechanics
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules
Public Member Functions | Private Member Functions | List of all members
CASM::EnumInterfaceBase Class Referenceabstract
Container » Enumerator

#include <Enumerator.hh>

+ Inheritance diagram for CASM::EnumInterfaceBase:

Detailed Description

Base class for generic use of enumerators that may be accessed through the API.

Definition at line 418 of file Enumerator.hh.

Public Member Functions

 EnumInterfaceBase ()
 
virtual ~EnumInterfaceBase ()
 
virtual std::string help () const =0
 
virtual std::string name () const =0
 
virtual int run (PrimClex &primclex, const jsonParser &kwargs, const Completer::EnumOption &enum_opt) const =0
 
std::unique_ptr
< EnumInterfaceBase > 		clone () const
 

Private Member Functions

virtual EnumInterfaceBase * _clone () const =0
 

Constructor & Destructor Documentation

CASM::EnumInterfaceBase::EnumInterfaceBase ( )
inline

Definition at line 422 of file Enumerator.hh.

virtual CASM::EnumInterfaceBase::~EnumInterfaceBase ( )
inlinevirtual

Definition at line 424 of file Enumerator.hh.

Member Function Documentation

virtual EnumInterfaceBase* CASM::EnumInterfaceBase::_clone ( ) const
privatepure virtual

Implemented in CASM::EnumInterface< Derived >.

std::unique_ptr<EnumInterfaceBase> CASM::EnumInterfaceBase::clone ( ) const
inline

Definition at line 432 of file Enumerator.hh.

virtual std::string CASM::EnumInterfaceBase::help ( ) const
pure virtual

Implemented in CASM::EnumInterface< Derived >.

virtual std::string CASM::EnumInterfaceBase::name ( ) const
pure virtual

Implemented in CASM::EnumInterface< Derived >.

virtual int CASM::EnumInterfaceBase::run ( PrimClex &  primclex,
const jsonParser &  kwargs,
const Completer::EnumOption &  enum_opt 
) const
pure virtual

Implemented in CASM::EnumInterface< Derived >.

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