com.cosylab.epics.caj.cas.util
Class MemoryProcessVariable

java.lang.Object
  gov.aps.jca.cas.ProcessVariable
      com.cosylab.epics.caj.cas.util.MemoryProcessVariable

public class MemoryProcessVariable
extends gov.aps.jca.cas.ProcessVariable

Memory (what you write is what you get) process variable implementation. Implementation does not handle status, severity and alarms.

Field Summary

protected int	count PV count.
protected java.lang.String[]	enumLabels Array of labels for enum type PV.
protected java.lang.Number	lowerAlarmLimit Lower alarm limit.
protected java.lang.Number	lowerCtrlLimit Lower control limit.
protected java.lang.Number	lowerDispLimit Lower display value.
protected java.lang.Number	lowerWarningLimit Lower warning limit.
protected short	precision Precision.
protected gov.aps.jca.dbr.TimeStamp	timestamp Timestamp of set value.
protected gov.aps.jca.dbr.DBRType	type PV type.
protected java.lang.String	units Units (for value).
protected java.lang.Number	upperAlarmLimit Upper alarm limit.
protected java.lang.Number	upperCtrlLimit Upper control limit.
protected java.lang.Number	upperDispLimit Upper display limit.
protected java.lang.Number	upperWarningLimit Upper warning limit.
protected java.lang.Object	value PV value.

Fields inherited from class gov.aps.jca.cas.ProcessVariable

ackS, ackT, channelCount, eventCallback, interest, name

Constructor Summary

MemoryProcessVariable(java.lang.String name, gov.aps.jca.cas.ProcessVariableEventCallback eventCallback, gov.aps.jca.dbr.DBRType type, java.lang.Object initialValue)
Constructor of memory process variable.

Method Summary

void	fillInDBR(gov.aps.jca.dbr.DBR value) Set data (units, limits, ...) to DBR.
int	getDimensionSize(int dimension)
java.lang.String[]	getEnumLabels()
java.lang.Number	getLowerAlarmLimit() Get lower alarm limit.
java.lang.Number	getLowerCtrlLimit() Get lower control limit.
java.lang.Number	getLowerDispLimit() Get lower display limit.
java.lang.Number	getLowerWarningLimit() Get lower warning limit.
short	getPrecision() Get precision (number of digits after decimal point).
gov.aps.jca.dbr.DBRType	getType()
java.lang.String	getUnits() Get units (of value).
java.lang.Number	getUpperAlarmLimit() Get upper alarm limit.
java.lang.Number	getUpperCtrlLimit() Get upper control limit.
java.lang.Number	getUpperDispLimit() Get upper display limit.
java.lang.Number	getUpperWarningLimit() Get upper warning limit.
gov.aps.jca.CAStatus	read(gov.aps.jca.dbr.DBR value, gov.aps.jca.cas.ProcessVariableReadCallback asyncReadCallback) Read value.
void	setEnumLabels(java.lang.String[] labels) Set labens.
void	setLowerAlarmLimit(java.lang.Number lowerAlarmLimit) Set lower alarm limit.
void	setLowerCtrlLimit(java.lang.Number lowerCtrlLimit) Set lower control limit.
void	setLowerDispLimit(java.lang.Number lowerDispLimit) Set lower display limit.
void	setLowerWarningLimit(java.lang.Number lowerWarningLimit) Set lower warning limit.
void	setPrecision(short precision) Set precision.
void	setUnits(java.lang.String units) Set units (of value).
void	setUpperAlarmLimit(java.lang.Number upperAlarmLimit) Set upper alarm limit.
void	setUpperCtrlLimit(java.lang.Number upperCtrlLimit) Set upper control limit.
void	setUpperDispLimit(java.lang.Number upperDispLimit) Set upper display limit.
void	setUpperWarningLimit(java.lang.Number upperWarningLimit) Set upper warning limit.
gov.aps.jca.CAStatus	write(gov.aps.jca.dbr.DBR value, gov.aps.jca.cas.ProcessVariableWriteCallback asyncWriteCallback) Write value.

Methods inherited from class gov.aps.jca.cas.ProcessVariable

createChannel, destroy, getAckS, getEventCallback, getMaxDimension, getName, interestDelete, interestRegister, isAckT, printInfo, printInfo, registerChannel, setAckS, setAckT, setEventCallback, unregisterChannel

Methods inherited from class java.lang.Object

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

Field Detail

type

protected gov.aps.jca.dbr.DBRType type

PV type.

value

protected java.lang.Object value

PV value.

count

protected int count

PV count.

timestamp

protected gov.aps.jca.dbr.TimeStamp timestamp

Timestamp of set value.

units

protected java.lang.String units

Units (for value).

upperDispLimit

protected java.lang.Number upperDispLimit

Upper display limit.

lowerDispLimit

protected java.lang.Number lowerDispLimit

Lower display value.

upperAlarmLimit

protected java.lang.Number upperAlarmLimit

Upper alarm limit.

upperWarningLimit

protected java.lang.Number upperWarningLimit

Upper warning limit.

lowerWarningLimit

protected java.lang.Number lowerWarningLimit

Lower warning limit.

lowerAlarmLimit

protected java.lang.Number lowerAlarmLimit

Lower alarm limit.

upperCtrlLimit

protected java.lang.Number upperCtrlLimit

Upper control limit.

lowerCtrlLimit

protected java.lang.Number lowerCtrlLimit

Lower control limit.

precision

protected short precision

Precision. Used for floating decimal value to string conversion.

enumLabels

protected java.lang.String[] enumLabels

Array of labels for enum type PV.

Constructor Detail

MemoryProcessVariable

public MemoryProcessVariable(java.lang.String name,
                             gov.aps.jca.cas.ProcessVariableEventCallback eventCallback,
                             gov.aps.jca.dbr.DBRType type,
                             java.lang.Object initialValue)

Constructor of memory process variable.

Parameters:

name - name of the PV.

eventCallback - event callback, where to report value changes if interest is true.

type - type of the PV (of initial value).

initialValue - initial value, array is expected.

Method Detail

getType

public gov.aps.jca.dbr.DBRType getType()

Specified by:

getType in class gov.aps.jca.cas.ProcessVariable

See Also:

ProcessVariable.getType()

getDimensionSize

public int getDimensionSize(int dimension)

Overrides:

getDimensionSize in class gov.aps.jca.cas.ProcessVariable

See Also:

ProcessVariable.getDimensionSize(int)

getLowerAlarmLimit

public java.lang.Number getLowerAlarmLimit()

Get lower alarm limit.

Returns:

lower alarm limit, non-null.

setLowerAlarmLimit

public void setLowerAlarmLimit(java.lang.Number lowerAlarmLimit)

Set lower alarm limit.

Parameters:

lowerAlarmLimit - lower alarm limit, non-null.

getLowerCtrlLimit

public java.lang.Number getLowerCtrlLimit()

Get lower control limit.

Returns:

lower control limit, non-null.

setLowerCtrlLimit

public void setLowerCtrlLimit(java.lang.Number lowerCtrlLimit)

Set lower control limit.

Parameters:

lowerCtrlLimit - lower control limit, non-null.

getLowerDispLimit

public java.lang.Number getLowerDispLimit()

Get lower display limit.

Returns:

lower display limit, non-null.

setLowerDispLimit

public void setLowerDispLimit(java.lang.Number lowerDispLimit)

Set lower display limit.

Parameters:

lowerDispLimit - lower display limit, non-null.

getLowerWarningLimit

public java.lang.Number getLowerWarningLimit()

Get lower warning limit.

Returns:

lower warning limit, non-null.

setLowerWarningLimit

public void setLowerWarningLimit(java.lang.Number lowerWarningLimit)

Set lower warning limit.

Parameters:

lowerWarningLimit - lower warning limit, non-null.

getUnits

public java.lang.String getUnits()

Get units (of value).

Returns:

get units, non-null.

setUnits

public void setUnits(java.lang.String units)

Set units (of value).

Parameters:

units - get units, non-null.

getUpperAlarmLimit

public java.lang.Number getUpperAlarmLimit()

Get upper alarm limit.

Returns:

upper alarm limit, non-null.

setUpperAlarmLimit

public void setUpperAlarmLimit(java.lang.Number upperAlarmLimit)

Set upper alarm limit.

Parameters:

upperAlarmLimit - upper alarm limit, non-null.

getUpperCtrlLimit

public java.lang.Number getUpperCtrlLimit()

Get upper control limit.

Returns:

upper control limit, non-null.

setUpperCtrlLimit

public void setUpperCtrlLimit(java.lang.Number upperCtrlLimit)

Set upper control limit.

Parameters:

upperCtrlLimit - upper control limit, non-null.

getUpperDispLimit

public java.lang.Number getUpperDispLimit()

Get upper display limit.

Returns:

upper display limit, non-null.

setUpperDispLimit

public void setUpperDispLimit(java.lang.Number upperDispLimit)

Set upper display limit.

Parameters:

upperDispLimit - upper display limit, non-null.

getUpperWarningLimit

public java.lang.Number getUpperWarningLimit()

Get upper warning limit.

Returns:

upper warning limit, non-null.

setUpperWarningLimit

public void setUpperWarningLimit(java.lang.Number upperWarningLimit)

Set upper warning limit.

Parameters:

upperWarningLimit - upper warning limit, non-null.

getPrecision

public short getPrecision()

Get precision (number of digits after decimal point). Use -1 value as undefined precision.

Returns:

precision.

setPrecision

public void setPrecision(short precision)

Set precision.

Parameters:

precision - precision to set (number of digits after decimal point).

See Also:

getPrecision()

getEnumLabels

public java.lang.String[] getEnumLabels()

Overrides:

getEnumLabels in class gov.aps.jca.cas.ProcessVariable

See Also:

ProcessVariable.getEnumLabels()

setEnumLabels

public void setEnumLabels(java.lang.String[] labels)

Set labens.

Parameters:

labels - the labels to set

See Also:

ProcessVariable.getEnumLabels()

read

public gov.aps.jca.CAStatus read(gov.aps.jca.dbr.DBR value,
                                 gov.aps.jca.cas.ProcessVariableReadCallback asyncReadCallback)
                          throws gov.aps.jca.CAException

Read value. Fills-in DBR, sets timestamp (time when value was written) and copies value from local memory (array). No status and severity (alarms) are set - to be done in fillInDBR method (extending it).

Specified by:

read in class gov.aps.jca.cas.ProcessVariable

Throws:

gov.aps.jca.CAException

See Also:

ProcessVariable.read(gov.aps.jca.dbr.DBR, gov.aps.jca.cas.ProcessVariableReadCallback)

fillInDBR

public void fillInDBR(gov.aps.jca.dbr.DBR value)

Set data (units, limits, ...) to DBR. Data is obtained from this class accessors.

Parameters:

value - DBR to fill-in.

write

public gov.aps.jca.CAStatus write(gov.aps.jca.dbr.DBR value,
                                  gov.aps.jca.cas.ProcessVariableWriteCallback asyncWriteCallback)
                           throws gov.aps.jca.CAException

Write value. Copies given value to local memory (array). If event interest flag interest is set, an event is fired to eventCallback.

Specified by:

write in class gov.aps.jca.cas.ProcessVariable

Throws:

gov.aps.jca.CAException

See Also:

ProcessVariable.write(gov.aps.jca.dbr.DBR, gov.aps.jca.cas.ProcessVariableWriteCallback)