com.aquenos.epics.jackie.common.value

Interface ChannelAccessAlarmValue<ElementType>

Type Parameters:

ElementType - type of the actual value elements. For primitives, this is the boxed variant.

All Superinterfaces:

ChannelAccessGettableValue<ElementType>, ChannelAccessValue<ElementType>, java.lang.Cloneable, java.lang.Iterable<ElementType>

All Known Subinterfaces:

ChannelAccessAlarmChar, ChannelAccessAlarmDouble, ChannelAccessAlarmEnum, ChannelAccessAlarmFloat, ChannelAccessAlarmLong, ChannelAccessAlarmOnlyChar, ChannelAccessAlarmOnlyDouble, ChannelAccessAlarmOnlyEnum, ChannelAccessAlarmOnlyFloat, ChannelAccessAlarmOnlyLong, ChannelAccessAlarmOnlyShort, ChannelAccessAlarmOnlyString, ChannelAccessAlarmOnlyValue<ElementType>, ChannelAccessAlarmShort, ChannelAccessAlarmString, ChannelAccessControlsChar, ChannelAccessControlsDouble, ChannelAccessControlsFloat, ChannelAccessControlsLong, ChannelAccessControlsShort, ChannelAccessControlsValue<ElementType>, ChannelAccessFloatingPointControlsValue<ElementType>, ChannelAccessFloatingPointGraphicsValue<ElementType>, ChannelAccessGraphicsChar, ChannelAccessGraphicsDouble, ChannelAccessGraphicsEnum, ChannelAccessGraphicsFloat, ChannelAccessGraphicsLong, ChannelAccessGraphicsOnlyChar, ChannelAccessGraphicsOnlyDouble, ChannelAccessGraphicsOnlyFloat, ChannelAccessGraphicsOnlyLong, ChannelAccessGraphicsOnlyShort, ChannelAccessGraphicsOnlyValue<ElementType>, ChannelAccessGraphicsShort, ChannelAccessGraphicsValue<ElementType>, ChannelAccessNumericControlsValue<ElementType>, ChannelAccessNumericGraphicsValue<ElementType>, ChannelAccessTimeChar, ChannelAccessTimeDouble, ChannelAccessTimeEnum, ChannelAccessTimeFloat, ChannelAccessTimeLong, ChannelAccessTimeShort, ChannelAccessTimeString, ChannelAccessTimeValue<ElementType>

public interface ChannelAccessAlarmValue<ElementType>
extends ChannelAccessGettableValue<ElementType>

Channel Access value that represent a type with alarm information and possibly additional information (DBR_STS_*, DBR_TIME_*, DBR_GR_*, or DBR_CTRL_*).

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
ChannelAccessAlarmValue<ElementType>	asReadOnlyValue() Returns a read-only version of this value.
ChannelAccessAlarmValue<ElementType>	clone() Creates and returns a copy of this object.
ChannelAccessAlarmSeverity	getAlarmSeverity() Returns the alarm severity of the value.
ChannelAccessAlarmStatus	getAlarmStatus() Returns the alarm status of the value.
void	setAlarmSeverity(ChannelAccessAlarmSeverity alarmSeverity) Sets the alarm severity of the value.
void	setAlarmStatus(ChannelAccessAlarmStatus alarmStatus) Set the alarm status of the value.

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

getAlarmStatus

ChannelAccessAlarmStatus getAlarmStatus()

Returns the alarm status of the value. The alarm status provides information about the cause of an alarm (e.g. value too low or too high, invalid value, etc.).

Returns:

alarm status of the value (never null).

setAlarmStatus

void setAlarmStatus(ChannelAccessAlarmStatus alarmStatus)

Set the alarm status of the value. The alarm status provides information about the cause of an alarm (e.g. value too low or too high, invalid value, etc.).

Parameters:

alarmStatus - new alarm status of the value (never null).

Throws:

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

getAlarmSeverity

ChannelAccessAlarmSeverity getAlarmSeverity()

Returns the alarm severity of the value. The alarm severity signals how severe an alarm situation is.

Returns:

alarm severity of the value (never null).

setAlarmSeverity

void setAlarmSeverity(ChannelAccessAlarmSeverity alarmSeverity)

Sets the alarm severity of the value. The alarm severity signals how severe an alarm situation is.

Parameters:

alarmSeverity - new alarm severity of the value (never null).

Throws:

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

asReadOnlyValue

ChannelAccessAlarmValue<ElementType> 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 ChannelAccessGettableValue<ElementType>

Specified by:

asReadOnlyValue in interface ChannelAccessValue<ElementType>

Returns:

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

clone

ChannelAccessAlarmValue<ElementType> 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 ChannelAccessGettableValue<ElementType>

Specified by:

clone in interface ChannelAccessValue<ElementType>

Returns:

a clone of this instance.