epics::pvData::CreateRequest Class Reference

Create pvRequest structure for Channel methods. More...

#include "createRequest.h"

Collaboration diagram for epics::pvData::CreateRequest:

Public Member Functions
	POINTER_DEFINITIONS (CreateRequest)
	~CreateRequest ()
PVStructure::shared_pointer	createRequest (std::string const &request)
std::string	getMessage ()

Static Public Member Functions
static CreateRequest::shared_pointer	create ()

Protected Member Functions
	CreateRequest ()

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.

Constructor & Destructor Documentation

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

inline

Definition at line 39 of file createRequest.h.

{};

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

inlineprotected

Definition at line 55 of file createRequest.h.

{}

Member Function Documentation

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

static

Create s new instance of CreateRequest

Returns

A shared pointer to the new instance.

Definition at line 461 of file createRequest.cpp.

{
    CreateRequest::shared_pointer createRequest(new CreateRequest());
    return 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

request

The 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.

Definition at line 467 of file createRequest.cpp.

{
    message.clear();
    try {
        return ::createRequest(request);
    } catch(std::exception& e) {
        message = e.what();
        return PVStructure::shared_pointer();
    }
}

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.

{return message;}

epics::pvData::CreateRequest::POINTER_DEFINITIONS

(

CreateRequest

)

Member Data Documentation

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 files:

• modules/pvData/src/copy/pv/createRequest.h
• modules/pvData/src/copy/createRequest.cpp