org.epics.pvaClient

Class PvaClientMultiChannel

java.lang.Object

org.epics.pvaClient.PvaClientMultiChannel

public class PvaClientMultiChannel
extends Object

Provides access to multiple channels.

Since:

2015.07

Author:

mrk

Method Summary

Modifier and Type	Method and Description
boolean	allConnected() Are all channels connected?
Status	connect() Connect to the channels with timeout = 5.0.
Status	connect(double timeout) Connect to the channels.
boolean	connectionChange() Has a connection state change occured?
static PvaClientMultiChannel	create(PvaClient pvaClient, String[] channelNames) Create a PvaClientMultiChannel with provider = "pva" and maxNotConnected = 0.
static PvaClientMultiChannel	create(PvaClient pvaClient, String[] channelNames, String providerName) Create a PvaClientMultiChannel with provider = "pva" and maxNotConnected = 0.
static PvaClientMultiChannel	create(PvaClient pvaClient, String[] channelNames, String providerName, int maxNotConnected) Create a PvaClientMultiChannel.
PvaClientMultiGetDouble	createGet() create a pvaClientMultiGetDouble
PvaClientMultiMonitorDouble	createMonitor() Create a pvaClientMultiMonitorDouble.
PvaClientNTMultiGet	createNTGet() Create a pvaClientNTMultiGet.
PvaClientNTMultiGet	createNTGet(String request) Create a pvaClientNTMultiGet;
PvaClientNTMultiMonitor	createNTMonitor() Create a pvaClientNTMultiMonitor.
PvaClientNTMultiMonitor	createNTMonitor(String request) Create a pvaClientNTMultiPut.
PvaClientNTMultiPut	createNTPut() Create a pvaClientNTMultiPut.
PvaClientMultiPutDouble	createPut() create a pvaClientMultiPutDouble
void	destroy() Destroy the pvAccess connection.
String[]	getChannelNames() Get the channelNames.
boolean[]	getIsConnected() Get the connection state of each channel.
PvaClient	getPvaClient() Get pvaClient.
PvaClientChannel[]	getPvaClientChannelArray() Get the pvaClientChannelArray.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static PvaClientMultiChannel create(PvaClient pvaClient,
                                           String[] channelNames)

Create a PvaClientMultiChannel with provider = "pva" and maxNotConnected = 0.

Parameters:

pvaClient - The interface to pvaClient.

channelNames - The names of the channels.

Returns:

The interface to the PvaClientMultiChannel

create

public static PvaClientMultiChannel create(PvaClient pvaClient,
                                           String[] channelNames,
                                           String providerName)

Create a PvaClientMultiChannel with provider = "pva" and maxNotConnected = 0.

Parameters:

pvaClient - The interface to pvaClient.

channelNames - The names of the channels.

providerName - The name of the provider.

Returns:

The interface to the PvaClientMultiChannel

create

public static PvaClientMultiChannel create(PvaClient pvaClient,
                                           String[] channelNames,
                                           String providerName,
                                           int maxNotConnected)

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

destroy

public void destroy()

Destroy the pvAccess connection.

getChannelNames

public String[] getChannelNames()

Get the channelNames.

Returns:

The names.

connect

public Status connect()

Connect to the channels with timeout = 5.0.

Returns:

status of request

connect

public Status connect(double timeout)

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 channels.

Returns:

status of request

allConnected

public boolean allConnected()

Are all channels connected?

Returns:

if all are connected.

connectionChange

public boolean connectionChange()

Has a connection state change occured?

Returns:

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

getIsConnected

public boolean[] getIsConnected()

Get the connection state of each channel.

Returns:

The state of each channel.

getPvaClientChannelArray

public PvaClientChannel[] getPvaClientChannelArray()

Get the pvaClientChannelArray.

Returns:

The interface.

getPvaClient

public PvaClient getPvaClient()

Get pvaClient.

Returns:

The interface.

createGet

public PvaClientMultiGetDouble createGet()

create a pvaClientMultiGetDouble

Returns:

The interface.

createPut

public PvaClientMultiPutDouble createPut()

create a pvaClientMultiPutDouble

Returns:

The interface.

createMonitor

public PvaClientMultiMonitorDouble createMonitor()

Create a pvaClientMultiMonitorDouble.

Returns:

The interface.

createNTPut

public PvaClientNTMultiPut createNTPut()

Create a pvaClientNTMultiPut.

Returns:

The interface.

createNTGet

public PvaClientNTMultiGet createNTGet()

Create a pvaClientNTMultiGet. This calls the next method with request = "value,alarm,timeStamp"

Returns:

The interface.

createNTGet

public PvaClientNTMultiGet createNTGet(String request)

Create a pvaClientNTMultiGet;

Parameters:

request - The request for each channel.

Returns:

The interface.

createNTMonitor

public PvaClientNTMultiMonitor createNTMonitor()

Create a pvaClientNTMultiMonitor. This calls the next method with request = "value,alarm,timeStamp"

Returns:

The interface.

createNTMonitor

public PvaClientNTMultiMonitor createNTMonitor(String request)

Create a pvaClientNTMultiPut.

Parameters:

request - The request for each channel.

Returns:

The interface.