epics::pvAccess::MonitorElement::Ref Class Reference

#include "monitor.h"

Public Member Functions
	Ref ()
	Ref (Monitor &M)
	Ref (const Monitor::shared_pointer &M)
	~Ref ()
void	swap (Ref &o)
MonitorElementPtr	letGo ()
void	attach (Monitor &M)
void	attach (const Monitor::shared_pointer &M)
bool	next ()
void	reset ()
Ref &	operator++ ()
	operator hidden_bool_type () const
MonitorElement *	operator-> ()
MonitorElement &	operator* ()
MonitorElement *	get ()
bool	operator== (const Ref &o) const
bool	operator!= (const Ref &o) const

Detailed Description

A (single ownership) smart pointer to extract a MonitorElement from a Monitor queue

To fetch a single element

epics::pvAccess::Monitor::shared_pointer mon(....);
epics::pvAccess::MonitorElement::Ref elem(mon);
if(elem) {
   // do something with element
   assert(elem->pvStructurePtr->getSubField("foo"));
} else {
   // queue was empty
}

To fetch all available elements (c++11)

epics::pvAccess::Monitor::shared_pointer mon(....);
for(auto& elem : *mon) {
   assert(elem.pvStructurePtr->getSubField("foo"));
}

To fetch all available elements (c++98)

epics::pvAccess::Monitor::shared_pointer mon(....);
for(epics::pvAccess::MonitorElement::Ref it(mon); it; ++it) {
   MonitorElement& elem(*it);
   assert(elem.pvStructurePtr->getSubField("foo"));
}

Definition at line 146 of file monitor.h.

Constructor & Destructor Documentation

epics::pvAccess::MonitorElement::Ref::Ref ( )

inline

Definition at line 151 of file monitor.h.

:mon(0), elem() {}

epics::pvAccess::MonitorElement::Ref::Ref ( Monitor &  M )

inline

Definition at line 152 of file monitor.h.

:mon(&M), elem(mon->poll()) {}

epics::pvAccess::MonitorElement::Ref::Ref ( const Monitor::shared_pointer &  M )

inline

Definition at line 153 of file monitor.h.

:mon(M.get()), elem(mon->poll()) {}

epics::pvAccess::MonitorElement::Ref::~Ref ( )

inline

Definition at line 154 of file monitor.h.

{ reset(); }

Member Function Documentation

void epics::pvAccess::MonitorElement::Ref::attach ( Monitor &  M )

inline

Definition at line 172 of file monitor.h.

                            {
        reset();
        mon = &M;
    }

void epics::pvAccess::MonitorElement::Ref::attach ( const Monitor::shared_pointer &  M )

inline

Definition at line 176 of file monitor.h.

                                                {
        reset();
        mon = M.get();
    }

MonitorElement* epics::pvAccess::MonitorElement::Ref::get ( )

inline

Definition at line 203 of file monitor.h.

{ return elem.get(); }

MonitorElementPtr epics::pvAccess::MonitorElement::Ref::letGo ( )

inline

analogous to auto_ptr<>::release() but given a different name to avoid being confused with Monitor::release()

Definition at line 167 of file monitor.h.

                              {
        MonitorElementPtr ret;
        elem.swap(ret);
        return ret;
    }

bool epics::pvAccess::MonitorElement::Ref::next ( )

inline

Definition at line 180 of file monitor.h.

                {
        if(elem) mon->release(elem);
        elem = mon->poll();
        return !!elem;
    }

epics::pvAccess::MonitorElement::Ref::operator hidden_bool_type ( ) const

inline

Definition at line 199 of file monitor.h.

{ return elem.get() ? &mon : 0; }

bool epics::pvAccess::MonitorElement::Ref::operator!= ( const Ref &  o ) const

inline

Definition at line 206 of file monitor.h.

{ return !(*this==o); }

MonitorElement& epics::pvAccess::MonitorElement::Ref::operator* ( )

inline

Definition at line 202 of file monitor.h.

{ return *elem; }

Ref& epics::pvAccess::MonitorElement::Ref::operator++ ( )

inline

Definition at line 189 of file monitor.h.

                      {// prefix increment.  aka "++(*this)"
        next();
        return *this;
    }

MonitorElement* epics::pvAccess::MonitorElement::Ref::operator-> ( )

inline

Definition at line 201 of file monitor.h.

{ return elem.get(); }

bool epics::pvAccess::MonitorElement::Ref::operator== ( const Ref &  o ) const

inline

Definition at line 205 of file monitor.h.

{ return elem==o.elem; }

void epics::pvAccess::MonitorElement::Ref::reset ( )

inline

Definition at line 185 of file monitor.h.

                 {
        if(elem && mon) mon->release(elem);
        elem.reset();
    }

void epics::pvAccess::MonitorElement::Ref::swap ( Ref &  o )

inline

Definition at line 161 of file monitor.h.

                      {
        std::swap(mon , o.mon);
        std::swap(elem, o.elem);
    }

---

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

• modules/pvAccess/src/client/pv/monitor.h