com.aquenos.epics.jackie.common.value

Interface ChannelAccessControlsChar

All Superinterfaces:

ChannelAccessAlarmChar, ChannelAccessAlarmValue<java.lang.Byte>, ChannelAccessChar, ChannelAccessControlsValue<java.lang.Byte>, ChannelAccessGettableValue<java.lang.Byte>, ChannelAccessGraphicsChar, ChannelAccessGraphicsValue<java.lang.Byte>, ChannelAccessNumericControlsValue<java.lang.Byte>, ChannelAccessNumericGraphicsValue<java.lang.Byte>, ChannelAccessValue<java.lang.Byte>, java.lang.Cloneable, java.lang.Iterable<java.lang.Byte>

public interface ChannelAccessControlsChar
extends ChannelAccessGraphicsChar, ChannelAccessNumericControlsValue<java.lang.Byte>

Channel Access values that represents the DBR_CTRL_CHAR type. This type stores single-byte 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_CHAR in the Channel Access protocol. However, it is represented by bytes.

Due to technical limitations of the Java platform, the char values are represented by signed integers. The Channel Access protocol, however, defines them as unsigned. Therefore, positive numbers in the Channel Access protocol might appear as negative numbers in this library and vice-versa.

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

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

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

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

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

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

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

ChannelAccessControlsChar 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 ChannelAccessAlarmChar

Specified by:

asReadOnlyValue in interface ChannelAccessAlarmValue<java.lang.Byte>

Specified by:

asReadOnlyValue in interface ChannelAccessChar

Specified by:

asReadOnlyValue in interface ChannelAccessControlsValue<java.lang.Byte>

Specified by:

asReadOnlyValue in interface ChannelAccessGettableValue<java.lang.Byte>

Specified by:

asReadOnlyValue in interface ChannelAccessGraphicsChar

Specified by:

asReadOnlyValue in interface ChannelAccessGraphicsValue<java.lang.Byte>

Specified by:

asReadOnlyValue in interface ChannelAccessNumericControlsValue<java.lang.Byte>

Specified by:

asReadOnlyValue in interface ChannelAccessNumericGraphicsValue<java.lang.Byte>

Specified by:

asReadOnlyValue in interface ChannelAccessValue<java.lang.Byte>

Returns:

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

clone

ChannelAccessControlsChar 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 ChannelAccessAlarmChar

Specified by:

clone in interface ChannelAccessAlarmValue<java.lang.Byte>

Specified by:

clone in interface ChannelAccessChar

Specified by:

clone in interface ChannelAccessControlsValue<java.lang.Byte>

Specified by:

clone in interface ChannelAccessGettableValue<java.lang.Byte>

Specified by:

clone in interface ChannelAccessGraphicsChar

Specified by:

clone in interface ChannelAccessGraphicsValue<java.lang.Byte>

Specified by:

clone in interface ChannelAccessNumericControlsValue<java.lang.Byte>

Specified by:

clone in interface ChannelAccessNumericGraphicsValue<java.lang.Byte>

Specified by:

clone in interface ChannelAccessValue<java.lang.Byte>

Returns:

a clone of this instance.