KIM_ModelRoutineName.hpp

Go to the documentation of this file.

//
// KIM-API: An API for interatomic models
// Copyright (c) 2013--2022, Regents of the University of Minnesota.
// All rights reserved.
//
// Contributors:
//    Ryan S. Elliott
//
// SPDX-License-Identifier: LGPL-2.1-or-later
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the Free Software Foundation,
// Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//

//
// Release: This file is part of the kim-api-2.3.0 package.
//


#ifndef KIM_MODEL_ROUTINE_NAME_HPP_
#define KIM_MODEL_ROUTINE_NAME_HPP_

#include <string>

namespace KIM
{
class ModelRoutineName
{
 public:
  int modelRoutineNameID;

  ModelRoutineName();

  ModelRoutineName(int const id);

  ModelRoutineName(std::string const & str);

  bool Known() const;

  bool operator==(ModelRoutineName const & rhs) const;

  bool operator!=(ModelRoutineName const & rhs) const;

  std::string const & ToString() const;
};  // class ModelRoutineName

namespace MODEL_ROUTINE_NAME
{
extern ModelRoutineName const Create;

extern ModelRoutineName const ComputeArgumentsCreate;

extern ModelRoutineName const Compute;

extern ModelRoutineName const Extension;

extern ModelRoutineName const Refresh;

extern ModelRoutineName const WriteParameterizedModel;

extern ModelRoutineName const ComputeArgumentsDestroy;

extern ModelRoutineName const Destroy;


void GetNumberOfModelRoutineNames(int * const numberOfModelRoutineNames);

int GetModelRoutineName(int const index,
                        ModelRoutineName * const modelRoutineName);

struct Comparator
{
  bool operator()(ModelRoutineName const & a, ModelRoutineName const & b) const
  {
    return a.modelRoutineNameID < b.modelRoutineNameID;
  }
};  // struct Comparator
}  // namespace MODEL_ROUTINE_NAME
}  // namespace KIM

#endif  // KIM_MODEL_ROUTINE_NAME_HPP_