PVData C++ 8.0.7
Loading...
Searching...
No Matches
epics::pvData::CreateRequest Class Reference

Create pvRequest structure for Channel methods. More...

#include <copy/pv/createRequest.h>

Public Types

typedef std::tr1::shared_ptr< CreateRequestshared_pointer
 
typedef std::tr1::shared_ptr< const CreateRequestconst_shared_pointer
 
typedef std::tr1::weak_ptr< CreateRequestweak_pointer
 
typedef std::tr1::weak_ptr< const CreateRequestconst_weak_pointer
 

Public Member Functions

PVStructure::shared_pointer createRequest (std::string const &request)
 
std::string getMessage ()
 

Static Public Member Functions

static CreateRequest::shared_pointer create ()
 

Protected Attributes

std::string message
 

Detailed Description

Create pvRequest structure for Channel methods.

Many methods of the Channel class of pvAccess have an argument PVStructurePtr const * pvRequest. This class provides a method that creates a valid pvRequest.

Definition at line 31 of file createRequest.h.

Member Typedef Documentation

◆ const_shared_pointer

std::tr1::shared_ptr<const CreateRequest> epics::pvData::CreateRequest::const_shared_pointer

Definition at line 33 of file createRequest.h.

◆ const_weak_pointer

std::tr1::weak_ptr<const CreateRequest> epics::pvData::CreateRequest::const_weak_pointer

Definition at line 33 of file createRequest.h.

◆ shared_pointer

std::tr1::shared_ptr<CreateRequest> epics::pvData::CreateRequest::shared_pointer

Definition at line 33 of file createRequest.h.

◆ weak_pointer

std::tr1::weak_ptr<CreateRequest> epics::pvData::CreateRequest::weak_pointer

Definition at line 33 of file createRequest.h.

Constructor & Destructor Documentation

◆ ~CreateRequest()

epics::pvData::CreateRequest::~CreateRequest ( )
inline

Definition at line 39 of file createRequest.h.

◆ CreateRequest()

epics::pvData::CreateRequest::CreateRequest ( )
inlineprotected

Definition at line 55 of file createRequest.h.

Member Function Documentation

◆ create()

static CreateRequest::shared_pointer epics::pvData::CreateRequest::create ( )
static

Create s new instance of CreateRequest

Returns
A shared pointer to the new instance.

◆ createRequest()

PVStructure::shared_pointer epics::pvData::CreateRequest::createRequest ( std::string const & request)

Create a request structure for the create calls in Channel. See the package overview documentation for details.

Parameters
requestThe field request. See the package overview documentation for details.
Returns
The request PVStructure if a valid request was given. If a NULL PVStructure is returned then getMessage will return the reason.

◆ getMessage()

std::string epics::pvData::CreateRequest::getMessage ( )
inline

Get the error message of createRequest returns NULL return the error message

Definition at line 53 of file createRequest.h.

Member Data Documentation

◆ message

std::string epics::pvData::CreateRequest::message
protected

Definition at line 56 of file createRequest.h.


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