eip::RRDataRequest Class Reference

#include <rr_data_request.h>

Inheritance diagram for eip::RRDataRequest:

Public Member Functions
shared_ptr< Serializable >	getMRData ()
Path &	getPath ()
EIP_USINT	getServiceCode () const
	RRDataRequest (EIP_USINT service_code, const Path &path)
	RRDataRequest (EIP_USINT service_code, const Path &path, shared_ptr< Serializable > data)
	RRDataRequest (EIP_USINT service_code=0)
void	setMRData (shared_ptr< Serializable > data)
void	setServiceCode (EIP_USINT service_code)
Public Member Functions inherited from eip::RRData
virtual Reader &	deserialize (Reader &reader)
virtual Reader &	deserialize (Reader &reader, size_t length)
virtual size_t	getLength () const
	RRData ()
virtual Writer &	serialize (Writer &writer) const

Protected Member Functions
virtual shared_ptr< Serializable >	getData () const
virtual void	setData (CPFItem &item)

Private Attributes
shared_ptr< MessageRouterRequest >	mr_data_

Additional Inherited Members
Public Attributes inherited from eip::RRData
EIP_UDINT	interface_handle
EIP_UINT	timeout

Detailed Description

Class to encapsulate an RR Data request specifically

Definition at line 54 of file rr_data_request.h.

Constructor & Destructor Documentation

RRDataRequest() [1/3]

eip::RRDataRequest::RRDataRequest ( EIP_USINT  service_code = 0 )

inline

Construct an empty RR data request

Definition at line 61 of file rr_data_request.h.

RRDataRequest() [2/3]

eip::RRDataRequest::RRDataRequest ( EIP_USINT  service_code, const Path &  path, shared_ptr< Serializable >  data  )

inline

Construct an RR data request for the given path and data

Definition at line 69 of file rr_data_request.h.

RRDataRequest() [3/3]

eip::RRDataRequest::RRDataRequest ( EIP_USINT  service_code, const Path &  path  )

inline

Construct an RR data request for the given path and without data

Definition at line 79 of file rr_data_request.h.

Member Function Documentation

getData()

virtual shared_ptr<Serializable> eip::RRDataRequest::getData ( ) const

inlineprotectedvirtual

Return reference to the MR request to send

Reimplemented from eip::RRData.

Definition at line 136 of file rr_data_request.h.

getMRData()

shared_ptr<Serializable> eip::RRDataRequest::getMRData ( )

inline

Get a shared pointer to the data used for this request. If no value is to be supplied, pointer is null.

Returns

shared pointer to data to be sent with request

Definition at line 117 of file rr_data_request.h.

getPath()

Path& eip::RRDataRequest::getPath ( )

inline

Get the path for this request. Can be used to modify the path.

Returns

path reference for this request

Definition at line 107 of file rr_data_request.h.

getServiceCode()

EIP_USINT eip::RRDataRequest::getServiceCode ( ) const

inline

Get the service code for this request

Parameters

service

code value

Definition at line 89 of file rr_data_request.h.

setData()

virtual void eip::RRDataRequest::setData ( CPFItem &  item )

inlineprotectedvirtual

Cannot currently deserialize this class

Reimplemented from eip::RRData.

Definition at line 144 of file rr_data_request.h.

setMRData()

void eip::RRDataRequest::setMRData ( shared_ptr< Serializable >  data )

inline

Set the data to be used for this request. If no data is to be set set to null (i.e. the default value of a shared_ptr).

Parameters

data	Data to be sent with the request

Definition at line 127 of file rr_data_request.h.

setServiceCode()

void eip::RRDataRequest::setServiceCode ( EIP_USINT  service_code )

inline

Set the service code for this request.

Parameters

service_code

service value to use

Definition at line 98 of file rr_data_request.h.

Member Data Documentation

mr_data_

shared_ptr<MessageRouterRequest> eip::RRDataRequest::mr_data_

private

Definition at line 150 of file rr_data_request.h.

---

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

• rr_data_request.h