com.aquenos.epics.jackie.common.value

Interface ChannelAccessTimeValue<ElementType>

Type Parameters:

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

All Superinterfaces:

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

All Known Subinterfaces:

ChannelAccessTimeChar, ChannelAccessTimeDouble, ChannelAccessTimeEnum, ChannelAccessTimeFloat, ChannelAccessTimeLong, ChannelAccessTimeShort, ChannelAccessTimeString

public interface ChannelAccessTimeValue<ElementType>
extends ChannelAccessAlarmValue<ElementType>

Channel Access value that represents a type with alarm information and a time-stamp (DBR_TIME_*).

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
ChannelAccessTimeValue<ElementType>	asReadOnlyValue() Returns a read-only version of this value.
ChannelAccessTimeValue<ElementType>	clone() Creates and returns a copy of this object.
int	getTimeNanoseconds() Returns the nanoseconds part of the value's time-stamp.
int	getTimeSeconds() Returns the seconds part of the value's time-stamp.
ChannelAccessTimeStamp	getTimeStamp() Returns the time-stamp associated with this value.
void	setTimeNanoseconds(int timeStampNanoseconds) Sets the nanoseconds part of the value's time-stamp.
void	setTimeSeconds(int timeStampSeconds) Sets the seconds part of the value's time-stamp.
void	setTimeStamp(ChannelAccessTimeStamp timeStamp) Sets the time-stamp associated with this value.

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

getTimeStamp

ChannelAccessTimeStamp getTimeStamp()

Returns the time-stamp associated with this value. Typically, this time-stamp indicates the time when the value has been updated last.

Please note that calling this method will allocate a new object each time. If performance is critical, the getTimeSeconds() and getTimeNanoseconds() methods should be preferred instead.

Returns:

value time-stamp (never null).

getTimeSeconds

int getTimeSeconds()

Returns the seconds part of the value's time-stamp. This is the number of seconds that have passed since January 1st, 1990, 00:00:00 UTC.

Returns:

seconds part of the value's time-stamp.

See Also:

getTimeNanoseconds(), getTimeStamp()

getTimeNanoseconds

int getTimeNanoseconds()

Returns the nanoseconds part of the value's time-stamp. This is the number of nanoseconds that should be added to the number of seconds returned by getTimeSeconds() to get a more precise time-stamp.

Returns:

nanoseconds part of the value's time-stamp.

See Also:

getTimeSeconds(), getTimeStamp()

setTimeStamp

void setTimeStamp(ChannelAccessTimeStamp timeStamp)

Sets the time-stamp associated with this value. Typically, this time-stamp indicates the time when the value has been updated last.

Parameters:

timeStamp - new time-stamp (never null).

Throws:

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

setTimeSeconds

void setTimeSeconds(int timeStampSeconds)

Sets the seconds part of the value's time-stamp. This is the number of seconds that have passed since January 1st, 1990, 00:00:00 UTC.

Parameters:

timeStampSeconds - new seconds part of the value's time-stamp.

Throws:

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

See Also:

setTimeNanoseconds(int), setTimeStamp(ChannelAccessTimeStamp)

setTimeNanoseconds

void setTimeNanoseconds(int timeStampNanoseconds)

Sets the nanoseconds part of the value's time-stamp. This is the number of nanoseconds that should be added to the number of seconds returned by getTimeSeconds() to get a more precise time-stamp.

Parameters:

timeStampNanoseconds - new nanoseconds part of the value's time-stamp. Must be a number between 0 and 999999999.

Throws:

java.lang.IllegalArgumentException - if number is less than zero or greater than 999999999.

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

See Also:

setTimeSeconds(int), setTimeStamp(ChannelAccessTimeStamp)

asReadOnlyValue

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

Specified by:

asReadOnlyValue in interface ChannelAccessGettableValue<ElementType>

Specified by:

asReadOnlyValue in interface ChannelAccessValue<ElementType>

Returns:

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

clone

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

Specified by:

clone in interface ChannelAccessGettableValue<ElementType>

Specified by:

clone in interface ChannelAccessValue<ElementType>

Returns:

a clone of this instance.