epics::pvDatabase::ChannelLocal Class Reference

Channel for accessing a PVRecord. More...

#include "channelProviderLocal.h"

Inheritance diagram for epics::pvDatabase::ChannelLocal:

Collaboration diagram for epics::pvDatabase::ChannelLocal:

Public Member Functions
	POINTER_DEFINITIONS (ChannelLocal)
	ChannelLocal (ChannelProviderLocalPtr const &channelProvider, epics::pvAccess::ChannelRequester::shared_pointer const &requester, PVRecordPtr const &pvRecord)
virtual	~ChannelLocal ()
	Destructor. More...
virtual void	destroy ()
	DEPRECATED. More...
virtual void	detach (PVRecordPtr const &pvRecord)
	Detach from the record. More...
virtual std::string	getRequesterName ()
	Get the requester name. More...
virtual void	message (std::string const &message, epics::pvData::MessageType messageType)
	Passes the message to the channel requester. More...
virtual epics::pvAccess::ChannelProvider::shared_pointer	getProvider ()
	Get the channel provider. More...
virtual std::string	getRemoteAddress ()
	Get the remote address. More...
virtual epics::pvAccess::Channel::ConnectionState	getConnectionState ()
virtual std::string	getChannelName ()
	Get the channel name. More...
virtual epics::pvAccess::ChannelRequester::shared_pointer	getChannelRequester ()
	Get the channel requester. More...
virtual bool	isConnected ()
	Is the channel connected? More...
virtual void	getField (epics::pvAccess::GetFieldRequester::shared_pointer const &requester, std::string const &subField)
	Get the introspection interface for subField. More...
virtual epics::pvAccess::AccessRights	getAccessRights (epics::pvData::PVField::shared_pointer const &pvField)
virtual epics::pvAccess::ChannelProcess::shared_pointer	createChannelProcess (epics::pvAccess::ChannelProcessRequester::shared_pointer const &requester, epics::pvData::PVStructurePtr const &pvRequest)
	Create a channelProcess. More...
virtual epics::pvAccess::ChannelGet::shared_pointer	createChannelGet (epics::pvAccess::ChannelGetRequester::shared_pointer const &requester, epics::pvData::PVStructurePtr const &pvRequest)
	Create a channelGet. More...
virtual epics::pvAccess::ChannelPut::shared_pointer	createChannelPut (epics::pvAccess::ChannelPutRequester::shared_pointer const &requester, epics::pvData::PVStructurePtr const &pvRequest)
	Create a channelPut. More...
virtual epics::pvAccess::ChannelPutGet::shared_pointer	createChannelPutGet (epics::pvAccess::ChannelPutGetRequester::shared_pointer const &requester, epics::pvData::PVStructurePtr const &pvRequest)
	Create a channelPutGet. More...
virtual epics::pvAccess::ChannelRPC::shared_pointer	createChannelRPC (epics::pvAccess::ChannelRPCRequester::shared_pointer const &requester, epics::pvData::PVStructurePtr const &pvRequest)
	Create a channelRPC. More...
virtual epics::pvData::Monitor::shared_pointer	createMonitor (epics::pvData::MonitorRequester::shared_pointer const &requester, epics::pvData::PVStructurePtr const &pvRequest)
	Create a monitor. More...
virtual epics::pvAccess::ChannelArray::shared_pointer	createChannelArray (epics::pvAccess::ChannelArrayRequester::shared_pointer const &requester, epics::pvData::PVStructurePtr const &pvRequest)
	Create a channelArray. More...
virtual void	printInfo ()
	calls printInfo(std::cout); More...
virtual void	printInfo (std::ostream &out)
	displays a message More...
Public Member Functions inherited from epics::pvAccess::Channel
	POINTER_DEFINITIONS (Channel)
	Channel ()
virtual	~Channel ()
virtual void	getField (GetFieldRequester::shared_pointer const &requester, std::string const &subField)
virtual ChannelProcess::shared_pointer	createChannelProcess (ChannelProcessRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)
virtual ChannelGet::shared_pointer	createChannelGet (ChannelGetRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)
virtual ChannelPut::shared_pointer	createChannelPut (ChannelPutRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)
virtual ChannelPutGet::shared_pointer	createChannelPutGet (ChannelPutGetRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)
virtual ChannelRPC::shared_pointer	createChannelRPC (ChannelRPCRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)
virtual Monitor::shared_pointer	createMonitor (MonitorRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)
virtual ChannelArray::shared_pointer	createChannelArray (ChannelArrayRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)
Public Member Functions inherited from epics::pvAccess::Requester
	POINTER_DEFINITIONS (Requester)
virtual	~Requester ()
virtual void	message (std::string const &message, MessageType messageType=errorMessage)
Public Member Functions inherited from epics::pvAccess::Destroyable
	POINTER_DEFINITIONS (Destroyable)
Public Member Functions inherited from epics::pvDatabase::PVRecordClient
	POINTER_DEFINITIONS (PVRecordClient)
virtual	~PVRecordClient ()
	Destructor. More...

Protected Member Functions
shared_pointer	getPtrSelf ()
Protected Member Functions inherited from epics::pvAccess::Destroyable
virtual	~Destroyable ()

Additional Inherited Members
Public Types inherited from epics::pvAccess::Channel
enum	ConnectionState { NEVER_CONNECTED, CONNECTED, DISCONNECTED, DESTROYED }
typedef ChannelRequester	requester_type
Static Public Attributes inherited from epics::pvAccess::Channel
static size_t	num_instances
static const char *	ConnectionStateNames [] = { "NEVER_CONNECTED", "CONNECTED", "DISCONNECTED", "DESTROYED" }

Detailed Description

Channel for accessing a PVRecord.

A Channel for accessing a record in the PVDatabase. It is a complete implementation of Channel

Definition at line 172 of file channelProviderLocal.h.

Constructor & Destructor Documentation

epics::pvDatabase::ChannelLocal::ChannelLocal	(	ChannelProviderLocalPtr const &	channelProvider,
		epics::pvAccess::ChannelRequester::shared_pointer const &	requester,
		PVRecordPtr const &	pvRecord
	)

Constructor

Parameters

channelProvider	The channel provider.
requester	The client callback.
pvRecord	The record the channel will access.

Definition at line 1227 of file channelLocal.cpp.

:
    requester(requester),
    provider(provider),
    pvRecord(pvRecord)
{
    if(pvRecord->getTraceLevel()>0) {
         cout << "ChannelLocal::ChannelLocal()"
              << " recordName " << pvRecord->getRecordName()
              << " requester exists " << (requester ? "true" : "false")
              << endl;
    }
}

epics::pvDatabase::ChannelLocal::~ChannelLocal ( )

virtual

Destructor.

Definition at line 1244 of file channelLocal.cpp.

{
// cout << "~ChannelLocal()" << endl;
}

Member Function Documentation

ChannelArray::shared_pointer epics::pvDatabase::ChannelLocal::createChannelArray ( epics::pvAccess::ChannelArrayRequester::shared_pointer const &  requester, epics::pvData::PVStructurePtr const &  pvRequest  )

virtual

Create a channelArray.

Parameters

requester	The client callback.
pvRequest	The options specified by the client.

Returns

A shared pointer to the newly created implementation. The implementation is null if pvRequest has invalid options.

Definition at line 1488 of file channelLocal.cpp.

{
    PVRecordPtr pvr(pvRecord.lock());
    if(!pvr) throw std::logic_error("pvRecord is deleted");
    if(pvr->getTraceLevel()>0) {
         cout << "ChannelLocal::createChannelArray() "
         << " recordName " << pvr->getRecordName()
         << " requester exists " << (requester ? "true" : "false")
         << endl;
    }
    ChannelArrayLocalPtr channelArray =
       ChannelArrayLocal::create(
            getPtrSelf(),
            channelArrayRequester,
            pvRequest,
            pvr);
    return channelArray;
}

ChannelGet::shared_pointer epics::pvDatabase::ChannelLocal::createChannelGet ( epics::pvAccess::ChannelGetRequester::shared_pointer const &  requester, epics::pvData::PVStructurePtr const &  pvRequest  )

virtual

Create a channelGet.

Parameters

requester	The client callback.
pvRequest	The options specified by the client.

Returns

A shared pointer to the newly created implementation. The implementation is null if pvRequest has invalid options.

Definition at line 1381 of file channelLocal.cpp.

{
    PVRecordPtr pvr(pvRecord.lock());
    if(!pvr) throw std::logic_error("pvRecord is deleted");
    if(pvr->getTraceLevel()>0) {
         cout << "ChannelLocal::createChannelGet() "
         << " recordName " << pvr->getRecordName()
         << " requester exists " << (requester ? "true" : "false")
         << endl;
    }
    ChannelGetLocalPtr channelGet =
       ChannelGetLocal::create(
            getPtrSelf(),
            channelGetRequester,
            pvRequest,
            pvr);
    return channelGet;
}

ChannelProcess::shared_pointer epics::pvDatabase::ChannelLocal::createChannelProcess ( epics::pvAccess::ChannelProcessRequester::shared_pointer const &  requester, epics::pvData::PVStructurePtr const &  pvRequest  )

virtual

Create a channelProcess.

Parameters

requester	The client callback.
pvRequest	The options specified by the client.

Returns

A shared pointer to the newly created implementation. The implementation is null if pvRequest has invalid options.

Definition at line 1360 of file channelLocal.cpp.

{
    PVRecordPtr pvr(pvRecord.lock());
    if(!pvr) throw std::logic_error("pvRecord is deleted");
    if(pvr->getTraceLevel()>0) {
         cout << "ChannelLocal::createChannelProcess() "
         << " recordName " << pvr->getRecordName()
         << " requester exists " << (requester ? "true" : "false")
         << endl;
    }
    ChannelProcessLocalPtr channelProcess =
       ChannelProcessLocal::create(
            getPtrSelf(),
            channelProcessRequester,
            pvRequest,
            pvr);
    return channelProcess;
}

ChannelPut::shared_pointer epics::pvDatabase::ChannelLocal::createChannelPut ( epics::pvAccess::ChannelPutRequester::shared_pointer const &  requester, epics::pvData::PVStructurePtr const &  pvRequest  )

virtual

Create a channelPut.

Parameters

requester	The client callback.
pvRequest	The options specified by the client.

Returns

A shared pointer to the newly created implementation. The implementation is null if pvRequest has invalid options.

Definition at line 1402 of file channelLocal.cpp.

{
    PVRecordPtr pvr(pvRecord.lock());
    if(!pvr) throw std::logic_error("pvRecord is deleted");
    if(pvr->getTraceLevel()>0) {
         cout << "ChannelLocal::createChannelPut() "
         << " recordName " << pvr->getRecordName()
         << " requester exists " << (requester ? "true" : "false")
         << endl;
    }

    ChannelPutLocalPtr channelPut =
       ChannelPutLocal::create(
            getPtrSelf(),
            channelPutRequester,
            pvRequest,
            pvr);
    return channelPut;
}

ChannelPutGet::shared_pointer epics::pvDatabase::ChannelLocal::createChannelPutGet ( epics::pvAccess::ChannelPutGetRequester::shared_pointer const &  requester, epics::pvData::PVStructurePtr const &  pvRequest  )

virtual

Create a channelPutGet.

Parameters

requester	The client callback.
pvRequest	The options specified by the client.

Returns

A shared pointer to the newly created implementation. The implementation is null if pvRequest has invalid options.

Definition at line 1424 of file channelLocal.cpp.

{
    PVRecordPtr pvr(pvRecord.lock());
    if(!pvr) throw std::logic_error("pvRecord is deleted");
    if(pvr->getTraceLevel()>0) {
         cout << "ChannelLocal::createChannelPutGet() "
         << " recordName " << pvr->getRecordName()
         << " requester exists " << (requester ? "true" : "false")
         << endl;
    }

    ChannelPutGetLocalPtr channelPutGet =
       ChannelPutGetLocal::create(
            getPtrSelf(),
            channelPutGetRequester,
            pvRequest,
            pvr);
    return channelPutGet;
}

ChannelRPC::shared_pointer epics::pvDatabase::ChannelLocal::createChannelRPC ( epics::pvAccess::ChannelRPCRequester::shared_pointer const &  requester, epics::pvData::PVStructurePtr const &  pvRequest  )

virtual

Create a channelRPC.

The PVRecord must implement getService or an empty shared pointer is returned.

Parameters

requester	The client callback
pvRequest	The options specified by the client.

Returns

null.

Definition at line 1446 of file channelLocal.cpp.

{
    PVRecordPtr pvr(pvRecord.lock());
    if(!pvr) throw std::logic_error("pvRecord is deleted");
    if(pvr->getTraceLevel()>0) {
         cout << "ChannelLocal::createChannelRPC() "
         << " recordName " << pvr->getRecordName()
         << " requester exists " << (requester ? "true" : "false")
         << endl;
    }

    ChannelRPCLocalPtr channelRPC =
        ChannelRPCLocal::create(
            getPtrSelf(),
            channelRPCRequester,
            pvRequest,
            pvr);
     return channelRPC;
}

Monitor::shared_pointer epics::pvDatabase::ChannelLocal::createMonitor ( epics::pvData::MonitorRequester::shared_pointer const &  requester, epics::pvData::PVStructurePtr const &  pvRequest  )

virtual

Create a monitor.

Parameters

requester	The client callback.
pvRequest	The options specified by the client.

Returns

A shared pointer to the newly created implementation. The implementation is null if pvRequest has invalid options.

Definition at line 1468 of file channelLocal.cpp.

{
    PVRecordPtr pvr(pvRecord.lock());
    if(!pvr) throw std::logic_error("pvRecord is deleted");
    if(pvr->getTraceLevel()>0) {
         cout << "ChannelLocal::createMonitor() "
         << " recordName " << pvr->getRecordName()
         << " requester exists " << (requester ? "true" : "false")
         << endl;
    }

    MonitorPtr monitor = createMonitorLocal(
            pvr,
            monitorRequester,
            pvRequest);
    return monitor;
}

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

inlinevirtual

DEPRECATED.

Implements epics::pvAccess::Destroyable.

Definition at line 197 of file channelProviderLocal.h.

{};

void epics::pvDatabase::ChannelLocal::detach ( PVRecordPtr const &  pvRecord )

virtual

Detach from the record.

This is called when a record is being removed from the database.

Parameters

pvRecord

The record being removed.

Implements epics::pvDatabase::PVRecordClient.

Definition at line 1254 of file channelLocal.cpp.

{
    if(pvRecord->getTraceLevel()>0) {
         cout << "ChannelLocal::detach() "
         << " recordName " << pvRecord->getRecordName()
         << " requester exists " << (requester ? "true" : "false")
         << endl;
    }
    if(!requester) return;
    requester->channelStateChange(shared_from_this(),Channel::DESTROYED);
}

AccessRights epics::pvDatabase::ChannelLocal::getAccessRights ( epics::pvData::PVField::shared_pointer const &  pvField )

virtual

Get the access rights for the record. This throws an exception because it is assumed that access rights are handled by a higher level.

Reimplemented from epics::pvAccess::Channel.

Definition at line 1354 of file channelLocal.cpp.

{
    throw std::logic_error("Not Implemented");
}

string epics::pvDatabase::ChannelLocal::getChannelName ( )

virtual

Get the channel name.

Returns

the record name.

Implements epics::pvAccess::Channel.

Definition at line 1314 of file channelLocal.cpp.

{
    PVRecordPtr pvr(pvRecord.lock());
    string name("record deleted");
    if(pvr) name = pvr->getRecordName();
    return name;
}

ChannelRequester::shared_pointer epics::pvDatabase::ChannelLocal::getChannelRequester ( )

virtual

Get the channel requester.

Returns

The channel requester.

Implements epics::pvAccess::Channel.

Definition at line 1322 of file channelLocal.cpp.

{
    return requester;
}

Channel::ConnectionState epics::pvDatabase::ChannelLocal::getConnectionState ( )

virtual

Get the connection state.

Returns

Channel::CONNECTED.

Reimplemented from epics::pvAccess::Channel.

Definition at line 1309 of file channelLocal.cpp.

{
    return Channel::CONNECTED;
}

void epics::pvDatabase::ChannelLocal::getField ( epics::pvAccess::GetFieldRequester::shared_pointer const &  requester, std::string const &  subField  )

virtual

Get the introspection interface for subField.

The introspection interface is given via GetFieldRequester::getDone.

Parameters

requester	The client callback.
subField	The subField of the record. If an empty string then the interface for the top level structure of the record is provided.

Definition at line 1332 of file channelLocal.cpp.

{
    PVRecordPtr pvr(pvRecord.lock());
    if(!pvr) throw std::logic_error("pvRecord is deleted");
    if(subField.size()<1) {
        StructureConstPtr structure =
            pvr->getPVRecordStructure()->getPVStructure()->getStructure();
        requester->getDone(Status::Ok,structure);
        return;
    }
    PVFieldPtr pvField =
        pvr->getPVRecordStructure()->getPVStructure()->getSubField(subField);
    if(pvField) {
        requester->getDone(Status::Ok,pvField->getField());
        return;
    }
    Status status(Status::STATUSTYPE_ERROR,
        "client asked for illegal field");
    requester->getDone(status,FieldConstPtr());
}

ChannelProvider::shared_pointer epics::pvDatabase::ChannelLocal::getProvider ( )

virtual

Get the channel provider.

Returns

The provider.

Implements epics::pvAccess::Channel.

Definition at line 1249 of file channelLocal.cpp.

{
    return provider.lock();
}

shared_pointer epics::pvDatabase::ChannelLocal::getPtrSelf ( )

inlineprotected

Definition at line 355 of file channelProviderLocal.h.

    {
        return shared_from_this();
    }

string epics::pvDatabase::ChannelLocal::getRemoteAddress ( )

virtual

Get the remote address.

Returns

local

Implements epics::pvAccess::Channel.

Definition at line 1304 of file channelLocal.cpp.

{
    return string("local");
}

string epics::pvDatabase::ChannelLocal::getRequesterName ( )

virtual

Get the requester name.

Returns

returns the name of the channel requester.

Reimplemented from epics::pvAccess::Channel.

Definition at line 1267 of file channelLocal.cpp.

{
    PVRecordPtr pvr(pvRecord.lock());
    if(pvr && pvr->getTraceLevel()>0) {
         cout << "ChannelLocal::getRequesterName() "
         << " recordName " << pvr->getRecordName()
         << " requester exists " << (requester ? "true" : "false")
         << endl;
    }

    if(!requester) return string();
    return requester->getRequesterName();
}

bool epics::pvDatabase::ChannelLocal::isConnected ( )

virtual

Is the channel connected?

Returns

true.

Reimplemented from epics::pvAccess::Channel.

Definition at line 1327 of file channelLocal.cpp.

{
    return true;
}

void epics::pvDatabase::ChannelLocal::message ( std::string const &  message, epics::pvData::MessageType  messageType  )

virtual

Passes the message to the channel requester.

Parameters

message	The message.
messageType	The message type.

Reimplemented from epics::pvAccess::Channel.

Definition at line 1281 of file channelLocal.cpp.

{
    PVRecordPtr pvr(pvRecord.lock());
    if(pvr && pvr->getTraceLevel()>1) {
         cout << "ChannelLocal::message() "
         << " recordName " << pvr->getRecordName()
         << " requester exists " << (requester ? "true" : "false")
         << endl;
    }
    if(requester) {
        requester->message(message,messageType);
        return;
    }
    string recordName("record deleted");
    if(pvr) recordName = pvr->getRecordName();
    cout << recordName
         << " message " << message
         << " messageType " << getMessageTypeName(messageType)
         << endl;
}

epics::pvDatabase::ChannelLocal::POINTER_DEFINITIONS

(

ChannelLocal

)

void epics::pvDatabase::ChannelLocal::printInfo ( )

virtual

calls printInfo(std::cout);

Reimplemented from epics::pvAccess::Channel.

Definition at line 1509 of file channelLocal.cpp.

{
    printInfo(std::cout);
}

void epics::pvDatabase::ChannelLocal::printInfo ( std::ostream &  out )

virtual

displays a message

Parameters

out	the stream on which the message is displayed.

Reimplemented from epics::pvAccess::Channel.

Definition at line 1514 of file channelLocal.cpp.

{
    out << "ChannelLocal provides access to a record in the local PVDatabase";
}

---

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

• modules/pvDatabase/src/pv/channelProviderLocal.h
• modules/pvDatabase/src/pvAccess/channelLocal.cpp