com.aquenos.epics.jackie.common.value

Interface ChannelAccessGraphicsDouble

All Superinterfaces:

ChannelAccessAlarmDouble, ChannelAccessAlarmValue<java.lang.Double>, ChannelAccessDouble, ChannelAccessFloatingPointGraphicsValue<java.lang.Double>, ChannelAccessGettableValue<java.lang.Double>, ChannelAccessGraphicsValue<java.lang.Double>, ChannelAccessNumericGraphicsValue<java.lang.Double>, ChannelAccessValue<java.lang.Double>, java.lang.Cloneable, java.lang.Iterable<java.lang.Double>

All Known Subinterfaces:

ChannelAccessControlsDouble, ChannelAccessGraphicsOnlyDouble

public interface ChannelAccessGraphicsDouble
extends ChannelAccessAlarmDouble, ChannelAccessFloatingPointGraphicsValue<java.lang.Double>

Channel Access values that stores double-precision floating-point numbers and provides information about the alarm status, engineering units, display precision, and alarm and display 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
ChannelAccessGraphicsDouble	asReadOnlyValue() Returns a read-only version of this value.
ChannelAccessGraphicsDouble	clone() Creates and returns a copy of this object.
double	getLowerAlarmLimit() Returns the lower alarm limit.
double	getLowerDisplayLimit() Returns the lower display limit.
double	getLowerWarningLimit() Returns the lower warning limit.
double	getUpperAlarmLimit() Returns the upper alarm limit.
double	getUpperDisplayLimit() Returns the upper display limit.
double	getUpperWarningLimit() Returns the upper warning limit.
void	setLowerAlarmLimit(double lowerAlarmLimit) Sets the lower alarm limit.
void	setLowerDisplayLimit(double lowerDisplayLimit) Sets the lower display limit.
void	setLowerWarningLimit(double lowerWarningLimit) Sets the lower warning limit.
void	setUpperAlarmLimit(double upperAlarmLimit) Sets the upper alarm limit.
void	setUpperDisplayLimit(double upperDisplayLimit) Sets the upper display limit.
void	setUpperWarningLimit(double upperWarningLimit) Sets the upper warning limit.

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

getValue, setValue

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

getPrecision, setPrecision

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, toString

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getUpperDisplayLimit

double getUpperDisplayLimit()

Returns the upper display limit. The upper display limit is the limit that the value does typically not exceed and thus is suitable for choosing the layout of graphic displays (e.g. gauges). A value of zero typically indicates that the limit has not been configured and thus should not be used.

Returns:

upper display limit.

setUpperDisplayLimit

void setUpperDisplayLimit(double upperDisplayLimit)

Sets the upper display limit. The upper display limit is the limit that the value does typically not exceed and thus is suitable for choosing the layout of graphic displays (e.g. gauges). A value of zero typically indicates that the limit has not been configured and thus should not be used.

Parameters:

upperDisplayLimit - display limit.

Throws:

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

getLowerDisplayLimit

double getLowerDisplayLimit()

Returns the lower display limit. The lower display limit is the limit that the value does typically not undershoot and thus is suitable for choosing the layout of graphic displays (e.g. gauges). A value of zero typically indicates that the limit has not been configured and thus should not be used.

Returns:

lower display limit.

setLowerDisplayLimit

void setLowerDisplayLimit(double lowerDisplayLimit)

Sets the lower display limit. The lower display limit is the limit that the value does typically not undershoot and thus is suitable for choosing the layout of graphic displays (e.g. gauges). A value of zero typically indicates that the limit has not been configured and thus should not be used.

Parameters:

lowerDisplayLimit - lower display limit.

Throws:

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

getUpperAlarmLimit

double getUpperAlarmLimit()

Returns the upper alarm limit. The upper alarm limit is the limit that, when exceeded, typically raises a major alarm. A value of zero typically indicates that the limit has not been configured and thus should not be used.

Returns:

upper alarm limit.

setUpperAlarmLimit

void setUpperAlarmLimit(double upperAlarmLimit)

Sets the upper alarm limit. The upper alarm limit is the limit that, when exceeded, typically raises a major alarm. A value of zero typically indicates that the limit has not been configured and thus should not be used.

Parameters:

upperAlarmLimit - upper alarm limit.

Throws:

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

getUpperWarningLimit

double getUpperWarningLimit()

Returns the upper warning limit. The upper warning limit is the limit that, when exceeded, typically raises a minor alarm. A value of zero typically indicates that the limit has not been configured and thus should not be used.

Returns:

upper warning limit.

setUpperWarningLimit

void setUpperWarningLimit(double upperWarningLimit)

Sets the upper warning limit. The upper warning limit is the limit that, when exceeded, typically raises a minor alarm. A value of zero typically indicates that the limit has not been configured and thus should not be used.

Parameters:

upperWarningLimit - upper warning limit.

Throws:

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

getLowerWarningLimit

double getLowerWarningLimit()

Returns the lower warning limit. The lower warning limit is the limit that, when undershot, typically raises a minor alarm. A value of zero typically indicates that the limit has not been configured and thus should not be used.

Returns:

lower warning limit.

setLowerWarningLimit

void setLowerWarningLimit(double lowerWarningLimit)

Sets the lower warning limit. The lower warning limit is the limit that, when undershot, typically raises a minor alarm. A value of zero typically indicates that the limit has not been configured and thus should not be used.

Parameters:

lowerWarningLimit - lower warning limit.

Throws:

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

getLowerAlarmLimit

double getLowerAlarmLimit()

Returns the lower alarm limit. The lower alarm limit is the limit that, when undershot, typically raises a major alarm. A value of zero typically indicates that the limit has not been configured and thus should not be used.

Returns:

lower alarm limit.

setLowerAlarmLimit

void setLowerAlarmLimit(double lowerAlarmLimit)

Sets the lower alarm limit. The lower alarm limit is the limit that, when undershot, typically raises a major alarm. A value of zero typically indicates that the limit has not been configured and thus should not be used.

Parameters:

lowerAlarmLimit - lower alarm limit.

Throws:

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

asReadOnlyValue

ChannelAccessGraphicsDouble 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 ChannelAccessAlarmDouble

Specified by:

asReadOnlyValue in interface ChannelAccessAlarmValue<java.lang.Double>

Specified by:

asReadOnlyValue in interface ChannelAccessDouble

Specified by:

asReadOnlyValue in interface ChannelAccessFloatingPointGraphicsValue<java.lang.Double>

Specified by:

asReadOnlyValue in interface ChannelAccessGettableValue<java.lang.Double>

Specified by:

asReadOnlyValue in interface ChannelAccessGraphicsValue<java.lang.Double>

Specified by:

asReadOnlyValue in interface ChannelAccessNumericGraphicsValue<java.lang.Double>

Specified by:

asReadOnlyValue in interface ChannelAccessValue<java.lang.Double>

Returns:

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

clone

ChannelAccessGraphicsDouble 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 ChannelAccessAlarmDouble

Specified by:

clone in interface ChannelAccessAlarmValue<java.lang.Double>

Specified by:

clone in interface ChannelAccessDouble

Specified by:

clone in interface ChannelAccessFloatingPointGraphicsValue<java.lang.Double>

Specified by:

clone in interface ChannelAccessGettableValue<java.lang.Double>

Specified by:

clone in interface ChannelAccessGraphicsValue<java.lang.Double>

Specified by:

clone in interface ChannelAccessNumericGraphicsValue<java.lang.Double>

Specified by:

clone in interface ChannelAccessValue<java.lang.Double>

Returns:

a clone of this instance.