EPICSv3PV (RBAC 2.3.13-SNAPSHOT API)

java.lang.Object
- org.csstudio.utility.pv.epics.EPICSv3PV

All Implemented Interfaces:

gov.aps.jca.event.ConnectionListener, gov.aps.jca.event.MonitorListener, EventListener, PV
```
public class EPICSv3PV
extends Object
implements PV, gov.aps.jca.event.ConnectionListener, gov.aps.jca.event.MonitorListener
```
EPICS ChannelAccess implementation of the PV interface.

Author:

Kay Kasemir, Jaka Bobnar

See Also:

PV

Constructor Summary

Constructors
Constructor and Description

EPICSv3PV(String name)
Generate an EPICS PV.

Constructors
Constructor and Description
`EPICSv3PV(String name)` Generate an EPICS PV.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(PVListener listener)` Add a new listener.
`void`	`blockUntilFirstUpdate(int timeout)` The calling thread will be blocked until the first update is received from the PV.
`void`	`connectionChanged(gov.aps.jca.event.ConnectionEvent ev)`
`protected void`	`finalize()`
`String`	`getName()` Return the name of this PV.
`String`	`getStateInfo()` Internal state information on the PV.
`IValue`	`getValue()` Get the value.
`IValue`	`getValue(double timeoutSeconds)` Synchronous 'get'.
`boolean`	`isConnected()` Returns true if this PV is connected or false otherwise.
`boolean`	`isRunning()` Returns true if this PV has been started and not yet stopped.
`boolean`	`isWriteAllowed()` Returns true if we have write access to the PV or false if we cannot write to the PV.
`void`	`monitorChanged(gov.aps.jca.event.MonitorEvent ev)`
`void`	`removeListener(PVListener listener)` Remove a listener.
`void`	`setValue(Object newValue)` Set PV to given value.
`void`	`start()` Start the PV: connect, get meta data, subscribe to updates, invoke `PVListener` for incoming values, ...
`void`	`stop()` Stop the PV: disconnect, ...
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EPICSv3PV
```
public EPICSv3PV(String name)
```
    Generate an EPICS PV.
    
    Parameters:
    
    name - The PV name.
- Method Detail
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - getName
```
public String getName()
```
    Description copied from interface: PV
    
    Return the name of this PV.
    
    Specified by:
    
    getName in interface PV
    
    Returns:
    
    the name of the PV
  - getValue
```
public IValue getValue(double timeoutSeconds)
                throws PVException
```
    Description copied from interface: PV
    
    Synchronous 'get'.
    Attempts to get a value within the given timeout. Either returns a value within the timeout, or throws an exception at the timeout.
    When called for a new channel, i.e. on a channel where neither get nor start have been called, it will also perform the connection attempt, and leave the channel connected after getting a value. To force a disconnect, call stop.
    
    Specified by:
    
    getValue in interface PV
    
    Parameters:
    
    timeoutSeconds - timeout in seconds
    
    Returns:
    
    the value read from the IOC
    
    Throws:
    
    PVException - on error
  - getValue
```
public IValue getValue()
```
    Description copied from interface: PV
    
    Get the value.
    This is the most recent value. Check isConnected() to see if this is valid, or use inside a PVListener.pvValueUpdate(PV).
    
    Specified by:
    
    getValue in interface PV
    
    Returns:
    
    Returns the most recent value, or null if there is none.
  - addListener
```
public void addListener(PVListener listener)
```
    Description copied from interface: PV
    
    Add a new listener.
    
    Specified by:
    
    addListener in interface PV
    
    Parameters:
    
    listener - the listener to add
  - removeListener
```
public void removeListener(PVListener listener)
```
    Description copied from interface: PV
    
    Remove a listener.
    
    Specified by:
    
    removeListener in interface PV
    
    Parameters:
    
    listener - the listener to remove
  - start
```
public void start()
           throws PVException
```
    Description copied from interface: PV
    
    Start the PV: connect, get meta data, subscribe to updates, invoke PVListener for incoming values, ...
    
    Specified by:
    
    start in interface PV
    
    Throws:
    
    PVException - if an error occurs during connection
  - isRunning
```
public boolean isRunning()
```
    Description copied from interface: PV
    
    Returns true if this PV has been started and not yet stopped.
    
    Specified by:
    
    isRunning in interface PV
    
    Returns:
    
    true if this pv is running or false otherwise.
  - isConnected
```
public boolean isConnected()
```
    Description copied from interface: PV
    
    Returns true if this PV is connected or false otherwise.
    
    Specified by:
    
    isConnected in interface PV
    
    Returns:
    
    true when connected. While isRunning, we are subscribed for value updates, but we might still be disconnected, at least temporarily.
  - isWriteAllowed
```
public boolean isWriteAllowed()
```
    Description copied from interface: PV
    
    Returns true if we have write access to the PV or false if we cannot write to the PV.
    
    Specified by:
    
    isWriteAllowed in interface PV
    
    Returns:
    
    true if we have write access to the PV
  - getStateInfo
```
public String getStateInfo()
```
    Description copied from interface: PV
    
    Internal state information on the PV.
    Especially when isConnected() is false, this information might help to diagnose the problem: Did the PV never connect? Was it once connected, but some error occurred?
    
    Specified by:
    
    getStateInfo in interface PV
    
    Returns:
    
    Some human readable state info
  - stop
```
public void stop()
```
    Description copied from interface: PV
    
    Stop the PV: disconnect, ... When the PV is no longer needed, one should 'stop' it to release resources.
    
    Specified by:
    
    stop in interface PV
  - setValue
```
public void setValue(Object newValue)
              throws PVException
```
    Description copied from interface: PV
    
    Set PV to given value. Should accept Double, Double[], Integer, String, maybe more.
    
    Specified by:
    
    setValue in interface PV
    
    Parameters:
    
    newValue - Value to write to PV
    
    Throws:
    
    PVException - on error
  - connectionChanged
```
public void connectionChanged(gov.aps.jca.event.ConnectionEvent ev)
```
    Specified by:
    
    connectionChanged in interface gov.aps.jca.event.ConnectionListener
  - monitorChanged
```
public void monitorChanged(gov.aps.jca.event.MonitorEvent ev)
```
    Specified by:
    
    monitorChanged in interface gov.aps.jca.event.MonitorListener
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - blockUntilFirstUpdate
```
public void blockUntilFirstUpdate(int timeout)
                           throws PVException
```
    Description copied from interface: PV
    
    The calling thread will be blocked until the first update is received from the PV. If the PV already has a value, the call will return immediately. If no update is received in the given timeout, the method throws an exception.
    
    Specified by:
    
    blockUntilFirstUpdate in interface PV
    
    Parameters:
    
    timeout - the maximum timeout to wait for the update in milliseconds
    
    Throws:
    
    PVException - if no value was received in the specified timeout

Class EPICSv3PV

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EPICSv3PV

Method Detail

finalize

getName

getValue

getValue

addListener

removeListener

start

isRunning

isConnected

isWriteAllowed

getStateInfo

stop

setValue

connectionChanged

monitorChanged

toString

blockUntilFirstUpdate