pvaClientCPP  4.8.1-dev
Public Member Functions | Static Protected Member Functions | Friends | List of all members
epics::pvaClient::PvaClientMultiMonitorDouble Class Reference

Provides a monitor to multiple channels where each channel has a numeric scalar value field. More...

#include <pv/pvaClientMultiChannel.h>

Inheritance diagram for epics::pvaClient::PvaClientMultiMonitorDouble:

Public Member Functions

 POINTER_DEFINITIONS (PvaClientMultiMonitorDouble)
 
 ~PvaClientMultiMonitorDouble ()
 Destructor. More...
 
void connect ()
 Connect a channel monitor for each channel. More...
 
bool poll ()
 Poll each channel. More...
 
bool waitEvent (double secondsToWait)
 Wait until poll returns true. More...
 
epics::pvData::shared_vector< double > get ()
 

Static Protected Member Functions

static PvaClientMultiMonitorDoublePtr create (PvaClientMultiChannelPtr const &pvaClientMultiChannel, PvaClientChannelArray const &pvaClientChannelArray)
 

Friends

class PvaClientMultiChannel
 

Detailed Description

Provides a monitor to multiple channels where each channel has a numeric scalar value field.

Definition at line 267 of file pvaClientMultiChannel.h.

Constructor & Destructor Documentation

◆ ~PvaClientMultiMonitorDouble()

epics::pvaClient::PvaClientMultiMonitorDouble::~PvaClientMultiMonitorDouble ( )

Destructor.

Definition at line 49 of file pvaClientMultiMonitorDouble.cpp.

Member Function Documentation

◆ connect()

void epics::pvaClient::PvaClientMultiMonitorDouble::connect ( )

Connect a channel monitor for each channel.

Definition at line 54 of file pvaClientMultiMonitorDouble.cpp.

◆ create()

PvaClientMultiMonitorDoublePtr epics::pvaClient::PvaClientMultiMonitorDouble::create ( PvaClientMultiChannelPtr const &  pvaClientMultiChannel,
PvaClientChannelArray const &  pvaClientChannelArray 
)
staticprotected

Definition at line 27 of file pvaClientMultiMonitorDouble.cpp.

◆ get()

shared_vector< double > epics::pvaClient::PvaClientMultiMonitorDouble::get ( )

get the data.

Returns
The double[] where each element is the value field of the corresponding channel.

Definition at line 130 of file pvaClientMultiMonitorDouble.cpp.

◆ POINTER_DEFINITIONS()

epics::pvaClient::PvaClientMultiMonitorDouble::POINTER_DEFINITIONS ( PvaClientMultiMonitorDouble  )

◆ poll()

bool epics::pvaClient::PvaClientMultiMonitorDouble::poll ( )

Poll each channel.

If any has new data it is used to update the double[].

Returns
(false,true) if (no, at least one) value was updated.

Definition at line 82 of file pvaClientMultiMonitorDouble.cpp.

◆ waitEvent()

bool epics::pvaClient::PvaClientMultiMonitorDouble::waitEvent ( double  secondsToWait)

Wait until poll returns true.

Parameters
secondsToWaitThe time to keep trying. A thread sleep of .1 seconds occurs between each call to poll.
Returns
(false,true) if (timeOut, poll returned true).

Definition at line 114 of file pvaClientMultiMonitorDouble.cpp.

Friends And Related Function Documentation

◆ PvaClientMultiChannel

friend class PvaClientMultiChannel
friend

Definition at line 277 of file pvaClientMultiChannel.h.


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