PSEnv/include/EpicsStoreImpl.h

Go to the documentation of this file.

#ifndef PSENV_EPICSSTOREIMPL_H
#define PSENV_EPICSSTOREIMPL_H

//--------------------------------------------------------------------------
// File and Version Information:
//      $Id: EpicsStoreImpl.h 8426 2014-06-17 01:39:57Z davidsch@SLAC.STANFORD.EDU $
//
// Description:
//      Class EpicsStoreImpl.
//
//------------------------------------------------------------------------

//-----------------
// C/C++ Headers --
//-----------------
#include <string>
#include <vector>
#include <map>
#include <boost/shared_ptr.hpp>
#include <boost/utility.hpp>
#include <tr1/tuple>

//----------------------
// Base Class Headers --
//----------------------

//-------------------------------
// Collaborating Class Headers --
//-------------------------------
#include "pdsdata/xtc/Src.hh"
#include "psddl_psana/epics.ddl.h"
#include "psddl_psana/EpicsLib.h"
#include "PSEnv/Exceptions.h"
#include "PSTime/Time.h"

//------------------------------------
// Collaborating Class Declarations --
//------------------------------------

//              ---------------------
//              -- Class Interface --
//              ---------------------

namespace PSEnv {

/**
 *  @ingroup PSEnv
 *  
 *  @brief Class that provides implementation for the EPICS PV store.
 *  
 *  This is a part of the EpicsStore implementation detail, should not
 *  be of much interest to end users. Hides all complexities from
 *  EpicsStore class declaration.
 *
 *  This software was developed for the LCLS project.  If you use all or 
 *  part of it, please give an appropriate acknowledgment.
 *
 *  @version \$Id: EpicsStoreImpl.h 8426 2014-06-17 01:39:57Z davidsch@SLAC.STANFORD.EDU $
 *
 *  @author Andrei Salnikov
 */

class EpicsStoreImpl  {
public:

  // Default constructor
  EpicsStoreImpl () ;

  // Destructor
  ~EpicsStoreImpl () ;

  /// Store EPICS PV
  void store(const boost::shared_ptr<Psana::Epics::EpicsPvHeader>& pv, const Pds::Src& src, const std::string *pvName=NULL, long eventTag = -1);
  
  /// Store alias name for EPICS PV.
  void storeAlias(const Pds::Src& src, int pvId, const std::string& alias);

  /// Get the full list of PV names and aliases.
  void names(std::vector<std::string>& names) const;

  /// Get the list of PV names.
  void pvNames(std::vector<std::string>& names) const;

  /// Get the list of PV aliases.
  void aliases(std::vector<std::string>& names) const;

  /// Get alias name for specified PV name.
  std::string alias(const std::string& pv) const;

  /// Get PV name for specified alias name.
  std::string pvName(const std::string& alias) const;

  /// Get CTRL object for given EPICS PV name
  template <typename T>
  boost::shared_ptr<T> getCtrl(const std::string& name) const {
    boost::shared_ptr<Psana::Epics::EpicsPvCtrlHeader> ptr = getCtrlImpl(name);
    return boost::dynamic_pointer_cast<T>(ptr);
  }
  
  /// Get TIME object for given EPICS PV name
  template <typename T>
  boost::shared_ptr<T> getTime(const std::string& name) const {
    boost::shared_ptr<Psana::Epics::EpicsPvTimeHeader> ptr = getTimeImpl(name);
    return boost::dynamic_pointer_cast<T>(ptr);
  }

  /// Type for storing TIME EPICs pv and eventTag used when storing
  struct TimeHeaderAndEventTag {
    boost::shared_ptr<Psana::Epics::EpicsPvTimeHeader> pv;
    long eventTag;
  TimeHeaderAndEventTag() : pv(), eventTag(-1) {};
    TimeHeaderAndEventTag(boost::shared_ptr<Psana::Epics::EpicsPvTimeHeader> _pv, 
                          long _eventTag) : pv(_pv), eventTag(_eventTag) {};
  }; 

  /// Get TimeHeader and EventTag for a given EPICS PV name. If name not found,
  /// return default TimeHeaderAndEventTag wher pv is NULL.
  TimeHeaderAndEventTag getTimeAndEventTag(const std::string& name) const;

  /// Get base class object for given EPICS PV name
  boost::shared_ptr<Psana::Epics::EpicsPvHeader> getAny(const std::string& name) const ;

  /**
   *   @brief Get status info for the EPICS PV.
   *   
   *   @param[in] name      PV name
   *   @param[out] status   EPICS status value
   *   @param[out] severity EPICS severity value
   *   @param[out] time     Time of the last change, can be (0) if time is unknown
   *   
   *   @throw ExceptionEpicsName  if the name of the PV is not known
   */
  void getStatus(const std::string& name, int& status, int& severity, PSTime::Time& time) const ;

  /**
   *  @brief Get the value of the EPICS PV, convert to requested type.
   *  
   *   @param[in] name     PV name
   *   @param[in] idx      value index (for array PVs use non-zero index)
   *   @return the value of the PV
   *   
   *   @throw ExceptionEpicsName  if the name of the PV is not known
   *   @throw ExceptionEpicsConversion  if the PV value cannot be converted to requested type
   */
  template <typename T>
  T getValue(const std::string& name, unsigned idx=0) const
  {
    boost::shared_ptr<Psana::Epics::EpicsPvHeader> pv = getAny(name);
    if (not pv.get()) throw ExceptionEpicsName(ERR_LOC, name);
    try {
      return Psana::EpicsLib::getEpicsValue<T>(*pv, idx);
    } catch (const std::exception& ex) {
      throw ExceptionEpicsConversion(ERR_LOC, name, typeid(T), ex.what());
    }
  }

protected:

  /// Implementation of the getCtrl which returns generic pointer
  boost::shared_ptr<Psana::Epics::EpicsPvCtrlHeader> getCtrlImpl(const std::string& name) const;

  /// Implementation of the getTime which returns generic pointer
  boost::shared_ptr<Psana::Epics::EpicsPvTimeHeader> getTimeImpl(const std::string& name) const;
  
private:

  // PV id is: src.log(), src.phy(), epics.pvId
  typedef std::tr1::tuple<uint32_t, uint32_t, int> PvId;

  /// Type for mapping from PV id to PV or alias name
  typedef std::map<PvId, std::string> ID2Name;
  
  /// Type for mapping from PV or alias name to PV id
  typedef std::map<std::string, PvId> Name2ID;

  /// Type for mapping from PV name to EpicsPvCtrl* objects
  typedef std::map<std::string, boost::shared_ptr<Psana::Epics::EpicsPvCtrlHeader> > CrtlMap;

  /// Type for mapping from PV name to EpicsPvTime* objects
  typedef std::map<std::string, TimeHeaderAndEventTag > TimeMap;
  
  // Data members
  ID2Name m_id2name;  ///< Mapping from PV ID to its name.
  Name2ID m_name2id;  ///< Mapping from PV name to its ID.
  ID2Name m_id2alias;  ///< Mapping from PV ID to alias name.
  Name2ID m_alias2id;  ///< Mapping from alias name to its ID.
  CrtlMap m_ctrlMap;  ///< Mapping from PV name to EPICS object for CTRL objects
  TimeMap m_timeMap;  ///< Mapping from PV name to EPICS object for TIME objects

};

} // namespace PSEnv

#endif // PSENV_EPICSSTOREIMPL_H

---