org.epics.pvmanager.data
Class IVDoubleArray

java.lang.Object
  extended by org.epics.pvmanager.data.IVDoubleArray
All Implemented Interfaces:
Alarm, Array<java.lang.Double>, Display, Time, VDoubleArray

public class IVDoubleArray
extends java.lang.Object
implements VDoubleArray

Author:
carcassi

Constructor Summary
IVDoubleArray(double[] array, java.util.List<java.lang.Integer> sizes, AlarmSeverity alarmSeverity, AlarmStatus alarmStatus, TimeStamp timeStamp, java.lang.Integer timeUserTag, boolean timeValid, java.lang.Double lowerDisplayLimit, java.lang.Double lowerCtrlLimit, java.lang.Double lowerAlarmLimit, java.lang.Double lowerWarningLimit, java.lang.String units, java.text.NumberFormat format, java.lang.Double upperWarningLimit, java.lang.Double upperAlarmLimit, java.lang.Double upperCtrlLimit, java.lang.Double upperDisplayLimit)
           
 
Method Summary
 AlarmSeverity getAlarmSeverity()
          Returns the alarm severity, which describes the quality of the value returned.
 AlarmStatus getAlarmStatus()
          Returns the alarm status of the highest currently active alarm.
 double[] getArray()
           
 java.text.NumberFormat getFormat()
          Returns a NumberFormat that creates a String with just the value (no units).
 java.lang.Double getLowerAlarmLimit()
          Lowest value before the alarm region.
 java.lang.Double getLowerCtrlLimit()
          Lowest possible value (included).
 java.lang.Double getLowerDisplayLimit()
          Lowest possible value to be displayed.
 java.lang.Double getLowerWarningLimit()
          Lowest value before the warning region.
 java.util.List<java.lang.Integer> getSizes()
           
 TimeStamp getTimeStamp()
          The timestamp of the value, typically indicating when it was generated.
 java.lang.Integer getTimeUserTag()
          Returns a user defined tag, that can be used to store extra time information, such as beam shot.
 java.lang.String getUnits()
          String representation of the units using for all values.
 java.lang.Double getUpperAlarmLimit()
          Highest value before the alarm region.
 java.lang.Double getUpperCtrlLimit()
          Highest possible value (included).
 java.lang.Double getUpperDisplayLimit()
          Highest possible value to be displayed.
 java.lang.Double getUpperWarningLimit()
          Highest value before the warning region.
 boolean isTimeValid()
          Returns a data source specific flag to indicate whether the time information should be trusted.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.epics.pvmanager.data.Alarm
getAlarmSeverity, getAlarmStatus
 
Methods inherited from interface org.epics.pvmanager.data.Time
getTimeStamp, getTimeUserTag, isTimeValid
 
Methods inherited from interface org.epics.pvmanager.data.Display
getFormat, getLowerAlarmLimit, getLowerCtrlLimit, getLowerDisplayLimit, getLowerWarningLimit, getUnits, getUpperAlarmLimit, getUpperCtrlLimit, getUpperDisplayLimit, getUpperWarningLimit
 

Constructor Detail

IVDoubleArray

public IVDoubleArray(double[] array,
                     java.util.List<java.lang.Integer> sizes,
                     AlarmSeverity alarmSeverity,
                     AlarmStatus alarmStatus,
                     TimeStamp timeStamp,
                     java.lang.Integer timeUserTag,
                     boolean timeValid,
                     java.lang.Double lowerDisplayLimit,
                     java.lang.Double lowerCtrlLimit,
                     java.lang.Double lowerAlarmLimit,
                     java.lang.Double lowerWarningLimit,
                     java.lang.String units,
                     java.text.NumberFormat format,
                     java.lang.Double upperWarningLimit,
                     java.lang.Double upperAlarmLimit,
                     java.lang.Double upperCtrlLimit,
                     java.lang.Double upperDisplayLimit)
Method Detail

getArray

public double[] getArray()
Specified by:
getArray in interface Array<java.lang.Double>
Specified by:
getArray in interface VDoubleArray

getSizes

public java.util.List<java.lang.Integer> getSizes()
Specified by:
getSizes in interface Array<java.lang.Double>

getLowerDisplayLimit

public java.lang.Double getLowerDisplayLimit()
Description copied from interface: Display
Lowest possible value to be displayed. Never null.

Specified by:
getLowerDisplayLimit in interface Display
Returns:
lower display limit

getLowerCtrlLimit

public java.lang.Double getLowerCtrlLimit()
Description copied from interface: Display
Lowest possible value (included). Never null.

Specified by:
getLowerCtrlLimit in interface Display
Returns:
lower limit

getLowerAlarmLimit

public java.lang.Double getLowerAlarmLimit()
Description copied from interface: Display
Lowest value before the alarm region. Never null.

Specified by:
getLowerAlarmLimit in interface Display
Returns:
lower alarm limit

getLowerWarningLimit

public java.lang.Double getLowerWarningLimit()
Description copied from interface: Display
Lowest value before the warning region. Never null.

Specified by:
getLowerWarningLimit in interface Display
Returns:
lower warning limit

getUnits

public java.lang.String getUnits()
Description copied from interface: Display
String representation of the units using for all values. Never null. If not yet connected, returns the empty String.

Specified by:
getUnits in interface Display
Returns:
units

getFormat

public java.text.NumberFormat getFormat()
Description copied from interface: Display
Returns a NumberFormat that creates a String with just the value (no units). Format is locale independent and should be used for all values (values and lower/upper limits). Never null. If not yet connected, the format always returns an empty String.

Specified by:
getFormat in interface Display
Returns:
the default format for all values

getUpperWarningLimit

public java.lang.Double getUpperWarningLimit()
Description copied from interface: Display
Highest value before the warning region. Never null.

Specified by:
getUpperWarningLimit in interface Display
Returns:
upper warning limit

getUpperAlarmLimit

public java.lang.Double getUpperAlarmLimit()
Description copied from interface: Display
Highest value before the alarm region. Never null.

Specified by:
getUpperAlarmLimit in interface Display
Returns:
upper alarm limit

getUpperCtrlLimit

public java.lang.Double getUpperCtrlLimit()
Description copied from interface: Display
Highest possible value (included). Never null.

Specified by:
getUpperCtrlLimit in interface Display
Returns:
upper limit

getUpperDisplayLimit

public java.lang.Double getUpperDisplayLimit()
Description copied from interface: Display
Highest possible value to be displayed. Never null.

Specified by:
getUpperDisplayLimit in interface Display
Returns:
upper display limit

getAlarmSeverity

public AlarmSeverity getAlarmSeverity()
Description copied from interface: Alarm
Returns the alarm severity, which describes the quality of the value returned. Never null.

Specified by:
getAlarmSeverity in interface Alarm
Returns:
the alarm severity

getAlarmStatus

public AlarmStatus getAlarmStatus()
Description copied from interface: Alarm
Returns the alarm status of the highest currently active alarm. Never null.

Specified by:
getAlarmStatus in interface Alarm
Returns:
the alarm status

getTimeStamp

public TimeStamp getTimeStamp()
Description copied from interface: Time
The timestamp of the value, typically indicating when it was generated. Never null. If never connected, it returns the time when it was last determined that no connection was made.

Specified by:
getTimeStamp in interface Time
Returns:
the timestamp

getTimeUserTag

public java.lang.Integer getTimeUserTag()
Description copied from interface: Time
Returns a user defined tag, that can be used to store extra time information, such as beam shot.

Specified by:
getTimeUserTag in interface Time
Returns:
the user tag

isTimeValid

public boolean isTimeValid()
Description copied from interface: Time
Returns a data source specific flag to indicate whether the time information should be trusted. Typical cases are when records were not processes and the timestamp has a zero time.

Specified by:
isTimeValid in interface Time
Returns:
true if the time information is valid


Copyright © 2011. All Rights Reserved.