KeyIndexT.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2020 Total, S.A
 * Copyright (c) 2019-     GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */

#ifndef GEOSX_DATAREPOSITORY_KEYINDEXT_HPP_
#define GEOSX_DATAREPOSITORY_KEYINDEXT_HPP_

#include <string>
#include <ostream>

template< typename KEY_TYPE = std::string,
          typename INDEX_TYPE = int,
          int INVALID_INDEX = -1 >
class KeyIndexT
{
public:
  using key_type      = KEY_TYPE;

  using index_type    = INDEX_TYPE;

  constexpr static INDEX_TYPE invalid_index = INVALID_INDEX;

  KeyIndexT() = delete;

  KeyIndexT( KEY_TYPE const & key ):
    m_key( key ),
    m_index( INVALID_INDEX )
  {}

  KeyIndexT( KeyIndexT const & ) = default;

  KeyIndexT & operator=( KeyIndexT const & ) = default;

  KeyIndexT( KeyIndexT && ) = default;

  KeyIndexT & operator=( KeyIndexT && ) = default;

  bool operator==( KEY_TYPE const & key ) const
  { return m_key == key; }

  virtual ~KeyIndexT() {}

  KEY_TYPE const & Key() const
  { return m_key; }

  INDEX_TYPE const & Index() const
  { return m_index; }

  bool isIndexSet() const
  {
    return m_index==INVALID_INDEX ? false : true;
  }

  void setIndex( INDEX_TYPE const & index ) const
  {
    m_index = index;
  }

private:
  KEY_TYPE const m_key;

  INDEX_TYPE mutable m_index;
};

template< typename KEY_TYPE, typename INDEX_TYPE, int INVALID_INDEX >
std::ostream & operator<<( std::ostream & os, const KeyIndexT< KEY_TYPE, INDEX_TYPE, INVALID_INDEX > key )
{
  os << key.Key();
  return os;
}

#endif /* GEOSX_DATAREPOSITORY_KEYINDEXT_HPP_ */