org.epics.pvaClient

Class PvaClientPutData

java.lang.Object

org.epics.pvaClient.PvaClientPutData

public class PvaClientPutData
extends Object

This is a convenience wrapper for data for a channelPut or the put part of a channelPutGet.

Since:

2015.06

Author:

mrk

Method Summary

Modifier and Type	Method and Description
PVArray	getArrayValue() Return the interface to an array value field.
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.
PVStructure	getPVStructure() Get the pvStructure.
PVScalarArray	getScalarArrayValue() Return the interface to a scalar array value field.
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.
Structure	getStructure() Get the structure.
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	putDouble(double value) Put the value as a double.
void	putDoubleArray(double[] value) Copy the array to the value field.
void	putString(String value) Put the value as a string.
void	putStringArray(String[] value) Copy array to the value field.
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 Structure getStructure()

Get the structure.

Returns:

the structure.

getPVStructure

public PVStructure getPVStructure()

Get the pvStructure.

Returns:

the pvStructure.

getChangedBitSet

public 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 PVField getValue()

Return the interface to the value field.

Returns:

The interface or null if no top level value field.

getScalarValue

public 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 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 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 setStatus is called and 0 is returned.

getString

public String getString()

Get the value as a string.

Returns:

If value is not a scalar setStatus is called and 0 is returned.

getDoubleArray

public double[] getDoubleArray()

Get the value as a double array.

Returns:

If the value is not a numeric array null is returned.

getStringArray

public String[] getStringArray()

Get the value as a string array.

Returns:

If the value is not a scalar array null is returned.

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 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.

putDouble

public void putDouble(double value)

Put the value as a double. An exception is also thrown if the actualy type can cause an overflow. If value is not a numeric scalar an exception is thrown.

Parameters:

value - The new data value.

putString

public void putString(String value)

Put the value as a string. If value is not a scalar an exception is thrown.

Parameters:

value - The new value as a String.

putDoubleArray

public void putDoubleArray(double[] value)

Copy the array to the value field. If the value field is not a double array field an exception is thrown.

Parameters:

value - The place where data is copied.

putStringArray

public void putStringArray(String[] value)

Copy array to the value field. If the value field is not a string array field an exception is thrown.

Parameters:

value - data source