epics::pvDatabase::ChannelArrayLocal Class Reference

Inheritance diagram for epics::pvDatabase::ChannelArrayLocal:

Collaboration diagram for epics::pvDatabase::ChannelArrayLocal:

Public Member Functions
	POINTER_DEFINITIONS (ChannelArrayLocal)
virtual	~ChannelArrayLocal ()
virtual void	destroy ()
virtual void	getArray (size_t offset, size_t count, size_t stride)
virtual void	putArray (PVArrayPtr const &putArray, size_t offset, size_t count, size_t stride)
virtual void	getLength ()
virtual void	setLength (size_t length)
virtual std::tr1::shared_ptr< Channel >	getChannel ()
virtual void	cancel ()
virtual void	lock ()
virtual void	unlock ()
virtual void	lastRequest ()
Public Member Functions inherited from epics::pvAccess::ChannelArray
	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
Public Member Functions inherited from epics::pvAccess::ChannelRequest
	POINTER_DEFINITIONS (ChannelRequest)
	ChannelRequest ()
virtual	~ChannelRequest ()
Public Member Functions inherited from epics::pvAccess::Destroyable
	POINTER_DEFINITIONS (Destroyable)
Public Member Functions inherited from epics::pvAccess::Lockable
	POINTER_DEFINITIONS (Lockable)
virtual	~Lockable ()

Static Public Member Functions
static ChannelArrayLocalPtr	create (ChannelLocalPtr const &channelLocal, ChannelArrayRequester::shared_pointer const &channelArrayRequester, PVStructurePtr const &pvRequest, PVRecordPtr const &pvRecord)

Additional Inherited Members
Public Types inherited from epics::pvAccess::ChannelArray
typedef ChannelArrayRequester	requester_type
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

Definition at line 954 of file channelLocal.cpp.

Constructor & Destructor Documentation

epics::pvDatabase::ChannelArrayLocal::~ChannelArrayLocal ( )

virtual

Definition at line 1090 of file channelLocal.cpp.

{
//cout << "~ChannelArrayLocal()\n";
}

Member Function Documentation

virtual void epics::pvDatabase::ChannelArrayLocal::cancel ( )

inlinevirtual

Cancel any pending request. Completion will be reported via request's response callback:

• if cancel() request is issued after the request was already complete, request success/failure completion will be reported and cancel() request ignored.
• if the request was actually canceled, cancellation completion is reported.

Implements epics::pvAccess::ChannelRequest.

Definition at line 974 of file channelLocal.cpp.

{}

ChannelArrayLocalPtr epics::pvDatabase::ChannelArrayLocal::create ( ChannelLocalPtr const &  channelLocal, ChannelArrayRequester::shared_pointer const &  channelArrayRequester, PVStructurePtr const &  pvRequest, PVRecordPtr const &  pvRecord  )

static

Definition at line 1007 of file channelLocal.cpp.

{
    PVFieldPtrArray const & pvFields = pvRequest->getPVFields();
    if(pvFields.size()!=1) {
        Status status(
            Status::STATUSTYPE_ERROR,"invalid pvRequest");
        ChannelArrayLocalPtr channelArray;
        ArrayConstPtr array;
        channelArrayRequester->channelArrayConnect(status,channelArray,array);
        return channelArray;
    }
    PVFieldPtr pvField = pvFields[0];
    string fieldName("");
    while(true) {
        string name = pvField->getFieldName();
        if(fieldName.size()>0) fieldName += '.';
        fieldName += name;
        PVStructurePtr pvs = static_pointer_cast<PVStructure>(pvField);
        PVFieldPtrArray const & pvfs = pvs->getPVFields();
        if(pvfs.size()!=1) break;
        pvField = pvfs[0];
    }
    size_t indfield = fieldName.find_first_of("field.");
    if(indfield==0) {
         fieldName = fieldName.substr(6);
    }
    pvField = pvRecord->getPVRecordStructure()->getPVStructure()->getSubField(fieldName);
    if(!pvField) {
        Status status(
            Status::STATUSTYPE_ERROR,fieldName +" not found");
        ChannelArrayLocalPtr channelArray;
        ArrayConstPtr array;
        channelArrayRequester->channelArrayConnect(
            status,channelArray,array);
        return channelArray;
    }
    if(pvField->getField()->getType()!=scalarArray
    && pvField->getField()->getType()!=structureArray
    && pvField->getField()->getType()!=unionArray)
    {
        Status status(
            Status::STATUSTYPE_ERROR,fieldName +" not array");
        ChannelArrayLocalPtr channelArray;
        ArrayConstPtr array;
        channelArrayRequester->channelArrayConnect(
           status,channelArray,array);
        return channelArray;
    }
    PVArrayPtr pvArray = static_pointer_cast<PVArray>(pvField);
    PVArrayPtr pvCopy;
    if(pvField->getField()->getType()==scalarArray) {
        PVScalarArrayPtr xxx = static_pointer_cast<PVScalarArray>(pvField);
        pvCopy = getPVDataCreate()->createPVScalarArray(
            xxx->getScalarArray()->getElementType());
    } else if(pvField->getField()->getType()==structureArray) {
        PVStructureArrayPtr xxx = static_pointer_cast<PVStructureArray>(pvField);
        pvCopy = getPVDataCreate()->createPVStructureArray(
            xxx->getStructureArray()->getStructure());
    } else {
        PVUnionArrayPtr xxx = static_pointer_cast<PVUnionArray>(pvField);
        pvCopy = getPVDataCreate()->createPVUnionArray(
            xxx->getUnionArray()->getUnion());
    }
    ChannelArrayLocalPtr array(new ChannelArrayLocal(
        channelLocal,
        channelArrayRequester,
        pvArray,
        pvCopy,
        pvRecord));
    if(pvRecord->getTraceLevel()>0)
    {
        cout << "ChannelArrayLocal::create";
        cout << " recordName " << pvRecord->getRecordName() << endl;
    }
    channelArrayRequester->channelArrayConnect(
        Status::Ok, array, pvCopy->getArray());
    return array;
}

virtual void epics::pvDatabase::ChannelArrayLocal::destroy ( )

inlinevirtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

Definition at line 961 of file channelLocal.cpp.

{} // DEPRECATED

void epics::pvDatabase::ChannelArrayLocal::getArray ( size_t  offset, size_t  count, size_t  stride  )

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.

Implements epics::pvAccess::ChannelArray.

Definition at line 1114 of file channelLocal.cpp.

{
    ChannelArrayRequester::shared_pointer requester = channelArrayRequester.lock();
    if(!requester) return;
    PVRecordPtr pvr(pvRecord.lock());
    if(!pvr) throw std::logic_error("pvRecord is deleted");
    if(pvr->getTraceLevel()>1)
    {
       cout << "ChannelArrayLocal::getArray" << endl;
    }
    const char *exceptionMessage = NULL;
    try {
        bool ok = false;
        epicsGuard <PVRecord> guard(*pvr);
        while(true) {
            size_t length  = pvArray->getLength();
            if(length<=0) break;
            if(count<=0) {
                 count = (length -offset + stride -1)/stride;
                 if(count>0) ok = true;
                 break;
            }
            size_t maxcount = (length -offset + stride -1)/stride;
            if(count>maxcount) count = maxcount;
            ok = true;
            break;
        }
        if(ok) {
            pvCopy->setLength(count);
            copy(pvArray,offset,stride,pvCopy,0,1,count);
        }
    } catch(std::exception& e) {
        exceptionMessage = e.what();
    }
    Status status = Status::Ok;
    if(exceptionMessage!=NULL) {
      status = Status(Status::STATUSTYPE_ERROR,exceptionMessage);
    }
    requester->getArrayDone(status,getPtrSelf(),pvCopy);
}

std::tr1::shared_ptr< Channel > epics::pvDatabase::ChannelArrayLocal::getChannel ( )

virtual

Get a channel instance this request belongs to.

Returns

the channel instance.

Implements epics::pvAccess::ChannelRequest.

Definition at line 1095 of file channelLocal.cpp.

{
   ChannelLocalPtr channel(channelLocal.lock());
   return channel;
}

void epics::pvDatabase::ChannelArrayLocal::getLength ( )

virtual

Get the length.

Implements epics::pvAccess::ChannelArray.

Definition at line 1182 of file channelLocal.cpp.

{
    ChannelArrayRequester::shared_pointer requester = channelArrayRequester.lock();
    if(!requester) return;
    PVRecordPtr pvr(pvRecord.lock());
    if(!pvr) throw std::logic_error("pvRecord is deleted");
    size_t length = 0;
    const char *exceptionMessage = NULL;
    try {
        epicsGuard <PVRecord> guard(*pvr);
        length = pvArray->getLength();
    } catch(std::exception& e) {
        exceptionMessage = e.what();
    }
    Status status = Status::Ok;
    if(exceptionMessage!=NULL) {
        status = Status(Status::STATUSTYPE_ERROR,exceptionMessage);
    }
    requester->getLengthDone(status,getPtrSelf(),length);
}

virtual void epics::pvDatabase::ChannelArrayLocal::lastRequest ( )

inlinevirtual

Announce next request as last request. When last request will be completed (regardless of completion status) the remote and local instance will be destroyed.

Implements epics::pvAccess::ChannelRequest.

Definition at line 977 of file channelLocal.cpp.

{}

void epics::pvDatabase::ChannelArrayLocal::lock ( )

virtual

Reimplemented from epics::pvAccess::Lockable.

Definition at line 1101 of file channelLocal.cpp.

{
    PVRecordPtr pvr(pvRecord.lock());
    if(!pvr) throw std::logic_error("pvRecord is deleted");
    pvr->lock();
}

epics::pvDatabase::ChannelArrayLocal::POINTER_DEFINITIONS

(

ChannelArrayLocal

)

void epics::pvDatabase::ChannelArrayLocal::putArray ( PVArrayPtr const &  putArray, size_t  offset, size_t  count, size_t  stride  )

virtual

Definition at line 1155 of file channelLocal.cpp.

{
    ChannelArrayRequester::shared_pointer requester = channelArrayRequester.lock();
    if(!requester) return;
    PVRecordPtr pvr(pvRecord.lock());
    if(!pvr) throw std::logic_error("pvRecord is deleted");
    if(pvr->getTraceLevel()>1)
    {
       cout << "ChannelArrayLocal::putArray" << endl;
    }
    size_t newLength = offset + count*stride;
    if(newLength<pvArray->getLength()) pvArray->setLength(newLength);
    const char *exceptionMessage = NULL;
    try {
        epicsGuard <PVRecord> guard(*pvr);
        copy(pvArray,0,1,this->pvArray,offset,stride,count);
    } catch(std::exception& e) {
        exceptionMessage = e.what();
    }
    Status status = Status::Ok;
    if(exceptionMessage!=NULL) {
        status = Status(Status::STATUSTYPE_ERROR,exceptionMessage);
    }
    requester->putArrayDone(status,getPtrSelf());
}

void epics::pvDatabase::ChannelArrayLocal::setLength ( size_t  length )

virtual

Set the length and/or the capacity.

Parameters

length

The new length.

Implements epics::pvAccess::ChannelArray.

Definition at line 1203 of file channelLocal.cpp.

{
    ChannelArrayRequester::shared_pointer requester = channelArrayRequester.lock();
    if(!requester) return;
    PVRecordPtr pvr(pvRecord.lock());
    if(!pvr) throw std::logic_error("pvRecord is deleted");
    if(pvr->getTraceLevel()>1)
    {
       cout << "ChannelArrayLocal::setLength" << endl;
    }
    try {
         {
             epicsGuard <PVRecord> guard(*pvr);
             if(pvArray->getLength()!=length) pvArray->setLength(length);
         }
         requester->setLengthDone(Status::Ok,getPtrSelf());
    } catch(std::exception& e) {
        string exceptionMessage = e.what();
        Status status = Status(Status::STATUSTYPE_ERROR,exceptionMessage);
        requester->setLengthDone(status,getPtrSelf());
    }
}

void epics::pvDatabase::ChannelArrayLocal::unlock ( )

virtual

Reimplemented from epics::pvAccess::Lockable.

Definition at line 1107 of file channelLocal.cpp.

{
    PVRecordPtr pvr(pvRecord.lock());
    if(!pvr) throw std::logic_error("pvRecord is deleted");
    pvr->unlock();
}

---

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

• modules/pvDatabase/src/pvAccess/channelLocal.cpp