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

An easy to use alternative to ChannelGet. More...

#include <pv/pvaClient.h>

Inheritance diagram for epics::pvaClient::PvaClientGet:

Public Member Functions

 POINTER_DEFINITIONS (PvaClientGet)
 
 ~PvaClientGet ()
 Destructor. More...
 
void setRequester (PvaClientGetRequesterPtr const &pvaClientGetRequester)
 Set a user callback. More...
 
void connect ()
 Call issueConnect and then waitConnect. More...
 
void issueConnect ()
 create the channelGet connection to the channel. More...
 
epics::pvData::Status waitConnect ()
 Wait until the channelGet connection to the channel is complete. More...
 
void get ()
 Call issueGet and then waitGet. An exception is thrown if get fails. More...
 
void issueGet ()
 Issue a get and return immediately. More...
 
epics::pvData::Status waitGet ()
 Wait until get completes. More...
 
PvaClientGetDataPtr getData ()
 Get the data/. More...
 
PvaClientChannelPtr getPvaClientChannel ()
 Get the PvaClientChannel;. More...
 

Static Public Member Functions

static PvaClientGetPtr create (PvaClientPtr const &pvaClient, PvaClientChannelPtr const &pvaClientChannel, epics::pvData::PVStructurePtr const &pvRequest)
 Create a PvaClientGet. More...
 

Friends

class ChannelGetRequesterImpl
 

Detailed Description

An easy to use alternative to ChannelGet.

Definition at line 993 of file pvaClient.h.

Constructor & Destructor Documentation

◆ ~PvaClientGet()

epics::pvaClient::PvaClientGet::~PvaClientGet ( )

Destructor.

Definition at line 106 of file pvaClientGet.cpp.

Member Function Documentation

◆ connect()

void epics::pvaClient::PvaClientGet::connect ( )

Call issueConnect and then waitConnect.

An exception is thrown if connect fails.

Exceptions
runtime_errorif failure.

Definition at line 202 of file pvaClientGet.cpp.

◆ create()

PvaClientGetPtr epics::pvaClient::PvaClientGet::create ( PvaClientPtr const &  pvaClient,
PvaClientChannelPtr const &  pvaClientChannel,
epics::pvData::PVStructurePtr const &  pvRequest 
)
static

Create a PvaClientGet.

Parameters
pvaClientInterface to PvaClient
pvaClientChannelInterface to PvaClientChannel
pvRequestThe request structure.
Returns
The interface to the PvaClientGet.

Definition at line 73 of file pvaClientGet.cpp.

◆ get()

void epics::pvaClient::PvaClientGet::get ( )

Call issueGet and then waitGet. An exception is thrown if get fails.

Definition at line 242 of file pvaClientGet.cpp.

◆ getData()

PvaClientGetDataPtr epics::pvaClient::PvaClientGet::getData ( )

Get the data/.

Returns
The interface.

Definition at line 281 of file pvaClientGet.cpp.

◆ getPvaClientChannel()

PvaClientChannelPtr epics::pvaClient::PvaClientGet::getPvaClientChannel ( )

Get the PvaClientChannel;.

Returns
The interface.

Definition at line 301 of file pvaClientGet.cpp.

◆ issueConnect()

void epics::pvaClient::PvaClientGet::issueConnect ( )

create the channelGet connection to the channel.

This can only be called once.

Definition at line 216 of file pvaClientGet.cpp.

◆ issueGet()

void epics::pvaClient::PvaClientGet::issueGet ( )

Issue a get and return immediately.

Definition at line 256 of file pvaClientGet.cpp.

◆ POINTER_DEFINITIONS()

epics::pvaClient::PvaClientGet::POINTER_DEFINITIONS ( PvaClientGet  )

◆ setRequester()

void epics::pvaClient::PvaClientGet::setRequester ( PvaClientGetRequesterPtr const &  pvaClientGetRequester)

Set a user callback.

Parameters
pvaClientGetRequesterThe requester which must be implemented by the caller.

Definition at line 292 of file pvaClientGet.cpp.

◆ waitConnect()

Status epics::pvaClient::PvaClientGet::waitConnect ( )

Wait until the channelGet connection to the channel is complete.

Returns
status;

Definition at line 232 of file pvaClientGet.cpp.

◆ waitGet()

Status epics::pvaClient::PvaClientGet::waitGet ( )

Wait until get completes.

Returns
status;

Definition at line 272 of file pvaClientGet.cpp.

Friends And Related Function Documentation

◆ ChannelGetRequesterImpl

friend class ChannelGetRequesterImpl
friend

Definition at line 1095 of file pvaClient.h.


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