Package xal.ca

Class Channel

java.lang.Object
xal.ca.Channel
Direct Known Subclasses:
Epics7Channel
public abstract class Channel extends Object
Channel is an abstract high level XAL wrapper for a native process variable (PV) channel. Subclasses provide native implementations.
Version:
1.1
Author:
Christopher K. Allen, Tom Pelaia

  • Field Details

    • channelSystem

      protected static ChannelSystem channelSystem

    • strId

      protected String strId
      channel name

    • dblTmIO

      protected double dblTmIO
      pend IO timeout

    • dblTmEvt

      protected double dblTmEvt
      pend event timeout

    • connectionProxy

      protected ConnectionListener connectionProxy
      Notify listeners when connection is made or dropped

    • messageCenter

      protected static MessageCenter messageCenter
      One MessageCenter for all Channel events

    • connectionFlag

      protected volatile boolean connectionFlag
      hold connection status

  • Constructor Details

    • Channel

      protected Channel()
      Creates empty Channel

    • Channel

      protected Channel(String name)
      Creates new Channel
      Parameters:
      name - EPICS channel name

    • Channel

      protected Channel(String name, ValueTransform aTransform)
      Create a new Channel
      Parameters:
      name - The EPICS PV name
      aTransform - The transform to apply to PV values

  • Method Details

    • flushIO

      public static void flushIO()
      flush IO requests

    • 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()
      Parameters:
      timeout - time to wait before giving up
      Returns:
      false if time out occurs

    • pendEvent

      public static void pendEvent(double timeout)
      Flush the EPICS Channel Access request buffer and wait for asynchronous 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.
      Parameters:
      timeout - time to wait before giving up

    • getInstance

      public static Channel getInstance(String signalName)
      From the default channel factory, get a channel for the specified signal name.
      Parameters:
      signalName - the PV for which to get the channel
      Returns:
      a channel for the specified PV

    • getInstance

      public static Channel getInstance(String signalName, ValueTransform transform)
      From the default channel factory, get a channel for the specified signal name and value transform.
      Parameters:
      signalName - the PV for which to get the channel
      transform - to transform the value between raw and physical
      Returns:
      a channel for the specified PV

    • setValid

      public void setValid(boolean valid)
      set whether this channel is valid
      Parameters:
      valid - marks whether the channel is valid (true) or not (false)

    • isValid

      public boolean isValid()
      determine whether this channel is valid
      Returns:
      true if it the channel is valid and false if not

    • 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
      Parameters:
      listener - to register for connection events

    • removeConnectionListener

      public void removeConnectionListener(ConnectionListener listener)
      Remove a listener of connection changes
      Parameters:
      listener - to remove from receiving connection events

    • getId

      public 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 String channelName()
      Returns EPICS channel name for process variable
      Returns:
      string descriptor for EPICS channel

    • setChannelName

      public void setChannelName(String strNameChan)
      Set the EPICS channel name for the connection
      Parameters:
      strNameChan - EPICS channel name

    • 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

    • connectAndWait

      public boolean connectAndWait()
      Connect and wait the default timeout.
      Returns:
      true if the connection was made within the timeout and false if not

    • connectAndWait

      public abstract boolean connectAndWait(double timeout)
      Request a new connection and wait for it no longer than the timeout.
      Parameters:
      timeout - seconds to wait for a connection before giving up
      Returns:
      true if the connection was made within the timeout and false if not

    • requestConnection

      public abstract void requestConnection()
      Request that the channel be connected. Connections are made in the background so this method returns immediately upon making the request. The connection will be made in the future as soon as possible. A connection event will be sent to registered connection listeners when the connection has been 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.
      Throws:
      ConnectionException - accordingly

    • checkConnection

      protected void checkConnection(String methodName) throws ConnectionException
      Checks for process variable channel connection and throws a ConnectionException if absent after attempting a connection if necessary.
      Parameters:
      methodName - name of method using connection
      Throws:
      ConnectionException - accordingly

    • checkConnection

      protected void checkConnection(String methodName, boolean attemptConnection) throws ConnectionException
      Checks for process variable channel connection and throws a ConnectionException if absent.
      Parameters:
      methodName - name of method using connection
      attemptConnection - indicates whether or not to attempt a blocking connection request
      Throws:
      ConnectionException - accordingly

    • elementType

      public abstract Class<?> elementType() throws ConnectionException
      get the Java class associated with the native type of this channel
      Returns:
      the native element type
      Throws:
      ConnectionException - accordingly

    • elementCount

      public abstract int elementCount() throws ConnectionException
      Return size of value array associated with process variable
      Returns:
      number of values in process variable
      Throws:
      ConnectionException - accordingly

    • 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 String getUnits() throws GetException
      Convenience method which returns the units for this channel.
      Returns:
      the units
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getOperationLimitPVs

      public abstract String[] getOperationLimitPVs()
      Get the lower and upper operation limit PVs
      Returns:
      two element array of PVs with the lower and upper limit PVs

    • getWarningLimitPVs

      public abstract String[] getWarningLimitPVs()
      Get the lower and upper warning limit PVs
      Returns:
      two element array of PVs with the lower and upper limit PVs

    • getAlarmLimitPVs

      public abstract String[] getAlarmLimitPVs()
      Get the lower and upper alarm limit PVs
      Returns:
      two element array of PVs with the lower and upper limit PVs

    • getDriveLimitPVs

      public abstract String[] getDriveLimitPVs()
      Get the lower and upper drive limit PVs
      Returns:
      two element array of PVs with the lower and upper limit PVs

    • rawUpperDisplayLimit

      public abstract Number rawUpperDisplayLimit() throws GetException
      Convenience method which returns the upper display limit.
      Returns:
      the raw upper display limit
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • rawLowerDisplayLimit

      public abstract Number rawLowerDisplayLimit() throws GetException
      Convenience method which returns the lower display limit.
      Returns:
      the raw lower display limit
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • rawUpperAlarmLimit

      public abstract Number rawUpperAlarmLimit() throws GetException
      Convenience method which returns the upper alarm limit.
      Returns:
      the raw upper alarm limit
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • rawLowerAlarmLimit

      public abstract Number rawLowerAlarmLimit() throws GetException
      Convenience method which returns the lower alarm limit.
      Returns:
      the raw lower alarm limit
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • rawUpperWarningLimit

      public abstract Number rawUpperWarningLimit() throws GetException
      Convenience method which returns the upper warning limit.
      Returns:
      the raw upper warning limit
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • rawLowerWarningLimit

      public abstract Number rawLowerWarningLimit() throws GetException
      Convenience method which returns the lower warning limit.
      Returns:
      the raw lower warning limit
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • rawUpperControlLimit

      public abstract Number rawUpperControlLimit() throws GetException
      Convenience method which returns the upper control limit.
      Returns:
      the raw upper control limit
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • rawLowerControlLimit

      public abstract Number rawLowerControlLimit() throws GetException
      Convenience method which returns the lower control limit.
      Returns:
      the raw lower control limit
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • upperDisplayLimit

      public final Number upperDisplayLimit() throws GetException
      Convenience method which returns the upper display limit.
      Returns:
      the upper display limit
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • lowerDisplayLimit

      public final Number lowerDisplayLimit() throws GetException
      Convenience method which returns the lower display limit.
      Returns:
      the lower display limit
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • upperAlarmLimit

      public final Number upperAlarmLimit() throws GetException
      Convenience method which returns the upper alarm limit.
      Returns:
      the upper alarm limit
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • lowerAlarmLimit

      public final Number lowerAlarmLimit() throws GetException
      Convenience method which returns the lower alarm limit.
      Returns:
      the lower alarm limit
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • upperWarningLimit

      public final Number upperWarningLimit() throws GetException
      Convenience method which returns the upper warning limit.
      Returns:
      the upper warning limit
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • lowerWarningLimit

      public final Number lowerWarningLimit() throws GetException
      Convenience method which returns the lower warning limit.
      Returns:
      the lower warning limit
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • upperControlLimit

      public final Number upperControlLimit() throws GetException
      Convenience method which returns the upper control limit.
      Returns:
      upper control limit
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • lowerControlLimit

      public final Number lowerControlLimit() throws GetException
      Convenience method which returns the lower control limit.
      Returns:
      the lower control limit
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getValByte

      public byte getValByte() throws 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 GetException
      Throws:
      GetException

    • getValShort

      public short getValShort() throws GetException
      Throws:
      GetException

    • getValInt

      public int getValInt() throws GetException
      Throws:
      GetException

    • getValLong

      public long getValLong() throws GetException
      Throws:
      GetException

    • getValFlt

      public float getValFlt() throws GetException
      Throws:
      GetException

    • getValDbl

      public double getValDbl() throws GetException
      Throws:
      GetException

    • getValString

      public String getValString() throws GetException
      Throws:
      GetException

    • getArrByte

      public byte[] getArrByte() throws 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 GetException
      Throws:
      GetException

    • getArrLong

      public long[] getArrLong() throws GetException
      Throws:
      GetException

    • getArrShort

      public short[] getArrShort() throws GetException
      Throws:
      GetException

    • getArrFlt

      public float[] getArrFlt() throws GetException
      Throws:
      GetException

    • getArrDbl

      public double[] getArrDbl() throws GetException
      Throws:
      GetException

    • getArrString

      public String[] getArrString() throws GetException
      Throws:
      GetException

    • getArrayValue

      public ArrayValue getArrayValue() throws GetException
      Fetch the data value for the channel and return it as an ArrayValue.
      Returns:
      channel's array value
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getRawValueRecord

      public abstract ChannelRecord getRawValueRecord() throws 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.
      Returns:
      raw channel record
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getRawStringValueRecord

      protected abstract ChannelRecord getRawStringValueRecord() throws GetException
      Get a ChannelRecord representing the fetched record for the specified type.
      Returns:
      the channel record
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getRawStringStatusRecord

      protected abstract ChannelStatusRecord getRawStringStatusRecord() throws GetException
      Get a ChannelStatusRecord representing the fetched record for the specified type.
      Returns:
      the channel record
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getRawStringTimeRecord

      protected abstract ChannelTimeRecord getRawStringTimeRecord() throws GetException
      Get a ChannelTimeRecord representing the fetched record for the specified type.
      Returns:
      the channel record
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getRawStatusRecord

      public abstract ChannelStatusRecord getRawStatusRecord() throws 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.
      Returns:
      raw channel record
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getRawTimeRecord

      public abstract ChannelTimeRecord getRawTimeRecord() throws 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.
      Returns:
      raw channel record
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getValueRecord

      public final ChannelRecord getValueRecord() throws 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.
      Returns:
      channel record
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getStringValueRecord

      public final ChannelRecord getStringValueRecord() throws GetException
      Get a ChannelRecord representing the fetched record for the native type of this channel.
      Returns:
      channel record
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getStringStatusRecord

      public final ChannelRecord getStringStatusRecord() throws GetException
      Get a ChannelStatusRecord representing the fetched record for the native type of this channel.
      Returns:
      channel record
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getStringTimeRecord

      public final ChannelRecord getStringTimeRecord() throws GetException
      Get a ChannelTimeRecord representing the fetched record for the native type of this channel.
      Returns:
      channel record
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getStatusRecord

      public final ChannelStatusRecord getStatusRecord() throws 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.
      Returns:
      channel record
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getTimeRecord

      public final ChannelTimeRecord getTimeRecord() throws 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.
      Returns:
      channel record
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getRawValueCallback

      protected abstract void getRawValueCallback(IEventSinkValue listener) throws GetException
      Handle a callback for getting the raw value for the channel.
      Parameters:
      listener - The receiver of the callback.
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getRawValueCallback

      protected abstract void getRawValueCallback(IEventSinkValue listener, boolean attemptConnection) throws GetException
      Handle a callback for getting the raw value for the channel.
      Parameters:
      listener - The receiver of the callback.
      attemptConnection - indicates whether or not to attempt a blocking connection if this channel is not connected
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getRawValueTimeCallback

      public abstract void getRawValueTimeCallback(IEventSinkValTime listener, boolean attemptConnection) throws GetException
      Submit a non-blocking Get request with callback
      Parameters:
      listener - to receive callback upon completion
      attemptConnection - true to attempt connection and false not to attempt connection
      Throws:
      ConnectionException - accordingly
      GetException - accordingly

    • getValueCallback

      public final void getValueCallback(IEventSinkValue listener) throws 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

    • getValueCallback

      public final void getValueCallback(IEventSinkValue listener, boolean attemptConnection) throws GetException
      Get the value of the process variable via a callback to the specified listener.
      Parameters:
      listener - receiver of the callback event.
      attemptConnection - indicates whether or not to attempt a blocking connection if this channel is not connected
      Throws:
      ConnectionException - channel is not connected
      GetException - general channel access failure

    • getValueTimeCallback

      public final void getValueTimeCallback(IEventSinkValTime listener, boolean attemptConnection) throws GetException
      Get the value time record of the process variable via a callback to the specified listener.
      Parameters:
      listener - receiver of the callback event.
      attemptConnection - indicates whether or not to attempt a blocking connection if this channel is not connected
      Throws:
      ConnectionException - channel is not connected
      GetException - general channel access failure

    • getValByteCallback

      public final void getValByteCallback(IEventSinkValByte listener) throws 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 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 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 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 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 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 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 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 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 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 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(Object newVal) throws 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(String newVal) throws 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 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 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 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 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 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(Integer newVal) throws 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(long newVal) throws 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(Long newVal) throws 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 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 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 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 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(String[] newVal) throws 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 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 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 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 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 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(Integer[] newVal) throws 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(long[] newVal) throws 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(Long[] newVal) throws 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 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 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 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 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(Object newVal, PutListener listener) throws 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(String newVal, PutListener listener) throws 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 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 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 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(long newVal, PutListener listener) throws 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 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 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(String[] newVal, PutListener listener) throws 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 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 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 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(long[] newVal, PutListener listener) throws 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 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 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(String newVal, PutListener listener) throws 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 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 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 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(long newVal, PutListener listener) throws 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 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 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(String[] newVal, PutListener listener) throws 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 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 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 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(long[] newVal, PutListener listener) throws 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 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 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