PSEvt::ProxyI Class Reference
[PSEvt package]

Class defining interface for all proxy classes. More...

#include <ProxyI.h>

Inheritance diagram for PSEvt::ProxyI:

List of all members.

Public Member Functions
virtual	~ProxyI ()
boost::shared_ptr< void >	get (ProxyDictI *dict, const Pds::Src &source, const std::string &key)
	Get the object from the proxy.
Protected Member Functions
	ProxyI ()
virtual boost::shared_ptr< void >	getImpl (ProxyDictI *dict, const Pds::Src &source, const std::string &key)=0
	Get the object from the proxy.

---

Detailed Description

Class defining interface for all proxy classes.

This is the interface used by the proxy dictionary which stores the objects of this type. This interface is untyped, as it returns pointer to void. It should not be exposed to user code.

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

See also:

ProxyDictI

Version:

$Id: ProxyI.h 1840 2011-05-07 01:48:35Z salnikov $

Author:

Andrei Salnikov

Definition at line 61 of file ProxyI.h.

---

Constructor & Destructor Documentation

virtual PSEvt::ProxyI::~ProxyI

(

)

[inline, virtual]

Definition at line 65 of file ProxyI.h.

PSEvt::ProxyI::ProxyI

(

)

[inline, protected]

Definition at line 93 of file ProxyI.h.

---

Member Function Documentation

boost::shared_ptr<void> PSEvt::ProxyI::get	(	ProxyDictI *	dict,
		const Pds::Src &	source,
		const std::string &	key
	)			[inline]

Get the object from the proxy.

The parameters passed to the proxy can be used by the proxy to find additional information from the same (or different) detector.

By default the request is forwarded to the virtual method getImp() (customization point) but there is a possibility to do something else too if needed.

Parameters:

[in]	dict	Proxy dictionary containing this proxy.
[in]	source	Detector address information
[in]	key	String key, additional key supplied by user.

Returns:

Shared pointer of void type.

Definition at line 83 of file ProxyI.h.

References getImpl().

virtual boost::shared_ptr<void> PSEvt::ProxyI::getImpl	(	ProxyDictI *	dict,
		const Pds::Src &	source,
		const std::string &	key
	)			[protected, pure virtual]

Get the object from the proxy.

The parameters passed to the proxy can be used by the proxy to find additional information from the same (or different) detector.

Parameters:

[in]	dict	Proxy dictionary containing this proxy.
[in]	source	Detector address information
[in]	key	String key, additional key supplied by user.

Returns:

Shared pointer of void type.

Implemented in PSEvt::Proxy< T >.

Referenced by get().

---

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

• PSEvt/include/ProxyI.h

---