Package org.epics.pvdata.pv

Interface PVBooleanArray

All Superinterfaces:

PVArray, PVField, PVScalarArray, Serializable, SerializableArray

All Known Implementing Classes:

BasePVBooleanArray

public interface PVBooleanArray
extends PVScalarArray

get/put a boolean array. The caller must be prepared to get/put the array in chunks. The return argument is always the number of elements that were transfered. It may be less than the number requested.

Author:

mrk

Method Summary

Modifier and Type	Method	Description
int	get(int offset, int length, BooleanArrayData data)	Get values from a PVBooleanArray and put them into boolean[]to.
int	put(int offset, int length, boolean[] from, int fromOffset)	Put values into a PVBooleanArray from boolean[]from.
void	shareData(boolean[] from)	Share the data from caller.

Methods inherited from interface org.epics.pvdata.pv.PVArray

getArray, getCapacity, getLength, isCapacityMutable, setCapacity, setCapacityMutable, setLength

Methods inherited from interface org.epics.pvdata.pv.PVField

getField, getFieldName, getFieldOffset, getFullName, getNextFieldOffset, getNumberFields, getParent, isImmutable, postPut, setImmutable, setPostHandler, toString, toString, toString

Methods inherited from interface org.epics.pvdata.pv.PVScalarArray

getScalarArray

Methods inherited from interface org.epics.pvdata.pv.Serializable

deserialize, serialize

Methods inherited from interface org.epics.pvdata.pv.SerializableArray

serialize

Method Detail

get

int get(int offset,
        int length,
        BooleanArrayData data)

Get values from a PVBooleanArray and put them into boolean[]to.

Parameters:

offset - the offset to the first element to get

length - the maximum number of elements to transfer

data - the class containing the data and an offset into the data. Get sets these values. The caller must do the actual data transfer

Returns:

The number of elements that can be transfered This is always less than or equal to length If the value is less then length then get should be called again If the return value is greater than 0 then data.data is a reference to the array and data.offset is the offset into the array.

put

int put(int offset,
        int length,
        boolean[] from,
        int fromOffset)

Put values into a PVBooleanArray from boolean[]from. If the field is immutable a message is generated, the field is not modified and 0 is returned.

Parameters:

offset - the offset to the first element to put.

length - the maximum number of elements to transfer.

from - the array from which to get the data.

fromOffset - The offset into from.

Returns:

the number of elements transfered. This is always less than or equal to length. If the value is less than the length then put should be called again.

shareData

void shareData(boolean[] from)

Share the data from caller. The capacity and length are taken from the array and this array is made immutable. This should only be used to share immutable data.

Parameters:

from - The data to share.