CASM  1.1.0
A Clusters Approach to Statistical Mechanics
Public Member Functions | Private Member Functions | List of all members
CASM::NeighborListInfoInterface Class Referenceabstract

#include <NeighborListInfoInterface.hh>

+ Inheritance diagram for CASM::NeighborListInfoInterface:

Detailed Description

Interface for neighbor list info.

Definition at line 9 of file NeighborListInfoInterface.hh.

Public Member Functions

std::string desc () const override
 
std::string name () const override
 Enumeration method name (i.e. "prim", "supercell", "dof_space", etc.) More...
 
void run (jsonParser const &json_options, PrimClex const *primclex=nullptr) const override
 Run NeighborListInfo info method. More...
 
std::unique_ptr< Cloneable > clone () const
 
std::unique_ptr< Cloneable > move ()
 

Private Member Functions

virtual Cloneable * _clone () const =0
 
virtual Cloneable * _move ()=0
 

Member Function Documentation

◆ _clone()

virtual Cloneable* notstd::Cloneable::_clone ( ) const
privatepure virtualinherited

◆ _move()

virtual Cloneable* notstd::Cloneable::_move ( )
privatepure virtualinherited

◆ clone()

std::unique_ptr<Cloneable> notstd::Cloneable::clone ( ) const
inlineinherited

Definition at line 92 of file cloneable_ptr.hh.

◆ desc()

std::string CASM::NeighborListInfoInterface::desc ( ) const
overridevirtual

Enumeration method description. What will be printed by casm info --desc MethodName.

Implements CASM::InfoInterfaceBase.

Definition at line 133 of file NeighborListInfoInterface.cc.

◆ move()

std::unique_ptr<Cloneable> notstd::Cloneable::move ( )
inlineinherited

Definition at line 95 of file cloneable_ptr.hh.

◆ name()

std::string CASM::NeighborListInfoInterface::name ( ) const
overridevirtual

Enumeration method name (i.e. "prim", "supercell", "dof_space", etc.)

Implements CASM::InfoInterfaceBase.

Definition at line 205 of file NeighborListInfoInterface.cc.

◆ run()

void CASM::NeighborListInfoInterface::run ( jsonParser const &  json_options,
PrimClex const *  primclex = nullptr 
) const
overridevirtual

Run NeighborListInfo info method.

Implements CASM::InfoInterfaceBase.

Definition at line 210 of file NeighborListInfoInterface.cc.

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