IDataStreamTool.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2019 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 GAUDIKERNEL_IDATASTREAMTOOL_H
#define GAUDIKERNEL_IDATASTREAMTOOL_H 1

// Include files
// from STL
#include <string>

// from Gaudi
#include "GaudiKernel/IAlgTool.h"

class IEvtSelector;
class EventSelectorDataStream;

class GAUDI_API IDataStreamTool : virtual public IAlgTool {
public:
  DeclareInterfaceID( IDataStreamTool, 2, 0 );

  typedef std::vector<std::string> StreamSpecs;
  typedef long                     size_type;

  virtual StatusCode initializeStream( EventSelectorDataStream* ) = 0;

  virtual StatusCode finalizeStream( EventSelectorDataStream* ) = 0;

  virtual StatusCode getNextStream( const EventSelectorDataStream*&, size_type& ) = 0;

  virtual StatusCode getPreviousStream( const EventSelectorDataStream*&, size_type& ) = 0;

  virtual StatusCode addStream( const std::string& ) = 0;

  virtual StatusCode addStreams( const StreamSpecs& ) = 0;

  virtual StatusCode eraseStream( const std::string& ) = 0;

  virtual EventSelectorDataStream* getStream( size_type ) = 0;

  virtual EventSelectorDataStream* getStream( const std::string& ) = 0;

  virtual EventSelectorDataStream* lastStream() = 0;

  virtual size_type size() = 0;

  virtual StatusCode clear() = 0;

protected:
  virtual StatusCode createSelector( const std::string&, const std::string&, IEvtSelector*& ) = 0;

  virtual StatusCode createStream( const std::string&, const std::string&, EventSelectorDataStream*& ) = 0;
};
#endif // GAUDIKERNEL_IDATASTREAMTOOL_H