epics::pvAccess::ChannelArray Class Reference

#include "pvAccess.h"

Inheritance diagram for epics::pvAccess::ChannelArray:

Collaboration diagram for epics::pvAccess::ChannelArray:

Public Types
typedef ChannelArrayRequester	requester_type

Public Member Functions
	POINTER_DEFINITIONS (ChannelArray)
virtual	~ChannelArray ()
virtual void	putArray (epics::pvData::PVArray::shared_pointer const &putArray, size_t offset=0, size_t count=0, size_t stride=1)=0
virtual void	getArray (size_t offset=0, size_t count=0, size_t stride=1)=0
virtual void	getLength ()=0
virtual void	setLength (size_t length)=0
Public Member Functions inherited from epics::pvAccess::ChannelRequest
	POINTER_DEFINITIONS (ChannelRequest)
	ChannelRequest ()
virtual	~ChannelRequest ()
virtual std::tr1::shared_ptr< Channel >	getChannel ()=0
virtual void	cancel ()=0
virtual void	lastRequest ()=0
Public Member Functions inherited from epics::pvAccess::Destroyable
	POINTER_DEFINITIONS (Destroyable)
virtual void	destroy ()=0
Public Member Functions inherited from epics::pvAccess::Lockable
	POINTER_DEFINITIONS (Lockable)
virtual	~Lockable ()
virtual void	lock ()
virtual void	unlock ()

Additional Inherited Members
Static Public Attributes inherited from epics::pvAccess::ChannelRequest
static size_t	num_instances
Protected Member Functions inherited from epics::pvAccess::Destroyable
virtual	~Destroyable ()

Detailed Description

Request to put and get Array Data. The data is either taken from or put in the PVArray returned by ChannelArrayRequester.channelArrayConnect.

Definition at line 283 of file pvAccess.h.

Member Typedef Documentation

typedef ChannelArrayRequester epics::pvAccess::ChannelArray::requester_type

Definition at line 286 of file pvAccess.h.

Constructor & Destructor Documentation

virtual epics::pvAccess::ChannelArray::~ChannelArray ( )

inlinevirtual

Definition at line 288 of file pvAccess.h.

{}

Member Function Documentation

virtual void epics::pvAccess::ChannelArray::getArray ( size_t  offset = 0, size_t  count = 0, size_t  stride = 1  )

pure virtual

get from the remote array.

Ownership of the PVArray previously passed to ChannelArrayRequester::getArrayDone() is returned to the ChannelArray from the ChannelArrayRequester.

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 an array".
stride	1 means all the elements from offset to count, 2 means every other, 3 means every third, etc.

Implemented in epics::pvDatabase::ChannelArrayLocal.

virtual void epics::pvAccess::ChannelArray::getLength ( )

pure virtual

Get the length.

Implemented in epics::pvDatabase::ChannelArrayLocal.

epics::pvAccess::ChannelArray::POINTER_DEFINITIONS

(

ChannelArray

)

virtual void epics::pvAccess::ChannelArray::putArray ( epics::pvData::PVArray::shared_pointer const &  putArray, size_t  offset = 0, size_t  count = 0, size_t  stride = 1  )

pure virtual

put to the remote array.

Ownership of the PVArray is transferred to the ChannelArray until ChannelArrayRequester::putArrayDone() or ChannelArrayRequester::channelDisconnect() is called.

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.

virtual void epics::pvAccess::ChannelArray::setLength ( size_t  length )

pure virtual

Set the length and/or the capacity.

Parameters

length

The new length.

Implemented in epics::pvDatabase::ChannelArrayLocal.

---

The documentation for this class was generated from the following file:

• modules/pvAccess/src/client/pv/pvAccess.h