PSEvt/include/ProxyDict.h

Go to the documentation of this file.

#ifndef PSEVT_PROXYDICT_H
#define PSEVT_PROXYDICT_H

//--------------------------------------------------------------------------
// File and Version Information:
//      $Id: ProxyDict.h 7525 2014-01-13 19:52:29Z salnikov@SLAC.STANFORD.EDU $
//
// Description:
//      Class ProxyDict.
//
//------------------------------------------------------------------------

//-----------------
// C/C++ Headers --
//-----------------
#include <string>
#include <map>
#include <typeinfo>
#include <boost/shared_ptr.hpp>

//----------------------
// Base Class Headers --
//----------------------
#include "PSEvt/ProxyDictI.h"

//-------------------------------
// Collaborating Class Headers --
//-------------------------------
#include "PSEvt/EventKey.h"
#include "pdsdata/xtc/Src.hh"

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

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

namespace PSEvt {

/**
 *  @ingroup PSEvt
 *  
 *  @brief Implementation of the proxy dictionary interface.
 *  
 *  This implementation is based on std::map which matches event keys 
 *  (EventKey class) with the corresponding proxy object. 
 *
 *  This software was developed for the LCLS project.  If you use all or 
 *  part of it, please give an appropriate acknowledgment.
 *
 *  @version \$Id: ProxyDict.h 7525 2014-01-13 19:52:29Z salnikov@SLAC.STANFORD.EDU $
 *
 *  @author Andrei Salnikov
 */

class ProxyDict : public ProxyDictI {
public:

  // Constructor
  ProxyDict(const boost::shared_ptr<AliasMap>& amap);

  // Destructor
  virtual ~ProxyDict () ;

protected:

  /**
   *  @brief Add one more proxy object to the dictionary.
   *  
   *  @param[in] proxy   Proxy object for type T.
   *  @param[in] key     Event key for the data object.
   */
  virtual void putImpl( const boost::shared_ptr<ProxyI>& proxy, const EventKey& key );

  /**
   *  @brief Get an object from event
   * 
   *  @param[in] typeinfo  Dynamic type info object
   *  @param[in] source Source detector address.
   *  @param[in] key     Optional key to distinguish different objects of the same type.
   *  @param[out] foundSrc If pointer is non-zero then pointed object will be assigned
   *                       with the exact source address of the returned object.
   *  @return Shared pointer of void type.
   */
  virtual boost::shared_ptr<void> getImpl( const std::type_info* typeinfo, 
                                           const Source& source, 
                                           const std::string& key,
                                           Pds::Src* foundSrc );

  /**
   *  @brief Check if proxy of given type exists in the event
   *  
   *  @param[in] key     Event key for the data object.
   *  @return true if proxy exists
   */
  virtual bool existsImpl(const EventKey& key);

  /**
   *  @brief Remove object of given type from the event
   *  
   *  @param[in] key     Event key for the data object.
   *  @return false if object did not exist before this call
   */
  virtual bool removeImpl(const EventKey& key);

  /**
   *  @brief Get the list of event keys defined in event
   *  
   *  @param[in]  source matching source address
   *  @param[out] keys list of the EventKey objects
   */
  virtual void keysImpl(std::list<EventKey>& keys, const Source& source) const;

  /**
   *  @brief Return pointer to alias map
   *
   *  Can return 0 pointer if alias map is not present.
   */
  virtual const AliasMap* aliasMap() const { return m_amap.get(); }

private:

  typedef boost::shared_ptr<ProxyI> proxy_ptr;
  typedef std::map<EventKey,proxy_ptr> Dict;

  // Data members
  Dict m_dict;
  boost::shared_ptr<AliasMap> m_amap;

};

} // namespace PSEvt

#endif // PSEVT_PROXYDICT_H

---