PSEvt::ProxyDictHist Class Reference
[PSEvt package]

A ProxyDict that implements the HistI interface. More...

#include <ProxyDictHist.h>

Inheritance diagram for PSEvt::ProxyDictHist:

List of all members.

Public Member Functions
	ProxyDictHist (const boost::shared_ptr< AliasMap > &amap)
virtual long	totalUpdates () const
	returns total number of put and remove calls made with dictionary
virtual long	updates (const EventKey &key) const
	returns total number of put and remove calls made for given key
virtual const HistI *	hist () const
	return pointer to history interface object, if implemented
Protected Member Functions
virtual void	putImpl (const boost::shared_ptr< ProxyI > &proxy, const EventKey &key)
	updates count after adding using base class to add to dict.
virtual bool	removeImpl (const EventKey &key)
	updates count after adding using base class to remove from to dict.

---

Detailed Description

A ProxyDict that implements the HistI interface.

This software was developed for the LCLS project. If you use all or part of it, please give an appropriate acknowledgment.

Version:

$Id:

Author:

David Schneider

Definition at line 49 of file ProxyDictHist.h.

---

Constructor & Destructor Documentation

PSEvt::ProxyDictHist::ProxyDictHist

(

const boost::shared_ptr< AliasMap > &

amap

)

[inline]

Definition at line 52 of file ProxyDictHist.h.

---

Member Function Documentation

virtual const HistI* PSEvt::ProxyDictHist::hist

(

)

const [inline, virtual]

return pointer to history interface object, if implemented

If a derived class implements the HistI interface, it can return a pointer to the history object here. The implementation of totalUpdates() should be all updates, put's and remove's, made to the ProxyDict during its existance. The implementation of updates(EventKey&) should be the sum of all puts and removes for the given EventKey.

Reimplemented from PSEvt::ProxyDictI.

Definition at line 66 of file ProxyDictHist.h.

virtual void PSEvt::ProxyDictHist::putImpl	(	const boost::shared_ptr< ProxyI > &	proxy,
		const EventKey &	key
	)			[inline, protected, virtual]

updates count after adding using base class to add to dict.

Parameters:

[in]	proxy	Proxy object for type T.
[in]	key	Event key for the data object.

Reimplemented from PSEvt::ProxyDict.

Definition at line 76 of file ProxyDictHist.h.

References PSEvt::ProxyDict::putImpl().

virtual bool PSEvt::ProxyDictHist::removeImpl

(

const EventKey &

key

)

[inline, protected, virtual]

updates count after adding using base class to remove from to dict.

Does not update count if key was not present.

Parameters:

[in]

key

Event key for the data object.

Returns:

false if object did not exist before this call

Reimplemented from PSEvt::ProxyDict.

Definition at line 90 of file ProxyDictHist.h.

References PSEvt::ProxyDict::removeImpl().

virtual long PSEvt::ProxyDictHist::totalUpdates

(

)

const [inline, virtual]

returns total number of put and remove calls made with dictionary

Implements PSEvt::HistI.

Definition at line 57 of file ProxyDictHist.h.

virtual long PSEvt::ProxyDictHist::updates

(

const EventKey &

key

)

const [inline, virtual]

returns total number of put and remove calls made for given key

Parameters:

[in]

key

key to lookup update count for

Implements PSEvt::HistI.

Definition at line 64 of file ProxyDictHist.h.

---

The documentation for this class was generated from the following file:

• PSEvt/include/ProxyDictHist.h

---