com.aquenos.epics.jackie.common.value

Interface ChannelAccessControlsShort

All Superinterfaces:

ChannelAccessAlarmShort, ChannelAccessAlarmValue<java.lang.Short>, ChannelAccessControlsValue<java.lang.Short>, ChannelAccessGettableValue<java.lang.Short>, ChannelAccessGraphicsShort, ChannelAccessGraphicsValue<java.lang.Short>, ChannelAccessNumericControlsValue<java.lang.Short>, ChannelAccessNumericGraphicsValue<java.lang.Short>, ChannelAccessShort, ChannelAccessValue<java.lang.Short>, java.lang.Cloneable, java.lang.Iterable<java.lang.Short>

public interface ChannelAccessControlsShort
extends ChannelAccessGraphicsShort, ChannelAccessNumericControlsValue<java.lang.Short>

Channel Access values that represents the DBR_CTRL_SHORT type. This type stores short integer numbers and provides information about the alarm status, engineering units, and alarm, display, and control limits.

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
ChannelAccessControlsShort	asReadOnlyValue() Returns a read-only version of this value.
ChannelAccessControlsShort	clone() Creates and returns a copy of this object.
short	getLowerControlLimit() Returns the lower control limit.
short	getUpperControlLimit() Returns the upper control limit.
void	setLowerControlLimit(short lowerControlLimit) Sets the lower control limit.
void	setUpperControlLimit(short upperControlLimit) Sets the upper control limit.

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

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

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

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

short 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(short 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

short 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(short 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

ChannelAccessControlsShort 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 ChannelAccessAlarmShort

Specified by:

asReadOnlyValue in interface ChannelAccessAlarmValue<java.lang.Short>

Specified by:

asReadOnlyValue in interface ChannelAccessControlsValue<java.lang.Short>

Specified by:

asReadOnlyValue in interface ChannelAccessGettableValue<java.lang.Short>

Specified by:

asReadOnlyValue in interface ChannelAccessGraphicsShort

Specified by:

asReadOnlyValue in interface ChannelAccessGraphicsValue<java.lang.Short>

Specified by:

asReadOnlyValue in interface ChannelAccessNumericControlsValue<java.lang.Short>

Specified by:

asReadOnlyValue in interface ChannelAccessNumericGraphicsValue<java.lang.Short>

Specified by:

asReadOnlyValue in interface ChannelAccessShort

Specified by:

asReadOnlyValue in interface ChannelAccessValue<java.lang.Short>

Returns:

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

clone

ChannelAccessControlsShort 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 ChannelAccessAlarmShort

Specified by:

clone in interface ChannelAccessAlarmValue<java.lang.Short>

Specified by:

clone in interface ChannelAccessControlsValue<java.lang.Short>

Specified by:

clone in interface ChannelAccessGettableValue<java.lang.Short>

Specified by:

clone in interface ChannelAccessGraphicsShort

Specified by:

clone in interface ChannelAccessGraphicsValue<java.lang.Short>

Specified by:

clone in interface ChannelAccessNumericControlsValue<java.lang.Short>

Specified by:

clone in interface ChannelAccessNumericGraphicsValue<java.lang.Short>

Specified by:

clone in interface ChannelAccessShort

Specified by:

clone in interface ChannelAccessValue<java.lang.Short>

Returns:

a clone of this instance.