PDBGroupPut Struct Reference

#include "pdbgroup.h"

Inheritance diagram for PDBGroupPut:

Collaboration diagram for PDBGroupPut:

Public Types
typedef epics::pvAccess::ChannelPutRequester	requester_t
Public Types inherited from epics::pvAccess::ChannelPut
typedef ChannelPutRequester	requester_type

Public Member Functions
	POINTER_DEFINITIONS (PDBGroupPut)
	PDBGroupPut (const PDBGroupChannel::shared_pointer &channel, const epics::pvAccess::ChannelPutRequester::shared_pointer &requester, const epics::pvData::PVStructure::shared_pointer &pvReq)
virtual	~PDBGroupPut ()
virtual void	destroy () OVERRIDE FINAL
virtual std::tr1::shared_ptr< epics::pvAccess::Channel >	getChannel () OVERRIDE FINAL
virtual void	cancel () OVERRIDE FINAL
virtual void	lastRequest () OVERRIDE FINAL
virtual void	put (epics::pvData::PVStructure::shared_pointer const &pvPutStructure, epics::pvData::BitSet::shared_pointer const &putBitSet) OVERRIDE FINAL
virtual void	get () OVERRIDE FINAL
Public Member Functions inherited from epics::pvAccess::ChannelPut
	POINTER_DEFINITIONS (ChannelPut)
virtual	~ChannelPut ()
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 ()
virtual void	lock ()
virtual void	unlock ()

Public Attributes
PDBGroupChannel::shared_pointer	channel
requester_type::weak_pointer	requester
bool	atomic
bool	doWait
PVIF::proc_t	doProc
epics::pvData::BitSetPtr	changed
epics::pvData::PVStructurePtr	pvf
std::vector< std::tr1::shared_ptr< PVIF > >	pvif

Static Public Attributes
static size_t	num_instances
Static Public Attributes inherited from epics::pvAccess::ChannelRequest
static size_t	num_instances

Additional Inherited Members
Protected Member Functions inherited from epics::pvAccess::Destroyable
virtual	~Destroyable ()

Detailed Description

Definition at line 163 of file pdbgroup.h.

Member Typedef Documentation

typedef epics::pvAccess::ChannelPutRequester PDBGroupPut::requester_t

Definition at line 167 of file pdbgroup.h.

Constructor & Destructor Documentation

PDBGroupPut::PDBGroupPut	(	const PDBGroupChannel::shared_pointer &	channel,
		const epics::pvAccess::ChannelPutRequester::shared_pointer &	requester,
		const epics::pvData::PVStructure::shared_pointer &	pvReq
	)

Definition at line 294 of file pdbgroup.cpp.

    :channel(channel)
    ,requester(requester)
    ,atomic(channel->pv->pgatomic)
    ,doWait(false)
    ,doProc(PVIF::ProcPassive)
    ,changed(new pvd::BitSet(channel->fielddesc->getNumberFields()))
    ,pvf(pvd::getPVDataCreate()->createPVStructure(channel->fielddesc))
{
    epics::atomic::increment(num_instances);
    try {
        getS<pvd::boolean>(pvReq, "record._options.atomic", atomic);

        getS<pvd::boolean>(pvReq, "record._options.block", doWait);

        std::string proccmd;
        if(getS<std::string>(pvReq, "record._options.process", proccmd)) {
            if(proccmd=="true") {
                doProc = PVIF::ProcForce;
            } else if(proccmd=="false") {
                doProc = PVIF::ProcInhibit;
                doWait = false; // no point in waiting
            } else if(proccmd=="passive") {
                doProc = PVIF::ProcPassive;
            } else {
                requester->message("process= expects: true|false|passive", pva::warningMessage);
            }
        }
    }catch(std::exception& e){
        requester->message(std::string("Error processing request options: ")+e.what());
    }

    pvf->getSubFieldT<pvd::PVBoolean>("record._options.atomic")->put(atomic);


    const size_t npvs = channel->pv->members.size();
    pvif.resize(npvs);
    for(size_t i=0; i<npvs; i++)
    {
        PDBGroupPV::Info& info = channel->pv->members[i];

        pvif[i].reset(info.builder->attach(info.chan, pvf, info.attachment));
    }
}

PDBGroupPut::~PDBGroupPut ( )

virtual

Definition at line 341 of file pdbgroup.cpp.

{
    epics::atomic::decrement(num_instances);
}

Member Function Documentation

virtual void PDBGroupPut::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 188 of file pdbgroup.h.

{}

virtual void PDBGroupPut::destroy ( )

inlinevirtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

Definition at line 186 of file pdbgroup.h.

{ pvif.clear(); channel.reset(); requester.reset(); }

void PDBGroupPut::get ( )

virtual

Get the current data.

Ownership transfer as with ChannelGet::get()

Implements epics::pvAccess::ChannelPut.

Definition at line 390 of file pdbgroup.cpp.

{
    const size_t npvs = pvif.size();

    changed->clear();
    if(atomic) {
        DBManyLocker L(channel->pv->locker);
        for(size_t i=0; i<npvs; i++)
            pvif[i]->put(*changed, DBE_VALUE|DBE_ALARM|DBE_PROPERTY, NULL);
    } else {

        for(size_t i=0; i<npvs; i++)
        {
            PDBGroupPV::Info& info = channel->pv->members[i];

            DBScanLocker L(dbChannelRecord(info.chan));
            pvif[i]->put(*changed, DBE_VALUE|DBE_ALARM|DBE_PROPERTY, NULL);
        }
    }
    //TODO: report unused fields as changed?
    changed->clear();
    changed->set(0);

    requester_type::shared_pointer req(requester.lock());
    if(req)
        req->getDone(pvd::Status(), shared_from_this(), pvf, changed);
}

virtual std::tr1::shared_ptr<epics::pvAccess::Channel> PDBGroupPut::getChannel ( )

inlinevirtual

Get a channel instance this request belongs to.

Returns

the channel instance.

Implements epics::pvAccess::ChannelRequest.

Definition at line 187 of file pdbgroup.h.

{ return channel; }

virtual void PDBGroupPut::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 189 of file pdbgroup.h.

{}

PDBGroupPut::POINTER_DEFINITIONS

(

PDBGroupPut

)

void PDBGroupPut::put ( epics::pvData::PVStructure::shared_pointer const &  pvPutStructure, epics::pvData::BitSet::shared_pointer const &  putBitSet  )

virtual

Put data to a channel.

Completion status is reported by calling ChannelPutRequester::putDone()

Ownership of the PVStructure is transfered to the ChannelPut until ChannelPutRequester::putDone() or ChannelPutRequester::channelDisconnect() is called.

Parameters

pvPutStructure	The PVStructure that holds the putData.
putBitSet	putPVStructure bit-set (selects what fields to put).

Implements epics::pvAccess::ChannelPut.

Definition at line 346 of file pdbgroup.cpp.

{
    // assume value may be a different struct each time... lot of wasted prep work
    const size_t npvs = channel->pv->members.size();
    std::vector<std::tr1::shared_ptr<PVIF> > putpvif(npvs);

    for(size_t i=0; i<npvs; i++)
    {
        PDBGroupPV::Info& info = channel->pv->members[i];
        if(!info.allowProc) continue;

        putpvif[i].reset(info.builder->attach(info.chan, value, info.attachment));
    }

    pvd::Status ret;
    if(atomic) {
        DBManyLocker L(channel->pv->locker);
        for(size_t i=0; ret && i<npvs; i++) {
            if(!putpvif[i].get()) continue;

            ret |= putpvif[i]->get(*changed, doProc);
        }

    } else {
        for(size_t i=0; ret && i<npvs; i++)
        {
            if(!putpvif[i].get()) continue;

            PDBGroupPV::Info& info = channel->pv->members[i];

            DBScanLocker L(dbChannelRecord(info.chan));

            ret |= putpvif[i]->get(*changed,
                                   info.allowProc ? doProc : PVIF::ProcInhibit,
                                   channel->aspvt[i].canWrite());
        }
    }

    requester_type::shared_pointer req(requester.lock());
    if(req)
        req->putDone(ret, shared_from_this());
}

Member Data Documentation

bool PDBGroupPut::atomic

Definition at line 172 of file pdbgroup.h.

epics::pvData::BitSetPtr PDBGroupPut::changed

Definition at line 175 of file pdbgroup.h.

PDBGroupChannel::shared_pointer PDBGroupPut::channel

Definition at line 168 of file pdbgroup.h.

PVIF::proc_t PDBGroupPut::doProc

Definition at line 173 of file pdbgroup.h.

bool PDBGroupPut::doWait

Definition at line 172 of file pdbgroup.h.

size_t PDBGroupPut::num_instances

static

Definition at line 179 of file pdbgroup.h.

epics::pvData::PVStructurePtr PDBGroupPut::pvf

Definition at line 176 of file pdbgroup.h.

std::vector<std::tr1::shared_ptr<PVIF> > PDBGroupPut::pvif

Definition at line 177 of file pdbgroup.h.

requester_type::weak_pointer PDBGroupPut::requester

Definition at line 169 of file pdbgroup.h.

---

The documentation for this struct was generated from the following files:

• modules/pva2pva/pdbApp/pdbgroup.h
• modules/pva2pva/pdbApp/pdbgroup.cpp