org.epics.pvmanager.pva.adapters

Class PVFieldToVShortArray

java.lang.Object

org.epics.pvmanager.pva.adapters.AlarmTimeExtractor

org.epics.pvmanager.pva.adapters.AlarmTimeDisplayExtractor

org.epics.pvmanager.pva.adapters.PVFieldToVShortArray

All Implemented Interfaces:

Alarm, Array, Display, Time, VNumberArray, VShortArray, VType

public class PVFieldToVShortArray
extends AlarmTimeDisplayExtractor
implements VShortArray

Author:

msekoranja

Field Summary

Fields inherited from class org.epics.pvmanager.pva.adapters.AlarmTimeDisplayExtractor

convert, format, lowerAlarmLimit, lowerCtrlLimit, lowerDisplayLimit, lowerWarningLimit, units, upperAlarmLimit, upperCtrlLimit, upperDisplayLimit, upperWarningLimit

Fields inherited from class org.epics.pvmanager.pva.adapters.AlarmTimeExtractor

alarmSeverity, alarmSeverityMapLUT, alarmStatus, alarmStatusMapLUT, isTimeValid, timeStamp, timeUserTag

Constructor Summary

Constructors

Constructor and Description
PVFieldToVShortArray(org.epics.pvdata.pv.PVField field, org.epics.pvdata.pv.PVStructure pvParent, boolean disconnected)
PVFieldToVShortArray(org.epics.pvdata.pv.PVStructure pvField, boolean disconnected)
PVFieldToVShortArray(String fieldName, org.epics.pvdata.pv.PVStructure pvField, boolean disconnected)

Method Summary

Methods

Modifier and Type	Method and Description
org.epics.util.array.ListShort	getData() Return the object containing the array data.
List<ArrayDimensionDisplay>	getDimensionDisplay() Returns the boundaries of each cell.
org.epics.util.array.ListInt	getSizes() The shape of the multidimensional array.
String	toString()

Methods inherited from class org.epics.pvmanager.pva.adapters.AlarmTimeDisplayExtractor

getDoubleValue, getFormat, getLowerAlarmLimit, getLowerCtrlLimit, getLowerDisplayLimit, getLowerWarningLimit, getUnits, getUpperAlarmLimit, getUpperCtrlLimit, getUpperDisplayLimit, getUpperWarningLimit

Methods inherited from class org.epics.pvmanager.pva.adapters.AlarmTimeExtractor

getAlarmName, getAlarmSeverity, getTimestamp, getTimeUserTag, isTimeValid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.epics.vtype.Alarm

getAlarmName, getAlarmSeverity

Methods inherited from interface org.epics.vtype.Time

getTimestamp, getTimeUserTag, isTimeValid

Methods inherited from interface org.epics.vtype.Display

getFormat, getLowerAlarmLimit, getLowerCtrlLimit, getLowerDisplayLimit, getLowerWarningLimit, getUnits, getUpperAlarmLimit, getUpperCtrlLimit, getUpperDisplayLimit, getUpperWarningLimit

Constructor Detail

PVFieldToVShortArray

public PVFieldToVShortArray(org.epics.pvdata.pv.PVStructure pvField,
                    boolean disconnected)

PVFieldToVShortArray

public PVFieldToVShortArray(String fieldName,
                    org.epics.pvdata.pv.PVStructure pvField,
                    boolean disconnected)

PVFieldToVShortArray

public PVFieldToVShortArray(org.epics.pvdata.pv.PVField field,
                    org.epics.pvdata.pv.PVStructure pvParent,
                    boolean disconnected)

Method Detail

getSizes

public org.epics.util.array.ListInt getSizes()

Description copied from interface: Array

The shape of the multidimensional array.

The size of the returned list will be the number of the dimension of the array. Each number represents the size of each dimension. The total number of elements in the array is therefore the product of all the numbers in the list returned.

Specified by:

getSizes in interface Array

Returns:

the dimension sizes

getData

public org.epics.util.array.ListShort getData()

Description copied from interface: Array

Return the object containing the array data.

This method will either return a List or a ListNumber depending of the array type. A collection is returned, instead of an array, so that the type implementation can be immutable or can at least try to prevent modifications. ListNumber has also several advantages over the Java arrays, including the ability to iterate the list regardless of numeric type.

If a numeric array is actually needed, refer to CollectionNumbers.

Specified by:

getData in interface Array

Specified by:

getData in interface VNumberArray

Specified by:

getData in interface VShortArray

Returns:

the array data

toString

public String toString()

Overrides:

toString in class Object

getDimensionDisplay

public List<ArrayDimensionDisplay> getDimensionDisplay()

Description copied from interface: VNumberArray

Returns the boundaries of each cell.

Specified by:

getDimensionDisplay in interface VNumberArray

Returns:

the dimension display; can't be null