org.epics.pvaClient

Class PvaClientGetData

java.lang.Object

org.epics.pvaClient.PvaClientGetData

public class PvaClientGetData
extends Object

This is a convenience wrapper for data for a channelGet or the get part of a channelPutGet.

Since:

2015.06

Author:

mrk

Method Summary

Modifier and Type	Method and Description
org.epics.pvdata.property.Alarm	getAlarm() Get the alarm for the last get.
org.epics.pvdata.pv.PVArray	getArrayValue() Return the interface to an array value field.
org.epics.pvdata.misc.BitSet	getChangedBitSet() Get the BitSet for the pvStructure This shows which fields have changed value.
double	getDouble() Get the value as a double.
double[]	getDoubleArray() Get the value as a double array.
int	getDoubleArray(double[] value, int length) Copy a sub-array of the value field into value.
org.epics.pvdata.pv.PVStructure	getPVStructure() Get the pvStructure.
org.epics.pvdata.pv.PVScalarArray	getScalarArrayValue() Return the interface to a scalar array value field.
org.epics.pvdata.pv.PVScalar	getScalarValue() Return the interface to a scalar value field.
String	getString() Get the value as a string.
String[]	getStringArray() Get the value as a string array.
int	getStringArray(String[] value, int length) Copy a sub-array of the value field into value.
org.epics.pvdata.pv.Structure	getStructure() Get the structure.
org.epics.pvdata.property.TimeStamp	getTimeStamp() Get the timeStamp for the last get.
org.epics.pvdata.pv.PVField	getValue() Return the interface to the value field.
boolean	hasValue() Is there a top level field named value of the PVstructure returned by channelGet?
boolean	isValueScalar() Is the value field a scalar?
boolean	isValueScalarArray() Is the value field a scalar array?
void	setMessagePrefix(String value) Set a prefix for throw messages.
String	showChanged() Show fields that have changed value, i.

Methods inherited from class java.lang.Object

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

Method Detail

setMessagePrefix

public void setMessagePrefix(String value)

Set a prefix for throw messages.

Parameters:

value - The prefix.

getStructure

public org.epics.pvdata.pv.Structure getStructure()

Get the structure.

Returns:

the introspection interface for the data..

getPVStructure

public org.epics.pvdata.pv.PVStructure getPVStructure()

Get the pvStructure.

Returns:

the pvStructure.

getChangedBitSet

public org.epics.pvdata.misc.BitSet getChangedBitSet()

Get the BitSet for the pvStructure This shows which fields have changed value.

Returns:

The bitSet

showChanged

public String showChanged()

Show fields that have changed value, i. e. all fields as shown by bitSet.

Returns:

The changed fields.

hasValue

public boolean hasValue()

Is there a top level field named value of the PVstructure returned by channelGet?

Returns:

The answer.

isValueScalar

public boolean isValueScalar()

Is the value field a scalar?

Returns:

The answer.

isValueScalarArray

public boolean isValueScalarArray()

Is the value field a scalar array?

Returns:

The answer.

getValue

public org.epics.pvdata.pv.PVField getValue()

Return the interface to the value field.

Returns:

The interface or null if no top level value field.

getScalarValue

public org.epics.pvdata.pv.PVScalar getScalarValue()

Return the interface to a scalar value field.

Returns:

Return the interface for a scalar value field or null if no scalar value field.

getArrayValue

public org.epics.pvdata.pv.PVArray getArrayValue()

Return the interface to an array value field.

Returns:

Return the interface or null if an array value field does not exist.

getScalarArrayValue

public org.epics.pvdata.pv.PVScalarArray getScalarArrayValue()

Return the interface to a scalar array value field.

Returns:

Return the interface or null if a scalar array value field does not exist

getDouble

public double getDouble()

Get the value as a double.

Returns:

If value is not a numeric scalar an exception is thrown.

getString

public String getString()

Get the value as a string.

Returns:

The value.

getDoubleArray

public double[] getDoubleArray()

Get the value as a double array.

Returns:

If the value is not a numeric array an exception is thrown.

getStringArray

public String[] getStringArray()

Get the value as a string array.

Returns:

If the value is not a scalar array an exception is thrown.

getDoubleArray

public int getDoubleArray(double[] value,
                          int length)

Copy a sub-array of the value field into value. If the value field is not a numeric array field no elements are copied.

Parameters:

value - The place where data is copied.

length - The maximum number of elements to copy.

Returns:

The number of elements copied.

getStringArray

public int getStringArray(String[] value,
                          int length)

Copy a sub-array of the value field into value. If the value field is not a scalar array field an exception is thrown.

Parameters:

value - The place where data is copied.

length - The maximum number of elements to copy.

Returns:

The number of elements copied.

getAlarm

public org.epics.pvdata.property.Alarm getAlarm()

Get the alarm for the last get.

Returns:

The alarm.

getTimeStamp

public org.epics.pvdata.property.TimeStamp getTimeStamp()

Get the timeStamp for the last get.

Returns:

The timeStamp.