public interface ChannelAccessGraphicsShort extends ChannelAccessAlarmShort, ChannelAccessNumericGraphicsValue<java.lang.Short>
Channel Access values that stores short integer numbers and provides information about the alarm status, engineering units, 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.
Modifier and Type | Method and Description |
---|---|
ChannelAccessGraphicsShort |
asReadOnlyValue()
Returns a read-only version of this value.
|
ChannelAccessGraphicsShort |
clone()
Creates and returns a copy of this object.
|
short |
getLowerAlarmLimit()
Returns the lower alarm limit.
|
short |
getLowerDisplayLimit()
Returns the lower display limit.
|
short |
getLowerWarningLimit()
Returns the lower warning limit.
|
short |
getUpperAlarmLimit()
Returns the upper alarm limit.
|
short |
getUpperDisplayLimit()
Returns the upper display limit.
|
short |
getUpperWarningLimit()
Returns the upper warning limit.
|
void |
setLowerAlarmLimit(short lowerAlarmLimit)
Sets the lower alarm limit.
|
void |
setLowerDisplayLimit(short lowerDisplayLimit)
Sets the lower display limit.
|
void |
setLowerWarningLimit(short lowerWarningLimit)
Sets the lower warning limit.
|
void |
setUpperAlarmLimit(short upperAlarmLimit)
Sets the upper alarm limit.
|
void |
setUpperDisplayLimit(short upperDisplayLimit)
Sets the upper display limit.
|
void |
setUpperWarningLimit(short upperWarningLimit)
Sets the upper warning limit.
|
getValue, setValue
getGenericLowerAlarmLimit, getGenericLowerDisplayLimit, getGenericLowerWarningLimit, getGenericUpperAlarmLimit, getGenericUpperDisplayLimit, getGenericUpperWarningLimit, getRawUnits, getUnits, setRawUnits, setUnits
getCharset
getAlarmSeverity, getAlarmStatus, setAlarmSeverity, setAlarmStatus
equals, getGenericValueElement, getType, getValueSize, hashCode, isReadOnly, iterator, toString
short getUpperDisplayLimit()
void setUpperDisplayLimit(short upperDisplayLimit)
upperDisplayLimit
- display limit.java.lang.UnsupportedOperationException
- if this value is read-only (ChannelAccessValue.isReadOnly()
returns
true
).short getLowerDisplayLimit()
void setLowerDisplayLimit(short lowerDisplayLimit)
lowerDisplayLimit
- lower display limit.java.lang.UnsupportedOperationException
- if this value is read-only (ChannelAccessValue.isReadOnly()
returns
true
).short getUpperAlarmLimit()
void setUpperAlarmLimit(short upperAlarmLimit)
upperAlarmLimit
- upper alarm limit.java.lang.UnsupportedOperationException
- if this value is read-only (ChannelAccessValue.isReadOnly()
returns
true
).short getUpperWarningLimit()
void setUpperWarningLimit(short upperWarningLimit)
upperWarningLimit
- upper warning limit.java.lang.UnsupportedOperationException
- if this value is read-only (ChannelAccessValue.isReadOnly()
returns
true
).short getLowerWarningLimit()
void setLowerWarningLimit(short lowerWarningLimit)
lowerWarningLimit
- lower warning limit.java.lang.UnsupportedOperationException
- if this value is read-only (ChannelAccessValue.isReadOnly()
returns
true
).short getLowerAlarmLimit()
void setLowerAlarmLimit(short lowerAlarmLimit)
lowerAlarmLimit
- lower alarm limit.java.lang.UnsupportedOperationException
- if this value is read-only (ChannelAccessValue.isReadOnly()
returns
true
).ChannelAccessGraphicsShort 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.
asReadOnlyValue
in interface ChannelAccessAlarmShort
asReadOnlyValue
in interface ChannelAccessAlarmValue<java.lang.Short>
asReadOnlyValue
in interface ChannelAccessGettableValue<java.lang.Short>
asReadOnlyValue
in interface ChannelAccessGraphicsValue<java.lang.Short>
asReadOnlyValue
in interface ChannelAccessNumericGraphicsValue<java.lang.Short>
asReadOnlyValue
in interface ChannelAccessShort
asReadOnlyValue
in interface ChannelAccessValue<java.lang.Short>
null
).ChannelAccessGraphicsShort 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.
clone
in interface ChannelAccessAlarmShort
clone
in interface ChannelAccessAlarmValue<java.lang.Short>
clone
in interface ChannelAccessGettableValue<java.lang.Short>
clone
in interface ChannelAccessGraphicsValue<java.lang.Short>
clone
in interface ChannelAccessNumericGraphicsValue<java.lang.Short>
clone
in interface ChannelAccessShort
clone
in interface ChannelAccessValue<java.lang.Short>
Copyright © 2014–2018 aquenos GmbH. All rights reserved.