eip::RRData Class Reference

#include <rr_data.h>

Inheritance diagram for eip::RRData:

Public Member Functions
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

Public Attributes
EIP_UDINT	interface_handle
EIP_UINT	timeout

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

Detailed Description

Class to encapsulate an RR Data request or reply. Note that this is intended to be used within the payload of a EncapPacket.

Definition at line 51 of file rr_data.h.

Constructor & Destructor Documentation

RRData()

eip::RRData::RRData ( )

inline

Construct an empty RR data holder

Definition at line 61 of file rr_data.h.

Member Function Documentation

deserialize() [1/2]

Reader & eip::RRData::deserialize ( Reader &  reader )

virtual

Deserialize data from the given reader without length information

Parameters

reader

Reader to use for deserialization

Returns

the reader again

Exceptions

std::length_error

if the buffer is overrun while deserializing

Implements eip::serialization::Serializable.

Definition at line 50 of file rr_data.cpp.

deserialize() [2/2]

virtual Reader& eip::RRData::deserialize ( Reader &  reader, size_t  length  )

inlinevirtual

Extra length information is not relevant in this context. Same as deserialize(reader)

Implements eip::serialization::Serializable.

Definition at line 88 of file rr_data.h.

getData()

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

inlineprotectedvirtual

Serialize data for the specific implementation. Default is null

Returns

Shared pointer to the serializable of the data to send

Reimplemented in eip::RRDataRequest, and eip::RRDataResponse.

Definition at line 107 of file rr_data.h.

getLength()

virtual size_t eip::RRData::getLength ( ) const

inlinevirtual

Get the length of serialized data that would be produced if serialized

Returns

Total length in bytes to be serialized

Implements eip::serialization::Serializable.

Definition at line 67 of file rr_data.h.

serialize()

Writer & eip::RRData::serialize ( Writer &  writer ) const

virtual

Serialize data into the given buffer

Parameters

writer

Writer to use for serialization

Returns

the writer again

Exceptions

std::length_error

if the buffer is too small for the header data

Implements eip::serialization::Serializable.

Definition at line 39 of file rr_data.cpp.

setData()

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

inlineprotectedvirtual

Deserialize the data for this specific implementation

Parameters

item	the CPF item that was deserialized, copy data from that

Reimplemented in eip::RRDataRequest, and eip::RRDataResponse.

Definition at line 116 of file rr_data.h.

Member Data Documentation

interface_handle

EIP_UDINT eip::RRData::interface_handle

Definition at line 55 of file rr_data.h.

timeout

EIP_UINT eip::RRData::timeout

Definition at line 56 of file rr_data.h.

---

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

• rr_data.h
• rr_data.cpp