gov.sns.ca
Class Channel

java.lang.Object
  |
  +--gov.sns.ca.Channel

Direct Known Subclasses:

JcaChannel

public abstract class Channel

extends java.lang.Object

Channel is an abstract high level XAL wrapper for a native process variable (PV) channel. Subclasses provide native implementations.

Field Summary

protected static ChannelSystem	channelSystem Static variables
protected boolean	connectionFlag hold connection status
protected ConnectionListener	connectionProxy Notify listeners when connection is made or dropped
protected double	m_dblTmEvt
protected double	m_dblTmIO
protected java.lang.String	m_strId Local Attributes
protected static MessageCenter	messageCenter One Message Center for all Channel events

Constructor Summary

protected	Channel() Creates empty Channel
protected	Channel(java.lang.String name) Creates new Channel
protected	Channel(java.lang.String name, ValueTransform aTransform) Create a new Channel

Method Summary

void	addConnectionListener(ConnectionListener listener) Add a listener of connection changes
abstract Monitor	addMonitorValStatus(IEventSinkValStatus listener, int intMaskFire) Setup a value-status monitor on this channel
abstract Monitor	addMonitorValTime(IEventSinkValTime listener, int intMaskFire) Setup a value-status-timestamp monitor on this channel
abstract Monitor	addMonitorValue(IEventSinkValue listener, int intMaskFire) Setup a value monitor on this channel
java.lang.String	channelName() Returns EPICS channel name for process variable
void	checkConnection() Checks for process variable channel connection and throws a ConnectionException if absent.
protected void	checkConnection(java.lang.String strFuncName) Checks for process variable channel connection and throws a ConnectionException if absent.
abstract boolean	connect_async() Open and secure channel across network, setup a connection monitor
abstract boolean	connect() Open and secure channel across network
abstract void	disconnect() Terminate the network channel connection and clear all events associated with process variable
abstract int	elementCount() Return size of value array associated with process variable
abstract java.lang.Class	elementType() get the Java class associated with the native type of this channel
ArrayValue	getArrayValue() Fetch the data value for the channel and return it as an ArrayValue.
byte[]	getArrByte() Get channel value as array
void	getArrByteCallback(IEventSinkArrByte listener) Get the value of the process variable via a callback to the specified listener.
double[]	getArrDbl()
void	getArrDblCallback(IEventSinkArrDbl listener) Get the value of the process variable via a callback to the specified listener.
float[]	getArrFlt()
void	getArrFltCallback(IEventSinkArrFlt listener) Get the value of the process variable via a callback to the specified listener.
int[]	getArrInt()
void	getArrIntCallback(IEventSinkArrInt listener) Get the value of the process variable via a callback to the specified listener.
double	getEventTimeout() Get the channel access Pend Event timeout
java.lang.String	getId() Return a unique identifier of this channel so as to distinguish channels which share the same PV but have different transforms.
double	getIoTimeout() Get the channel access Pend IO timeout
abstract ChannelStatusRecord	getRawStatusRecord() Return a raw ChannelStatusRecord representing the fetched record for the native type of this channel.
abstract ChannelTimeRecord	getRawTimeRecord() Return a raw ChannelTimeRecord representing the fetched record for the native type of this channel.
protected abstract void	getRawValueCallback(IEventSinkValue listener) Handle a callback for getting the raw value for the channel.
abstract ChannelRecord	getRawValueRecord() Return a raw ChannelRecord representing the fetched record for the native type of this channel.
ChannelStatusRecord	getStatusRecord() Return a ChannelStatusRecord representing the fetched record for the native type of this channel.
static boolean	getSyncRequest()
ChannelTimeRecord	getTimeRecord() Return a ChannelTimeRecord representing the fetched record for the native type of this channel.
abstract java.lang.String	getUnits() Convenience method which returns the units for this channel.
byte	getValByte() Get channel value
void	getValByteCallback(IEventSinkValByte listener) Get the value of the process variable via a callback to the specified listener.
double	getValDbl()
void	getValDblCallback(IEventSinkValDbl listener) Get the value of the process variable via a callback to the specified listener.
int	getValEnum()
float	getValFlt()
void	getValFltCallback(IEventSinkValFlt listener) Get the value of the process variable via a callback to the specified listener.
int	getValInt()
void	getValIntCallback(IEventSinkValInt listener) Get the value of the process variable via a callback to the specified listener.
ChannelRecord	getValueRecord() Return a ChannelRecord representing the fetched record for the native type of this channel.
ValueTransform	getValueTransform() Get the value transform applied to this channel.
boolean	isConnected() Checks if channel is connected to process variable
java.lang.Number	lowerAlarmLimit() Convenience method which returns the lower alarm limit.
java.lang.Number	lowerControlLimit() Convenience method which returns the lower control limit.
java.lang.Number	lowerDisplayLimit() Convenience method which returns the lower display limit.
java.lang.Number	lowerWarningLimit() Convenience method which returns the lower warning limit.
static void	pendEvent(double timeout) Flush the EPICS Channel Access request buffer and wait for asyncrhonous event.
static boolean	pendIO(double timeout) Flush the EPICS Channel Access request buffer and return as soon as complete or timeout has expired.
abstract void	putRawValCallback(byte[] newVal, PutListener listener) Asynchronously put a raw value to the channel process variable.
abstract void	putRawValCallback(byte newVal, PutListener listener) Asynchronously put a raw value to the channel process variable.
abstract void	putRawValCallback(double[] newVal, PutListener listener) Asynchronously put a raw value to the channel process variable.
abstract void	putRawValCallback(double newVal, PutListener listener) Asynchronously put a raw value to the channel process variable.
abstract void	putRawValCallback(float[] newVal, PutListener listener) Asynchronously put a raw value to the channel process variable.
abstract void	putRawValCallback(float newVal, PutListener listener) Asynchronously put a raw value to the channel process variable.
abstract void	putRawValCallback(int[] newVal, PutListener listener) Asynchronously put a raw value to the channel process variable.
abstract void	putRawValCallback(int newVal, PutListener listener) Asynchronously put a raw value to the channel process variable.
abstract void	putRawValCallback(short[] newVal, PutListener listener) Asynchronously put a raw value to the channel process variable.
abstract void	putRawValCallback(short newVal, PutListener listener) Asynchronously put a raw value to the channel process variable.
abstract void	putRawValCallback(java.lang.String newVal, PutListener listener) Asynchronously put a raw value to the channel process variable.
void	putVal(byte newVal) Synchronously put a value to the channel process variable.
void	putVal(byte[] newVal) Synchronously put a value to the channel process variable.
void	putVal(double newVal) Synchronously put a value to the channel process variable.
void	putVal(double[] newVal) Synchronously put a value to the channel process variable.
void	putVal(float newVal) Synchronously put a value to the channel process variable.
void	putVal(float[] newVal) Synchronously put a value to the channel process variable.
void	putVal(int newVal) Synchronously put a value to the channel process variable.
void	putVal(int[] newVal) Synchronously put a value to the channel process variable.
void	putVal(short newVal) Synchronously put a value to the channel process variable.
void	putVal(short[] newVal) Synchronously put a value to the channel process variable.
void	putVal(java.lang.String newVal) Synchronously put a value to the channel process variable.
void	putValCallback(byte[] newVal, PutListener listener) Asynchronously put a value to the channel process variable.
void	putValCallback(byte newVal, PutListener listener) Asynchronously put a value to the channel process variable.
void	putValCallback(double[] newVal, PutListener listener) Asynchronously put a value to the channel process variable.
void	putValCallback(double newVal, PutListener listener) Asynchronously put a value to the channel process variable.
void	putValCallback(float[] newVal, PutListener listener) Asynchronously put a value to the channel process variable.
void	putValCallback(float newVal, PutListener listener) Asynchronously put a value to the channel process variable.
void	putValCallback(int[] newVal, PutListener listener) Asynchronously put a value to the channel process variable.
void	putValCallback(int newVal, PutListener listener) Asynchronously put a value to the channel process variable.
void	putValCallback(short[] newVal, PutListener listener) Asynchronously put a value to the channel process variable.
void	putValCallback(short newVal, PutListener listener) Asynchronously put a value to the channel process variable.
void	putValCallback(java.lang.String newVal, PutListener listener) Asynchronously put a value to the channel process variable.
abstract java.lang.Number	rawLowerAlarmLimit() Convenience method which returns the lower alarm limit.
abstract java.lang.Number	rawLowerControlLimit() Convenience method which returns the lower control limit.
abstract java.lang.Number	rawLowerDisplayLimit() Convenience method which returns the lower display limit.
abstract java.lang.Number	rawLowerWarningLimit() Convenience method which returns the lower warning limit.
abstract java.lang.Number	rawUpperAlarmLimit() Convenience method which returns the upper alarm limit.
abstract java.lang.Number	rawUpperControlLimit() Convenience method which returns the upper control limit.
abstract java.lang.Number	rawUpperDisplayLimit() Convenience method which returns the upper display limit.
abstract java.lang.Number	rawUpperWarningLimit() Convenience method which returns the upper warning limit.
abstract boolean	readAccess() Determine if channel has read access to process variable
void	removeConnectionListener(ConnectionListener listener) Remove a listener of connection changes
void	setChannelName(java.lang.String strNameChan) Set the EPICS channel name for the connection
static void	setDebugMode(boolean bDebug)
void	setEventTimeout(double dblTm) Set the channel access Pend Event timeout
void	setIoTimeout(double dblTm) Set the channel access Pend IO timeout
static void	setSyncRequest(boolean syncFlag) Set synchronized request queueing (via pendX() functions) WARNING - unsure of this architecture
java.lang.Number	upperAlarmLimit() Convenience method which returns the upper alarm limit.
java.lang.Number	upperControlLimit() Convenience method which returns the upper control limit.
java.lang.Number	upperDisplayLimit() Convenience method which returns the upper display limit.
java.lang.Number	upperWarningLimit() Convenience method which returns the upper warning limit.
abstract boolean	writeAccess() Determine if channel has write access to process variable

Methods inherited from class java.lang.Object

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

Field Detail

channelSystem

protected static ChannelSystem channelSystem

Static variables

m_strId

protected java.lang.String m_strId

Local Attributes

m_dblTmIO

protected double m_dblTmIO

m_dblTmEvt

protected double m_dblTmEvt

connectionProxy

protected ConnectionListener connectionProxy

Notify listeners when connection is made or dropped

messageCenter

protected static MessageCenter messageCenter

One Message Center for all Channel events

connectionFlag

protected volatile boolean connectionFlag

hold connection status

Constructor Detail

Channel

protected Channel()

Creates empty Channel

Channel

protected Channel(java.lang.String name)

Creates new Channel

Parameters:

name - EPICS channel name

Channel

protected Channel(java.lang.String name,
                  ValueTransform aTransform)

Create a new Channel

Parameters:

name - The EPICS PV name

aTransform - The transform to apply to PV values

Method Detail

pendIO

public static boolean pendIO(double timeout)

Flush the EPICS Channel Access request buffer and return as soon as complete or timeout has expired. Must use a pendX() function if synchronous request queuing is on! Requests include Channel.connect() and Channel.getVal()

Returns:

false if time out occurs

pendEvent

public static void pendEvent(double timeout)

Flush the EPICS Channel Access request buffer and wait for asyncrhonous event. This function blocks until the time out has expired! Neither will it return until the channel access queue has been processed. Must use a pendX() function if synchronous request queuing is on! Requests include Channel.connectCallback Channel.getValCallback(), Channel.putValCallback and all monitor events.

getValueTransform

public ValueTransform getValueTransform()

Get the value transform applied to this channel.

Returns:

The value transform applied to this channel.

addConnectionListener

public void addConnectionListener(ConnectionListener listener)

Add a listener of connection changes

removeConnectionListener

public void removeConnectionListener(ConnectionListener listener)

Remove a listener of connection changes

getId

public java.lang.String getId()

Return a unique identifier of this channel so as to distinguish channels which share the same PV but have different transforms.

Returns:

A channel identifier built from the PV and value transform

channelName

public java.lang.String channelName()

Returns EPICS channel name for process variable

Returns:

string descriptor for EPICS channel

setChannelName

public void setChannelName(java.lang.String strNameChan)

Set the EPICS channel name for the connection

Parameters:

strNameChan - EPICS channel name

setSyncRequest

public static void setSyncRequest(boolean syncFlag)

Set synchronized request queueing (via pendX() functions) WARNING - unsure of this architecture

getSyncRequest

public static boolean getSyncRequest()

setDebugMode

public static void setDebugMode(boolean bDebug)

setIoTimeout

public void setIoTimeout(double dblTm)

Set the channel access Pend IO timeout

Parameters:

dblTm - I/O timeout

setEventTimeout

public void setEventTimeout(double dblTm)

Set the channel access Pend Event timeout

Parameters:

dblTm - event timeout

getIoTimeout

public double getIoTimeout()

Get the channel access Pend IO timeout

Returns:

I/O timeout

getEventTimeout

public double getEventTimeout()

Get the channel access Pend Event timeout

Returns:

event timeout

connect

public abstract boolean connect()

Open and secure channel across network

Returns:

false if connection could not be established

connect_async

public abstract boolean connect_async()

Open and secure channel across network, setup a connection monitor

Returns:

false if connection could not be established

disconnect

public abstract void disconnect()

Terminate the network channel connection and clear all events associated with process variable

isConnected

public boolean isConnected()

Checks if channel is connected to process variable

Returns:

true if connected

checkConnection

public void checkConnection()
                     throws ConnectionException

Checks for process variable channel connection and throws a ConnectionException if absent.

ConnectionException

checkConnection

protected void checkConnection(java.lang.String strFuncName)
                        throws ConnectionException

Checks for process variable channel connection and throws a ConnectionException if absent.

Parameters:

strFuncName - name of function using connection

ConnectionException

elementType

public abstract java.lang.Class elementType()
                                     throws ConnectionException

get the Java class associated with the native type of this channel

ConnectionException

elementCount

public abstract int elementCount()
                          throws ConnectionException

Return size of value array associated with process variable

Returns:

number of values in process variable

ConnectionException

readAccess

public abstract boolean readAccess()
                            throws ConnectionException

Determine if channel has read access to process variable

Returns:

true if channel has read access

Throws:

ConnectionException - channel not connected

writeAccess

public abstract boolean writeAccess()
                             throws ConnectionException

Determine if channel has write access to process variable

Returns:

true if channel has write access

Throws:

ConnectionException - channel not connected

getUnits

public abstract java.lang.String getUnits()
                                   throws ConnectionException,
                                          GetException

Convenience method which returns the units for this channel.

ConnectionException

GetException

rawUpperDisplayLimit

public abstract java.lang.Number rawUpperDisplayLimit()
                                               throws ConnectionException,
                                                      GetException

Convenience method which returns the upper display limit.

ConnectionException

GetException

rawLowerDisplayLimit

public abstract java.lang.Number rawLowerDisplayLimit()
                                               throws ConnectionException,
                                                      GetException

Convenience method which returns the lower display limit.

ConnectionException

GetException

rawUpperAlarmLimit

public abstract java.lang.Number rawUpperAlarmLimit()
                                             throws ConnectionException,
                                                    GetException

Convenience method which returns the upper alarm limit.

ConnectionException

GetException

rawLowerAlarmLimit

public abstract java.lang.Number rawLowerAlarmLimit()
                                             throws ConnectionException,
                                                    GetException

Convenience method which returns the lower alarm limit.

ConnectionException

GetException

rawUpperWarningLimit

public abstract java.lang.Number rawUpperWarningLimit()
                                               throws ConnectionException,
                                                      GetException

Convenience method which returns the upper warning limit.

ConnectionException

GetException

rawLowerWarningLimit

public abstract java.lang.Number rawLowerWarningLimit()
                                               throws ConnectionException,
                                                      GetException

Convenience method which returns the lower warning limit.

ConnectionException

GetException

rawUpperControlLimit

public abstract java.lang.Number rawUpperControlLimit()
                                               throws ConnectionException,
                                                      GetException

Convenience method which returns the upper control limit.

ConnectionException

GetException

rawLowerControlLimit

public abstract java.lang.Number rawLowerControlLimit()
                                               throws ConnectionException,
                                                      GetException

Convenience method which returns the lower control limit.

ConnectionException

GetException

upperDisplayLimit

public final java.lang.Number upperDisplayLimit()
                                         throws ConnectionException,
                                                GetException

Convenience method which returns the upper display limit.

ConnectionException

GetException

lowerDisplayLimit

public final java.lang.Number lowerDisplayLimit()
                                         throws ConnectionException,
                                                GetException

Convenience method which returns the lower display limit.

ConnectionException

GetException

upperAlarmLimit

public final java.lang.Number upperAlarmLimit()
                                       throws ConnectionException,
                                              GetException

Convenience method which returns the upper alarm limit.

ConnectionException

GetException

lowerAlarmLimit

public final java.lang.Number lowerAlarmLimit()
                                       throws ConnectionException,
                                              GetException

Convenience method which returns the lower alarm limit.

ConnectionException

GetException

upperWarningLimit

public final java.lang.Number upperWarningLimit()
                                         throws ConnectionException,
                                                GetException

Convenience method which returns the upper warning limit.

ConnectionException

GetException

lowerWarningLimit

public final java.lang.Number lowerWarningLimit()
                                         throws ConnectionException,
                                                GetException

Convenience method which returns the lower warning limit.

ConnectionException

GetException

upperControlLimit

public final java.lang.Number upperControlLimit()
                                         throws ConnectionException,
                                                GetException

Convenience method which returns the upper control limit.

ConnectionException

GetException

lowerControlLimit

public final java.lang.Number lowerControlLimit()
                                         throws ConnectionException,
                                                GetException

Convenience method which returns the lower control limit.

ConnectionException

GetException

getValByte

public byte getValByte()
                throws ConnectionException,
                       GetException

Get channel value

Returns:

value of the PV

Throws:

ConnectionException - channel not connected

GetException - general channel access PV get failure

getValEnum

public int getValEnum()
               throws ConnectionException,
                      GetException

ConnectionException

GetException

getValInt

public int getValInt()
              throws ConnectionException,
                     GetException

ConnectionException

GetException

getValFlt

public float getValFlt()
                throws ConnectionException,
                       GetException

ConnectionException

GetException

getValDbl

public double getValDbl()
                 throws ConnectionException,
                        GetException

ConnectionException

GetException

getArrByte

public byte[] getArrByte()
                  throws ConnectionException,
                         GetException

Get channel value as array

Returns:

value array of the PV

Throws:

ConnectionException - channel not connected

GetException - general channel access PV get failure

getArrInt

public int[] getArrInt()
                throws ConnectionException,
                       GetException

ConnectionException

GetException

getArrFlt

public float[] getArrFlt()
                  throws ConnectionException,
                         GetException

ConnectionException

GetException

getArrDbl

public double[] getArrDbl()
                   throws ConnectionException,
                          GetException

ConnectionException

GetException

getArrayValue

public ArrayValue getArrayValue()
                         throws ConnectionException,
                                GetException

Fetch the data value for the channel and return it as an ArrayValue.

ConnectionException

GetException

getRawValueRecord

public abstract ChannelRecord getRawValueRecord()
                                         throws ConnectionException,
                                                GetException

Return a raw ChannelRecord representing the fetched record for the native type of this channel. This is a convenient way to get the value of the PV.

ConnectionException

GetException

getRawStatusRecord

public abstract ChannelStatusRecord getRawStatusRecord()
                                                throws ConnectionException,
                                                       GetException

Return a raw ChannelStatusRecord representing the fetched record for the native type of this channel. This is a convenient way to get the value of the PV along with status.

ConnectionException

GetException

getRawTimeRecord

public abstract ChannelTimeRecord getRawTimeRecord()
                                            throws ConnectionException,
                                                   GetException

Return a raw ChannelTimeRecord representing the fetched record for the native type of this channel. This is a convenient way to get the value of the PV along with status and timestamp.

ConnectionException

GetException

getValueRecord

public final ChannelRecord getValueRecord()
                                   throws ConnectionException,
                                          GetException

Return a ChannelRecord representing the fetched record for the native type of this channel. This is a convenient way to get the value of the PV.

ConnectionException

GetException

getStatusRecord

public final ChannelStatusRecord getStatusRecord()
                                          throws ConnectionException,
                                                 GetException

Return a ChannelStatusRecord representing the fetched record for the native type of this channel. This is a convenient way to get the value of the PV along with status.

ConnectionException

GetException

getTimeRecord

public final ChannelTimeRecord getTimeRecord()
                                      throws ConnectionException,
                                             GetException

Return a ChannelTimeRecord representing the fetched record for the native type of this channel. This is a convenient way to get the value of the PV along with status and timestamp.

ConnectionException

GetException

getRawValueCallback

protected abstract void getRawValueCallback(IEventSinkValue listener)
                                     throws ConnectionException,
                                            GetException

Handle a callback for getting the raw value for the channel.

Parameters:

listener - The receiver of the callback.

Throws:

ConnectionException

GetException

getValByteCallback

public final void getValByteCallback(IEventSinkValByte listener)
                              throws ConnectionException,
                                     GetException

Get the value of the process variable via a callback to the specified listener.

Parameters:

listener - receiver of the callback event.

Throws:

ConnectionException - channel is not connected

GetException - general channel access failure

getValIntCallback

public final void getValIntCallback(IEventSinkValInt listener)
                             throws ConnectionException,
                                    GetException

Get the value of the process variable via a callback to the specified listener.

Parameters:

listener - receiver of the callback event.

Throws:

ConnectionException - channel is not connected

GetException - general channel access failure

getValFltCallback

public final void getValFltCallback(IEventSinkValFlt listener)
                             throws ConnectionException,
                                    GetException

Get the value of the process variable via a callback to the specified listener.

Parameters:

listener - receiver of the callback event.

Throws:

ConnectionException - channel is not connected

GetException - general channel access failure

getValDblCallback

public final void getValDblCallback(IEventSinkValDbl listener)
                             throws ConnectionException,
                                    GetException

Get the value of the process variable via a callback to the specified listener.

Parameters:

listener - receiver of the callback event.

Throws:

ConnectionException - channel is not connected

GetException - general channel access failure

getArrByteCallback

public final void getArrByteCallback(IEventSinkArrByte listener)
                              throws ConnectionException,
                                     GetException

Get the value of the process variable via a callback to the specified listener.

Parameters:

listener - receiver of the callback event.

Throws:

ConnectionException - channel is not connected

GetException - general channel access failure

getArrIntCallback

public final void getArrIntCallback(IEventSinkArrInt listener)
                             throws ConnectionException,
                                    GetException

Get the value of the process variable via a callback to the specified listener.

Parameters:

listener - receiver of the callback event.

Throws:

ConnectionException - channel is not connected

GetException - general channel access failure

getArrFltCallback

public final void getArrFltCallback(IEventSinkArrFlt listener)
                             throws ConnectionException,
                                    GetException

Get the value of the process variable via a callback to the specified listener.

Parameters:

listener - receiver of the callback event.

Throws:

ConnectionException - channel is not connected

GetException - general channel access failure

getArrDblCallback

public final void getArrDblCallback(IEventSinkArrDbl listener)
                             throws ConnectionException,
                                    GetException

Get the value of the process variable via a callback to the specified listener.

Parameters:

listener - receiver of the callback event.

Throws:

ConnectionException - channel is not connected

GetException - general channel access failure

addMonitorValTime

public abstract Monitor addMonitorValTime(IEventSinkValTime listener,
                                          int intMaskFire)
                                   throws ConnectionException,
                                          MonitorException

Setup a value-status-timestamp monitor on this channel

Parameters:

listener - interface to data sink

intMaskFire - code specifying when the monitor is fired or'ed combination of {Monitor.VALUE, Monitor.LOG, Monitor.ALARM}

Returns:

A new monitor

Throws:

ConnectionException - channel is not connected

MonitorException - general monitor failure

addMonitorValStatus

public abstract Monitor addMonitorValStatus(IEventSinkValStatus listener,
                                            int intMaskFire)
                                     throws ConnectionException,
                                            MonitorException

Setup a value-status monitor on this channel

Parameters:

listener - interface to data sink

intMaskFire - code specifying when the monitor is fired or'ed combination of {Monitor.VALUE, Monitor.LOG, Monitor.ALARM}

Returns:

A new monitor

Throws:

ConnectionException - channel is not connected

MonitorException - general monitor failure

addMonitorValue

public abstract Monitor addMonitorValue(IEventSinkValue listener,
                                        int intMaskFire)
                                 throws ConnectionException,
                                        MonitorException

Setup a value monitor on this channel

Parameters:

listener - interface to data sink

intMaskFire - code specifying when the monitor is fired or'ed combination of {Monitor.VALUE, Monitor.LOG, Monitor.ALARM}

Returns:

A new monitor

Throws:

ConnectionException - channel is not connected

MonitorException - general monitor failure

putVal

public void putVal(java.lang.String newVal)
            throws ConnectionException,
                   PutException

Synchronously put a value to the channel process variable.

Parameters:

newVal - value sent to process variable

Throws:

ConnectionException - channel is not connected

PutException - channel access failure, including

putVal

public void putVal(byte newVal)
            throws ConnectionException,
                   PutException

Synchronously put a value to the channel process variable.

Parameters:

newVal - value sent to process variable

Throws:

ConnectionException - channel is not connected

PutException - channel access failure, including

putVal

public void putVal(short newVal)
            throws ConnectionException,
                   PutException

Synchronously put a value to the channel process variable.

Parameters:

newVal - value sent to process variable

Throws:

ConnectionException - channel is not connected

PutException - channel access failure, including

putVal

public void putVal(int newVal)
            throws ConnectionException,
                   PutException

Synchronously put a value to the channel process variable.

Parameters:

newVal - value sent to process variable

Throws:

ConnectionException - channel is not connected

PutException - channel access failure, including

putVal

public void putVal(float newVal)
            throws ConnectionException,
                   PutException

Synchronously put a value to the channel process variable.

Parameters:

newVal - value sent to process variable

Throws:

ConnectionException - channel is not connected

PutException - channel access failure, including

putVal

public void putVal(double newVal)
            throws ConnectionException,
                   PutException

Synchronously put a value to the channel process variable.

Parameters:

newVal - value sent to process variable

Throws:

ConnectionException - channel is not connected

PutException - channel access failure, including

putVal

public void putVal(byte[] newVal)
            throws ConnectionException,
                   PutException

Synchronously put a value to the channel process variable.

Parameters:

newVal - value sent to process variable

Throws:

ConnectionException - channel is not connected

PutException - channel access failure, including

putVal

public void putVal(short[] newVal)
            throws ConnectionException,
                   PutException

Synchronously put a value to the channel process variable.

Parameters:

newVal - value sent to process variable

Throws:

ConnectionException - channel is not connected

PutException - channel access failure, including

putVal

public void putVal(int[] newVal)
            throws ConnectionException,
                   PutException

Synchronously put a value to the channel process variable.

Parameters:

newVal - value sent to process variable

Throws:

ConnectionException - channel is not connected

PutException - channel access failure, including

putVal

public void putVal(float[] newVal)
            throws ConnectionException,
                   PutException

Synchronously put a value to the channel process variable.

Parameters:

newVal - value sent to process variable

Throws:

ConnectionException - channel is not connected

PutException - channel access failure, including

putVal

public void putVal(double[] newVal)
            throws ConnectionException,
                   PutException

Synchronously put a value to the channel process variable.

Parameters:

newVal - value sent to process variable

Throws:

ConnectionException - channel is not connected

PutException - channel access failure, including

putValCallback

public final void putValCallback(java.lang.String newVal,
                                 PutListener listener)
                          throws ConnectionException,
                                 PutException

Asynchronously put a value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putValCallback

public final void putValCallback(byte newVal,
                                 PutListener listener)
                          throws ConnectionException,
                                 PutException

Asynchronously put a value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putValCallback

public final void putValCallback(short newVal,
                                 PutListener listener)
                          throws ConnectionException,
                                 PutException

Asynchronously put a value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putValCallback

public final void putValCallback(int newVal,
                                 PutListener listener)
                          throws ConnectionException,
                                 PutException

Asynchronously put a value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putValCallback

public final void putValCallback(float newVal,
                                 PutListener listener)
                          throws ConnectionException,
                                 PutException

Asynchronously put a value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putValCallback

public final void putValCallback(double newVal,
                                 PutListener listener)
                          throws ConnectionException,
                                 PutException

Asynchronously put a value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putValCallback

public final void putValCallback(byte[] newVal,
                                 PutListener listener)
                          throws ConnectionException,
                                 PutException

Asynchronously put a value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putValCallback

public final void putValCallback(short[] newVal,
                                 PutListener listener)
                          throws ConnectionException,
                                 PutException

Asynchronously put a value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putValCallback

public final void putValCallback(int[] newVal,
                                 PutListener listener)
                          throws ConnectionException,
                                 PutException

Asynchronously put a value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putValCallback

public final void putValCallback(float[] newVal,
                                 PutListener listener)
                          throws ConnectionException,
                                 PutException

Asynchronously put a value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putValCallback

public final void putValCallback(double[] newVal,
                                 PutListener listener)
                          throws ConnectionException,
                                 PutException

Asynchronously put a value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putRawValCallback

public abstract void putRawValCallback(java.lang.String newVal,
                                       PutListener listener)
                                throws ConnectionException,
                                       PutException

Asynchronously put a raw value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putRawValCallback

public abstract void putRawValCallback(byte newVal,
                                       PutListener listener)
                                throws ConnectionException,
                                       PutException

Asynchronously put a raw value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putRawValCallback

public abstract void putRawValCallback(short newVal,
                                       PutListener listener)
                                throws ConnectionException,
                                       PutException

Asynchronously put a raw value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putRawValCallback

public abstract void putRawValCallback(int newVal,
                                       PutListener listener)
                                throws ConnectionException,
                                       PutException

Asynchronously put a raw value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putRawValCallback

public abstract void putRawValCallback(float newVal,
                                       PutListener listener)
                                throws ConnectionException,
                                       PutException

Asynchronously put a raw value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putRawValCallback

public abstract void putRawValCallback(double newVal,
                                       PutListener listener)
                                throws ConnectionException,
                                       PutException

Asynchronously put a raw value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putRawValCallback

public abstract void putRawValCallback(byte[] newVal,
                                       PutListener listener)
                                throws ConnectionException,
                                       PutException

Asynchronously put a raw value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putRawValCallback

public abstract void putRawValCallback(short[] newVal,
                                       PutListener listener)
                                throws ConnectionException,
                                       PutException

Asynchronously put a raw value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putRawValCallback

public abstract void putRawValCallback(int[] newVal,
                                       PutListener listener)
                                throws ConnectionException,
                                       PutException

Asynchronously put a raw value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putRawValCallback

public abstract void putRawValCallback(float[] newVal,
                                       PutListener listener)
                                throws ConnectionException,
                                       PutException

Asynchronously put a raw value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure

putRawValCallback

public abstract void putRawValCallback(double[] newVal,
                                       PutListener listener)
                                throws ConnectionException,
                                       PutException

Asynchronously put a raw value to the channel process variable. Fire the specified callback when put is complete.

Parameters:

newVal - value sent to process variable

listener - The receiver of the callback event

Throws:

ConnectionException - channel is not connected

PutException - general put failure