xal.smf.scada

Class XalPvDescriptor

java.lang.Object

xal.smf.scada.XalPvDescriptor

Direct Known Subclasses:

ScadaFieldDescriptor

public class XalPvDescriptor
extends java.lang.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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
XalPvDescriptor(java.lang.Class<?> clsType, java.lang.String strHandleRb) Create a new XalPvDescriptor object with read back values only.
XalPvDescriptor(java.lang.Class<?> clsType, java.lang.String strHandleRb, java.lang.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 and Description
protected java.lang.Object	clone() Returns a deep copy of this object, as deep as you can get anyway.
java.lang.Class<?>	getPvType() Return the data type of Process Variable associate with this handle.
java.lang.String	getRbHandle() Return the channel handle for the PV corresponding to the current enumeration constant.
java.lang.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.
java.lang.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 Detail

XalPvDescriptor

public XalPvDescriptor(java.lang.Class<?> clsType,
                       java.lang.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(java.lang.Class<?> clsType,
                       java.lang.String strHandleRb,
                       java.lang.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. Creats 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 Detail

getRbHandle

public java.lang.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 java.lang.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 java.lang.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 java.lang.Object clone()
                          throws java.lang.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 java.lang.Object

Throws:

java.lang.CloneNotSupportedException

Since:

Apr 19, 2012

See Also:

Object.clone()

toString

public java.lang.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 java.lang.Object

Since:

Apr 29, 2014

See Also:

Object.toString()