com.aquenos.epics.jackie.common.value

Interface ChannelAccessControlsLong

All Superinterfaces:

ChannelAccessAlarmLong, ChannelAccessAlarmValue<java.lang.Integer>, ChannelAccessControlsValue<java.lang.Integer>, ChannelAccessGettableValue<java.lang.Integer>, ChannelAccessGraphicsLong, ChannelAccessGraphicsValue<java.lang.Integer>, ChannelAccessLong, ChannelAccessNumericControlsValue<java.lang.Integer>, ChannelAccessNumericGraphicsValue<java.lang.Integer>, ChannelAccessValue<java.lang.Integer>, java.lang.Cloneable, java.lang.Iterable<java.lang.Integer>

public interface ChannelAccessControlsLong
extends ChannelAccessGraphicsLong, ChannelAccessNumericControlsValue<java.lang.Integer>

Channel Access values that represents the DBR_CTRL_LONG type. This type stores integer numbers and provides information about the alarm status, engineering units, and alarm, display, and control limits. For historical reasons, this type is called DBR_CTRL_LONG in the Channel Access protocol. However, it is represented by ints.

This interface should not be implemented by user-defined classes. Code that wants to create an instance implementing this interface should use the methods provided by ChannelAccessValueFactory instead.

Author:

Sebatian Marsching

Method Summary

Modifier and Type	Method and Description
ChannelAccessControlsLong	asReadOnlyValue() Returns a read-only version of this value.
ChannelAccessControlsLong	clone() Creates and returns a copy of this object.
int	getLowerControlLimit() Returns the lower control limit.
int	getUpperControlLimit() Returns the upper control limit.
void	setLowerControlLimit(int lowerControlLimit) Sets the lower control limit.
void	setUpperControlLimit(int upperControlLimit) Sets the upper control limit.

Methods inherited from interface com.aquenos.epics.jackie.common.value.ChannelAccessGraphicsLong

getLowerAlarmLimit, getLowerDisplayLimit, getLowerWarningLimit, getUpperAlarmLimit, getUpperDisplayLimit, getUpperWarningLimit, setLowerAlarmLimit, setLowerDisplayLimit, setLowerWarningLimit, setUpperAlarmLimit, setUpperDisplayLimit, setUpperWarningLimit

Methods inherited from interface com.aquenos.epics.jackie.common.value.ChannelAccessLong

getValue, setValue

Methods inherited from interface com.aquenos.epics.jackie.common.value.ChannelAccessNumericControlsValue

getGenericLowerControlLimit, getGenericUpperControlLimit

Methods inherited from interface com.aquenos.epics.jackie.common.value.ChannelAccessNumericGraphicsValue

getGenericLowerAlarmLimit, getGenericLowerDisplayLimit, getGenericLowerWarningLimit, getGenericUpperAlarmLimit, getGenericUpperDisplayLimit, getGenericUpperWarningLimit, getRawUnits, getUnits, setRawUnits, setUnits

Methods inherited from interface com.aquenos.epics.jackie.common.value.ChannelAccessGraphicsValue

getCharset

Methods inherited from interface com.aquenos.epics.jackie.common.value.ChannelAccessAlarmValue

getAlarmSeverity, getAlarmStatus, setAlarmSeverity, setAlarmStatus

Methods inherited from interface com.aquenos.epics.jackie.common.value.ChannelAccessValue

equals, getGenericValueElement, getType, getValueSize, hashCode, isReadOnly, iterator, toString

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getUpperControlLimit

int getUpperControlLimit()

Returns the upper control limit. The upper control limit is the upper limit that the server enforces on values. Typically, this means that the process variable cannot be set to a value that is greater than this limit. A value of zero typically indicates that the limit has not been configured and thus should not be used.

Returns:

upper control limit.

setUpperControlLimit

void setUpperControlLimit(int upperControlLimit)

Sets the upper control limit. The upper control limit is the upper limit that the server enforces on values. Typically, this means that the process variable cannot be set to a value that is greater than this limit. A value of zero typically indicates that the limit has not been configured and thus should not be used.

Parameters:

upperControlLimit - upper control limit.

Throws:

java.lang.UnsupportedOperationException - if this value is read-only (ChannelAccessValue.isReadOnly() returns true).

getLowerControlLimit

int getLowerControlLimit()

Returns the lower control limit. The lower control limit is the lower limit that the server enforces on values. Typically, this means that the process variable cannot be set to a value that is less than this limit. A value of zero typically indicates that the limit has not been configured and thus should not be used.

Returns:

lower control limit.

setLowerControlLimit

void setLowerControlLimit(int lowerControlLimit)

Sets the lower control limit. The lower control limit is the lower limit that the server enforces on values. Typically, this means that the process variable cannot be set to a value that is less than this limit. A value of zero typically indicates that the limit has not been configured and thus should not be used.

Parameters:

lowerControlLimit - lower control limit.

Throws:

java.lang.UnsupportedOperationException - if this value is read-only (ChannelAccessValue.isReadOnly() returns true).

asReadOnlyValue

ChannelAccessControlsLong asReadOnlyValue()

Returns a read-only version of this value. If the value is read-only, this value is returned. Otherwise, a wrapped version of this value, that does not allow modifications is returned.

Please note that the read-only value is not a copy of this value, but just a wrapper around it. This means, that modifications of the wrapped value will result in modifications of the read-only value. Therefore it is bad practice to modify a value that has been used as the base for a read-only value, because code that still has a reference to the read-only value might not expect this change and thus fail unexpectedly.

Specified by:

asReadOnlyValue in interface ChannelAccessAlarmLong

Specified by:

asReadOnlyValue in interface ChannelAccessAlarmValue<java.lang.Integer>

Specified by:

asReadOnlyValue in interface ChannelAccessControlsValue<java.lang.Integer>

Specified by:

asReadOnlyValue in interface ChannelAccessGettableValue<java.lang.Integer>

Specified by:

asReadOnlyValue in interface ChannelAccessGraphicsLong

Specified by:

asReadOnlyValue in interface ChannelAccessGraphicsValue<java.lang.Integer>

Specified by:

asReadOnlyValue in interface ChannelAccessLong

Specified by:

asReadOnlyValue in interface ChannelAccessNumericControlsValue<java.lang.Integer>

Specified by:

asReadOnlyValue in interface ChannelAccessNumericGraphicsValue<java.lang.Integer>

Specified by:

asReadOnlyValue in interface ChannelAccessValue<java.lang.Integer>

Returns:

read-only version of this value (never null).

clone

ChannelAccessControlsLong clone()

Creates and returns a copy of this object. The object returned is completely independent from this object. This means that modifications to this object will not affect the returned object and vice-versa.

The object returned is guaranteed to be completely identical to this object, including its type. This means that x.clone().equals(x) and x.clone().getClass() == x.getClass() are always true.

The returned value is guaranteed to allow write access, even if this value is read-only. This means that cloning a read-only value is a good way to get a writable copy.

Specified by:

clone in interface ChannelAccessAlarmLong

Specified by:

clone in interface ChannelAccessAlarmValue<java.lang.Integer>

Specified by:

clone in interface ChannelAccessControlsValue<java.lang.Integer>

Specified by:

clone in interface ChannelAccessGettableValue<java.lang.Integer>

Specified by:

clone in interface ChannelAccessGraphicsLong

Specified by:

clone in interface ChannelAccessGraphicsValue<java.lang.Integer>

Specified by:

clone in interface ChannelAccessLong

Specified by:

clone in interface ChannelAccessNumericControlsValue<java.lang.Integer>

Specified by:

clone in interface ChannelAccessNumericGraphicsValue<java.lang.Integer>

Specified by:

clone in interface ChannelAccessValue<java.lang.Integer>

Returns:

a clone of this instance.