Package xal.smf.scada

Class XalPvDescriptor

java.lang.Object
xal.smf.scada.XalPvDescriptor
Direct Known Subclasses:
ScadaFieldDescriptor
public class XalPvDescriptor extends Object
Encapsulates the properties of an EPICS process variable, as referenced through the XAL channel lookup mechanism (that is, through the XAL channel handle).
Since:
Nov 6, 2009
Author:
Christopher K. Allen

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    XalPvDescriptor.IPvDescriptor
    Used by the enumerations to indicate they return PV descriptors for their enumeration values.

  • Constructor Summary

    Constructors
    Constructor
    Description
    XalPvDescriptor(Class<?> clsType, String strHandleRb)
    Create a new XalPvDescriptor object with read back values only.
    XalPvDescriptor(Class<?> clsType, String strHandleRb, String strHandleSet)
    Create a new XalPvDescriptor object that is controllable with the given channel handles and data type.
    XalPvDescriptor(XalPvDescriptor pvd)
    Copy constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Returns a deep copy of this object, as deep as you can get anyway.
    Class<?>
    getPvType()
    Return the data type of Process Variable associate with this handle.
    String
    getRbHandle()
    Return the channel handle for the PV corresponding to the current enumeration constant.
    String
    getSetHandle()
    Returns the channel handle of the channel used to set the PV.
    boolean
    isControllable()
    Indicates whether or not the process variable can be set.
    String
    toString()
    Write out the readback and set signal names for this PV descriptor.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • XalPvDescriptor

      public XalPvDescriptor(Class<?> clsType, String strHandleRb)
      Create a new XalPvDescriptor object with read back values only. The read back channel hand the given handles and the PV value has the given data type.
      Parameters:
      clsType - PV value data type
      strHandleRb - read back channel XAL handle
      Since:
      Nov 6, 2009

    • XalPvDescriptor

      public XalPvDescriptor(Class<?> clsType, String strHandleRb, String strHandleSet)
      Create a new XalPvDescriptor object that is controllable with the given channel handles and data type.
      Parameters:
      clsType - PV value data type
      strHandleRb - read back channel XAL handle
      strHandleSet - set channel XAL handle
      Since:
      Nov 6, 2009

    • XalPvDescriptor

      public XalPvDescriptor(XalPvDescriptor pvd)
      Copy constructor. Create a new a deep copy of the given PV Descriptor.

      NOTE: Added to implement the functionality of PvDescriptor in XAL.
      · Jonathan M. Freed
      · Jul 15, 2014

      Parameters:
      pvd - PV descriptor to be copied
      Since:
      Mar 10, 2011

  • Method Details

    • getRbHandle

      public String getRbHandle()
      Return the channel handle for the PV corresponding to the current enumeration constant.
      Returns:
      XAL channel handle for read back signal
      Since:
      Nov 6, 2009

    • getSetHandle

      public String getSetHandle()
      Returns the channel handle of the channel used to set the PV.
      Returns:
      PV set XAL channel handle
      Since:
      Nov 6, 2009

    • getPvType

      public Class<?> getPvType()
      Return the data type of Process Variable associate with this handle.
      Returns:
      return the data type of the PV value
      Since:
      Nov 6, 2009

    • isControllable

      public boolean isControllable()
      Indicates whether or not the process variable can be set.
      Returns:
      true if the PV is controllable, false if it can only be read
      Since:
      Nov 6, 2009

    • clone

      protected Object clone() throws CloneNotSupportedException
      Returns a deep copy of this object, as deep as you can get anyway.

      NOTE: Added to implement the functionality of PvDescriptor in XAL.
      · Jonathan M. Freed
      · Jul 15, 2014

      Overrides:
      clone in class Object
      Throws:
      CloneNotSupportedException
      Since:
      Apr 19, 2012
      See Also:

    • toString

      public String toString()
      Write out the readback and set signal names for this PV descriptor.

      NOTE: Added to implement the functionality of PvDescriptor in XAL.
      · Jonathan M. Freed
      · Jul 15, 2014

      Overrides:
      toString in class Object
      Since:
      Apr 29, 2014
      See Also: