epics::pvaClient::PvaClientMultiChannel Class Reference

PvaMultiChannel is a synchronous interface for accessing multiple channels. More...

#include "pvaClientMultiChannel.h"

Inheritance diagram for epics::pvaClient::PvaClientMultiChannel:

Collaboration diagram for epics::pvaClient::PvaClientMultiChannel:

Public Member Functions
	POINTER_DEFINITIONS (PvaClientMultiChannel)
	~PvaClientMultiChannel ()
	Destructor. More...
epics::pvData::shared_vector< const std::string >	getChannelNames ()
	Get the channelNames. More...
epics::pvData::Status	connect (double timeout=5)
	Connect to the channels. More...
bool	allConnected ()
	Are all channels connected? More...
bool	connectionChange ()
	Has a connection state change occured? More...
epics::pvData::shared_vector< epics::pvData::boolean >	getIsConnected ()
	Get the connection state of each channel. More...
PvaClientChannelArray	getPvaClientChannelArray ()
	Get the pvaClientChannelArray. More...
PvaClientPtr	getPvaClient ()
	Get pvaClient. More...
PvaClientMultiGetDoublePtr	createGet ()
	create a pvaClientMultiGetDouble More...
PvaClientMultiPutDoublePtr	createPut ()
	Create a pvaClientMultiPutDouble. More...
PvaClientMultiMonitorDoublePtr	createMonitor ()
	Create a pvaClientMultiMonitorDouble. More...
PvaClientNTMultiPutPtr	createNTPut ()
	Create a pvaClientNTMultiPut. More...
PvaClientNTMultiGetPtr	createNTGet (std::string const &request="field(value,alarm,timeStamp)")
	Create a pvaClientNTMultiGet;. More...
PvaClientNTMultiMonitorPtr	createNTMonitor (std::string const &request="field(value,alarm,timeStamp)")
	Create a pvaClientNTMultiPut. More...

Static Public Member Functions
static PvaClientMultiChannelPtr	create (PvaClientPtr const &pvaClient, epics::pvData::shared_vector< const std::string > const &channelNames, std::string const &providerName="pva", size_t maxNotConnected=0)
	Create a PvaClientMultiChannel. More...

Detailed Description

PvaMultiChannel is a synchronous interface for accessing multiple channels.

Author

mrk

Definition at line 60 of file pvaClientMultiChannel.h.

Constructor & Destructor Documentation

epics::pvaClient::PvaClientMultiChannel::~PvaClientMultiChannel

(

)

Destructor.

Definition at line 58 of file pvaClientMultiChannel.cpp.

{
    if(PvaClient::getDebug()) cout<< "PvaClientMultiChannel::~PvaClientMultiChannel()\n";
}

Member Function Documentation

bool epics::pvaClient::PvaClientMultiChannel::allConnected

(

)

Are all channels connected?

Returns

if all are connected.

Definition at line 101 of file pvaClientMultiChannel.cpp.

{
    return (numConnected==numChannel) ? true : false;
}

Status epics::pvaClient::PvaClientMultiChannel::connect

(

double

timeout = 5

)

Connect to the channels.

This calls issueConnect and waitConnect. An exception is thrown if connect fails.

Parameters

timeout

The time to wait for connecting to the channel.

Returns

status of request

Definition at line 73 of file pvaClientMultiChannel.cpp.

{
    for(size_t i=0; i< numChannel; ++i) {
        pvaClientChannelArray[i] = pvaClient->createChannel(channelName[i],providerName);
        pvaClientChannelArray[i]->issueConnect();
    }
    Status returnStatus = Status::Ok;
    Status status = Status::Ok;
    size_t numBad = 0;
    for(size_t i=0; i< numChannel; ++i) {
        if(numBad==0) {
            status = pvaClientChannelArray[i]->waitConnect(timeout);
        } else {
            status = pvaClientChannelArray[i]->waitConnect(.001);
        }
        if(status.isOK()) {
            ++numConnected;
            isConnected[i] = true;
            continue;
        }
        if(returnStatus.isOK()) returnStatus = status;
        ++numBad;
        if(numBad>maxNotConnected) break;
    }
    return numBad>maxNotConnected ? returnStatus : Status::Ok;
}

bool epics::pvaClient::PvaClientMultiChannel::connectionChange

(

)

Has a connection state change occured?

Returns

(true, false) if (at least one, no) channel has changed state.

Definition at line 106 of file pvaClientMultiChannel.cpp.

{
    for(size_t i=0; i<numChannel; ++i) {
         PvaClientChannelPtr pvaClientChannel = pvaClientChannelArray[i];
         Channel::shared_pointer channel = pvaClientChannel->getChannel();
         Channel::ConnectionState stateNow = channel->getConnectionState();
         bool connectedNow = stateNow==Channel::CONNECTED ? true : false;
         if(connectedNow!=isConnected[i]) return true;
    }
    return false;
}

PvaClientMultiChannelPtr epics::pvaClient::PvaClientMultiChannel::create ( PvaClientPtr const &  pvaClient, epics::pvData::shared_vector< const std::string > const &  channelNames, std::string const &  providerName = "pva", size_t  maxNotConnected = 0  )

static

Create a PvaClientMultiChannel.

Parameters

pvaClient	The interface to pvaClient.
channelNames	The names of the channel..
providerName	The name of the provider.
maxNotConnected	The maximum number of channels that can be disconnected.

Returns

The interface to the PvaClientMultiChannel

Definition at line 29 of file pvaClientMultiChannel.cpp.

{
    return PvaClientMultiChannelPtr(
        new PvaClientMultiChannel(pvaClient,channelNames,providerName,maxNotConnected));
}

PvaClientMultiGetDoublePtr epics::pvaClient::PvaClientMultiChannel::createGet

(

)

create a pvaClientMultiGetDouble

Returns

The interface.

Definition at line 145 of file pvaClientMultiChannel.cpp.

{
    checkConnected();
    return PvaClientMultiGetDouble::create(shared_from_this(),pvaClientChannelArray);
}

PvaClientMultiMonitorDoublePtr epics::pvaClient::PvaClientMultiChannel::createMonitor

(

)

Create a pvaClientMultiMonitorDouble.

Returns

The interface.

Definition at line 159 of file pvaClientMultiChannel.cpp.

{
    checkConnected();
     return PvaClientMultiMonitorDouble::create(shared_from_this(), pvaClientChannelArray);
}

PvaClientNTMultiGetPtr epics::pvaClient::PvaClientMultiChannel::createNTGet

(

std::string const &

request = "field(value,alarm,timeStamp)"

)

Create a pvaClientNTMultiGet;.

Parameters

request

The request for each channel.

Returns

The interface.

Definition at line 172 of file pvaClientMultiChannel.cpp.

{
    checkConnected();
    PVStructurePtr pvRequest = createRequest->createRequest(request);
    if(!pvRequest) {
        string message = " PvaClientMultiChannel::createNTGet invalid pvRequest: "
             + createRequest->getMessage();
        throw std::runtime_error(message);
    }
    return PvaClientNTMultiGet::create(shared_from_this(), pvaClientChannelArray,pvRequest);
}

PvaClientNTMultiMonitorPtr epics::pvaClient::PvaClientMultiChannel::createNTMonitor

(

std::string const &

request = "field(value,alarm,timeStamp)"

)

Create a pvaClientNTMultiPut.

Parameters

request

The request for each channel.

Returns

The interface.

Definition at line 184 of file pvaClientMultiChannel.cpp.

{
    checkConnected();
    PVStructurePtr pvRequest = createRequest->createRequest(request);
    if(!pvRequest) {
        string message = " PvaClientMultiChannel::createNTMonitor invalid pvRequest: "
             + createRequest->getMessage();
        throw std::runtime_error(message);
    }
    return PvaClientNTMultiMonitor::create(shared_from_this(), pvaClientChannelArray,pvRequest);
}

PvaClientNTMultiPutPtr epics::pvaClient::PvaClientMultiChannel::createNTPut

(

)

Create a pvaClientNTMultiPut.

Returns

The interface.

Definition at line 165 of file pvaClientMultiChannel.cpp.

{
    checkConnected();
    return PvaClientNTMultiPut::create(shared_from_this(), pvaClientChannelArray);
}

PvaClientMultiPutDoublePtr epics::pvaClient::PvaClientMultiChannel::createPut

(

)

Create a pvaClientMultiPutDouble.

Returns

The interface.

Definition at line 152 of file pvaClientMultiChannel.cpp.

{
    checkConnected();
    return PvaClientMultiPutDouble::create(shared_from_this(),pvaClientChannelArray);
}

epics::pvData::shared_vector< const string > epics::pvaClient::PvaClientMultiChannel::getChannelNames

(

)

Get the channelNames.

Returns

The names.

Definition at line 68 of file pvaClientMultiChannel.cpp.

{
    return channelName;
}

epics::pvData::shared_vector< epics::pvData::boolean > epics::pvaClient::PvaClientMultiChannel::getIsConnected

(

)

Get the connection state of each channel.

Returns

The state of each channel.

Definition at line 118 of file pvaClientMultiChannel.cpp.

{
    for(size_t i=0; i<numChannel; ++i) {
         PvaClientChannelPtr pvaClientChannel = pvaClientChannelArray[i];
         if(!pvaClientChannel) {
              isConnected[i] = false;
              continue;
         }
         Channel::shared_pointer channel = pvaClientChannel->getChannel();
         Channel::ConnectionState stateNow = channel->getConnectionState();
         isConnected[i] = (stateNow==Channel::CONNECTED) ? true : false;
    }
    return isConnected;
}

PvaClientPtr epics::pvaClient::PvaClientMultiChannel::getPvaClient

(

)

Get pvaClient.

Returns

The shared pointer.

Definition at line 138 of file pvaClientMultiChannel.cpp.

{
    return pvaClient;
}

PvaClientChannelArray epics::pvaClient::PvaClientMultiChannel::getPvaClientChannelArray

(

)

Get the pvaClientChannelArray.

Returns

The shared pointer.

Definition at line 133 of file pvaClientMultiChannel.cpp.

{
    return pvaClientChannelArray;
}

epics::pvaClient::PvaClientMultiChannel::POINTER_DEFINITIONS

(

PvaClientMultiChannel

)

---

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

• modules/pvaClient/src/pv/pvaClientMultiChannel.h
• modules/pvaClient/src/pvaClientMultiChannel.cpp