Interface ChannelArray

  • All Superinterfaces:
    ChannelRequest, org.epics.pvdata.misc.Destroyable, Lockable
    All Known Implementing Classes:
    ChannelArrayRequestImpl

    public interface ChannelArray
    extends ChannelRequest
    Request to put and get Array Data. The data is either taken from or put in the PVArray returned by ChannelArrayRequester.channelArrayConnect.
    Author:
    mrk
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void getArray​(int offset, int count, int stride)
      get from the remote array.
      void getLength()
      Get the length and the capacity.
      void putArray​(org.epics.pvdata.pv.PVArray putArray, int offset, int count, int stride)
      put to the remote array.
      void setLength​(int length)
      Set the length and/or the capacity.
      • Methods inherited from interface org.epics.pvdata.misc.Destroyable

        destroy
    • Method Detail

      • putArray

        void putArray​(org.epics.pvdata.pv.PVArray putArray,
                      int offset,
                      int count,
                      int stride)
        put to the remote array.
        Parameters:
        putArray - array to put.
        offset - The offset in the remote array, i.e. the PVArray returned by ChannelArrayRequester.channelArrayConnect.
        count - The number of elements to put, 0 means "entire array".
        stride - 1 means all the elements from offset to count, 2 means every other, 3 means every third, etc.
      • getArray

        void getArray​(int offset,
                      int count,
                      int stride)
        get from the remote array.
        Parameters:
        offset - The offset in the remote array, i.e. the PVArray returned by ChannelArrayRequester.channelArrayConnect.
        count - The number of elements to get, 0 means "till the end of array".
        stride - 1 means all the elements from offset to count, 2 means every other, 3 means every third, etc.
      • getLength

        void getLength()
        Get the length and the capacity.
      • setLength

        void setLength​(int length)
        Set the length and/or the capacity.
        Parameters:
        length - The new length.