KIM_Collection.hpp

Go to the documentation of this file.

//
// CDDL HEADER START
//
// The contents of this file are subject to the terms of the Common Development
// and Distribution License Version 1.0 (the "License").
//
// You can obtain a copy of the license at
// http://www.opensource.org/licenses/CDDL-1.0.  See the License for the
// specific language governing permissions and limitations under the License.
//
// When distributing Covered Code, include this CDDL HEADER in each file and
// include the License file in a prominent location with the name LICENSE.CDDL.
// If applicable, add the following below this CDDL HEADER, with the fields
// enclosed by brackets "[]" replaced with your own identifying information:
//
// Portions Copyright (c) [yyyy] [name of copyright owner]. All rights reserved.
//
// CDDL HEADER END
//

//
// Copyright (c) 2016--2019, Regents of the University of Minnesota.
// All rights reserved.
//
// Contributors:
//    Ryan S. Elliott
//

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


#ifndef KIM_COLLECTION_HPP_
#define KIM_COLLECTION_HPP_

#include <string>

namespace KIM
{
class Collection
{
 public:
  int collectionID;

  Collection();

  Collection(int const id);

  Collection(std::string const & str);

  bool Known() const;

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

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

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

namespace COLLECTION
{
extern Collection const system;

extern Collection const user;

extern Collection const environmentVariable;

extern Collection const currentWorkingDirectory;


void GetNumberOfCollections(int * const numberOfCollections);

int GetCollection(int const index, Collection * const collection);

struct Comparator
{
  bool operator()(Collection const & a, Collection const & b) const
  {
    return a.collectionID < b.collectionID;
  }
};  // struct Comparator
}  // namespace COLLECTION
}  // namespace KIM

#endif  // KIM_COLLECTION_HPP_