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

Provides channel monitor to multiple channels where the value field of each channel is presented as a union. More...

#include <pv/pvaClientMultiChannel.h>

Inheritance diagram for epics::pvaClient::PvaClientNTMultiMonitor:

Public Member Functions

 POINTER_DEFINITIONS (PvaClientNTMultiMonitor)
 
 ~PvaClientNTMultiMonitor ()
 Destructor. More...
 
void connect ()
 Connect to a channel monitor for each channel. More...
 
bool poll (bool valueOnly=true)
 Poll each channel. More...
 
bool waitEvent (double secondsToWait)
 Wait until poll returns true. More...
 
PvaClientNTMultiDataPtr getData ()
 Get the data for the last successfull poll. More...
 

Static Protected Member Functions

static PvaClientNTMultiMonitorPtr create (PvaClientMultiChannelPtr const &pvaClientMultiChannel, PvaClientChannelArray const &pvaClientChannelArray, epics::pvData::PVStructurePtr const &pvRequest)
 

Friends

class PvaClientMultiChannel
 

Detailed Description

Provides channel monitor to multiple channels where the value field of each channel is presented as a union.

Definition at line 428 of file pvaClientMultiChannel.h.

Constructor & Destructor Documentation

◆ ~PvaClientNTMultiMonitor()

epics::pvaClient::PvaClientNTMultiMonitor::~PvaClientNTMultiMonitor ( )

Destructor.

Definition at line 60 of file pvaClientNTMultiMonitor.cpp.

Member Function Documentation

◆ connect()

void epics::pvaClient::PvaClientNTMultiMonitor::connect ( )

Connect to a channel monitor for each channel.

Definition at line 66 of file pvaClientNTMultiMonitor.cpp.

◆ create()

PvaClientNTMultiMonitorPtr epics::pvaClient::PvaClientNTMultiMonitor::create ( PvaClientMultiChannelPtr const &  pvaClientMultiChannel,
PvaClientChannelArray const &  pvaClientChannelArray,
epics::pvData::PVStructurePtr const &  pvRequest 
)
staticprotected

Definition at line 28 of file pvaClientNTMultiMonitor.cpp.

◆ getData()

PvaClientNTMultiDataPtr epics::pvaClient::PvaClientNTMultiMonitor::getData ( )

Get the data for the last successfull poll.

Returns
the pvaClientNTMultiData.

Definition at line 136 of file pvaClientNTMultiMonitor.cpp.

◆ POINTER_DEFINITIONS()

epics::pvaClient::PvaClientNTMultiMonitor::POINTER_DEFINITIONS ( PvaClientNTMultiMonitor  )

◆ poll()

bool epics::pvaClient::PvaClientNTMultiMonitor::poll ( bool  valueOnly = true)

Poll each channel.

Parameters
valueOnlyuse only value for union. 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 94 of file pvaClientNTMultiMonitor.cpp.

◆ waitEvent()

bool epics::pvaClient::PvaClientNTMultiMonitor::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 120 of file pvaClientNTMultiMonitor.cpp.

Friends And Related Function Documentation

◆ PvaClientMultiChannel

friend class PvaClientMultiChannel
friend

Definition at line 439 of file pvaClientMultiChannel.h.


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