ISCT_CablingTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ISCT_CablingTool_h
#define ISCT_CablingTool_h
 
//InnerDetector
//to ensure clients can actually use the conversion constructors, include these here (otherwise could be forward declared)
#include "SCT_Cabling/SCT_SerialNumber.h"
#include "SCT_Cabling/SCT_OnlineId.h"
 
//Gaudi includes
#include "GaudiKernel/EventContext.h"
#include "GaudiKernel/IAlgTool.h"
 
//standard includes
#include <cstdint> //C++11
#include <vector>
 
//fwd declarations
class Identifier;
class IdentifierHash;

class ISCT_CablingTool: virtual public IAlgTool {
 public:
  virtual ~ISCT_CablingTool() = default;

  DeclareInterfaceID(ISCT_CablingTool, 1, 0);

  virtual IdentifierHash getHashFromOnlineId(const SCT_OnlineId& onlineId, const bool withWarnings = true) const = 0;
  virtual IdentifierHash getHashFromOnlineId(const SCT_OnlineId& onlineId, const EventContext& ctx, const bool withWarnings = true) const = 0;

  virtual SCT_OnlineId getOnlineIdFromHash(const IdentifierHash& hash) const = 0;
  virtual SCT_OnlineId getOnlineIdFromHash(const IdentifierHash& hash, const EventContext& ctx) const = 0;

  virtual std::uint32_t getRobIdFromHash(const IdentifierHash& hash) const = 0;
  virtual std::uint32_t getRobIdFromHash(const IdentifierHash& hash, const EventContext& ctx) const = 0;

  virtual SCT_OnlineId getOnlineIdFromOfflineId(const Identifier& offlineId) const = 0;
  virtual SCT_OnlineId getOnlineIdFromOfflineId(const Identifier& offlineId, const EventContext& ctx) const = 0;

  virtual std::uint32_t getRobIdFromOfflineId(const Identifier& offlineId) const = 0;
  virtual std::uint32_t getRobIdFromOfflineId(const Identifier& offlineId, const EventContext& ctx) const = 0;

  virtual unsigned int size() const = 0;
  virtual unsigned int size(const EventContext& ctx) const = 0;

  virtual bool empty() const = 0;
  virtual bool empty(const EventContext& ctx) const = 0;

  virtual IdentifierHash getHashFromSerialNumber(const SCT_SerialNumber& sn) const = 0;
  virtual IdentifierHash getHashFromSerialNumber(const SCT_SerialNumber& sn, const EventContext& ctx) const = 0;

  virtual SCT_SerialNumber getSerialNumberFromHash(const IdentifierHash& hash) const = 0;
  virtual SCT_SerialNumber getSerialNumberFromHash(const IdentifierHash& hash, const EventContext& ctx) const = 0;

  virtual void getAllRods(std::vector<std::uint32_t>& usersVector) const = 0;
  virtual void getAllRods(std::vector<std::uint32_t>& usersVector, const EventContext& ctx) const = 0;

  virtual void getHashesForRod(std::vector<IdentifierHash>& usersVector, const std::uint32_t rodId) const = 0;
  virtual void getHashesForRod(std::vector<IdentifierHash>& usersVector, const std::uint32_t rodId, const EventContext& ctx) const = 0;
};
 
#endif // ISCT_CablingTool_h