LinkManager.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_LINKMANAGER_H
#define GAUDIKERNEL_LINKMANAGER_H
 
// STL includes
#include <memory>
#include <string>
#include <vector>
// Gaudi
#include "GaudiKernel/Kernel.h"
 
class DataObject;
class IOpaqueAddress;
 
class GAUDI_API LinkManager {
 
public:
  enum DirLinkType { INVALID, VALID };
 
  class Link final {
    // friend class LinkManager;
    std::string m_path;
    DataObject* m_pObject = nullptr;
    long m_id = INVALID;
 
  public:
    Link( long id, std::string path, DataObject* pObject = nullptr )
        : m_path( std::move( path ) ), m_pObject( pObject ), m_id( id ) {}
    Link() = default;
    void set( long id, std::string path, DataObject* pObject ) {
      setObject( pObject );
      m_path = std::move( path );
      m_id   = id;
    }
    bool operator==( const Link& link ) const { return link.m_path == m_path; }
    void setObject( const DataObject* pObject ) { m_pObject = const_cast<DataObject*>( pObject ); }
    const DataObject* object() const { return m_pObject; }
    DataObject*       object() { return m_pObject; }
    const std::string& path() const { return m_path; }
    long ID() const { return m_id; }
    IOpaqueAddress* address();
  };
 
private:
  //         without the need for friendship. It needs to 'shunt'
  //         all contained links to a new prefix...
  //         The steps to get there are
  //           1) provide friend access for backwards compatibility
  //           2) add new interface here
  //           3) once released, update MergeEventAlg to use the new
  //              interface
  //           4) revoke friendship.
  //         Now we're at stage 1...
  friend class MergeEventAlg;
  mutable std::vector<Link*> m_linkVector;
 
public:
  LinkManager() = default;
  virtual ~LinkManager();
  static LinkManager* newInstance();
  static void setInstantiator( LinkManager* ( *newInstance )() );
  long size() const { return m_linkVector.size(); }
  bool empty() const { return m_linkVector.empty(); }
  Link* link( long id );
  Link* link( const DataObject* pObject );
  Link* link( const std::string& path );
  long addLink( const std::string& path, const DataObject* pObject ) const;
  long removeLink( const DataObject* pObject ) const;
  long removeLink( const std::string& fullPath ) const;
  long removeLink( long id ) const;
  void clearLinks();
};
#endif // GAUDIKERNEL_LINKMANAGER_H