NamedRange.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2024 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#ifndef GAUDI_NAMEDRANGE_H
#define GAUDI_NAMEDRANGE_H 1
// ============================================================================
// Include files
// ============================================================================
// STD & STL
// ============================================================================
#include <string>
// ============================================================================
// GaudiUtils
// ============================================================================
#include <GaudiKernel/Range.h>
// ============================================================================
// ============================================================================
namespace Gaudi {
  // ==========================================================================
  template <class CONTAINER, class ITERATOR = typename Gaudi::details::container<CONTAINER>::Iterator>
  class NamedRange_ : public Gaudi::Range_<CONTAINER, ITERATOR> {
  protected:
    // ========================================================================
    typedef Gaudi::Range_<CONTAINER, ITERATOR> Base;
    typedef NamedRange_<CONTAINER, ITERATOR> Self;
    // ========================================================================
  public:
    // ========================================================================
    NamedRange_() = default;
    NamedRange_( typename Base::iterator ibegin, typename Base::iterator iend, std::string name = "" )
        : Base( ibegin, iend ), m_name( std::move( name ) ) {}
    NamedRange_( const Base& base, std::string name = "" ) : Base( base ), m_name( std::move( name ) ) {}
    NamedRange_( const typename Base::Base& base, std::string name = "" ) : Base( base ), m_name( std::move( name ) ) {}
    NamedRange_( const typename Base::Container& base, std::string name = "" )
        : Base( base ), m_name( std::move( name ) ) {}
    /* constructor of empty range/sequence
     * @param ibegin  iterator to begin of empty sequence
     *  @param name name of the range
     */
    NamedRange_( typename Base::iterator ibegin, std::string name = "" )
        : Base( ibegin, ibegin ), m_name( std::move( name ) ) {}
    ~NamedRange_() = default;
    // ========================================================================
  public:
    // ========================================================================
    NamedRange_ slice( long index1, long index2 ) const { return NamedRange_( Base::slice( index1, index2 ), m_name ); }
    // ========================================================================
  public:
    // ========================================================================
    const std::string& name() const { return m_name; }
    void setName( std::string value ) { m_name = std::move( value ); }
    // ========================================================================
    using Base::operator==;
 
  private:
    // ========================================================================
    std::string m_name; // the name associated to the range
    // ========================================================================
  };
  // ==========================================================================
  template <class CONTAINER>
  NamedRange_<CONTAINER> range( const CONTAINER& cnt, std::string name ) {
    return NamedRange_<CONTAINER>( cnt.begin(), cnt.end(), std::move( name ) );
  }
  // ==========================================================================
} // end of namespace Gaudi
// ============================================================================
// The END
// ============================================================================
#endif // GAUDI_NAMEDRANGE_H