PVData C++  8.0.3
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
epics::pvData::CreateRequest Class Reference

Create pvRequest structure for Channel methods. More...

#include <copy/pv/createRequest.h>

Collaboration diagram for epics::pvData::CreateRequest:
Collaboration graph
[legend]

Public Member Functions

 POINTER_DEFINITIONS (CreateRequest)
 
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 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.


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