Public Member Functions | Public Attributes | Protected Member Functions | List of all members
eip::RRData Class Reference

#include <rr_data.h>

Inheritance diagram for eip::RRData:
Inheritance graph
[legend]

Public Member Functions

virtual Reader & deserialize (Reader &reader, size_t length)
 
virtual Reader & deserialize (Reader &reader)
 
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

eip::RRData::RRData ( )
inline

Construct an empty RR data holder

Definition at line 61 of file rr_data.h.

Member Function Documentation

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

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

Definition at line 88 of file rr_data.h.

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

Deserialize data from the given reader without length information

Parameters
readerReader to use for deserialization
Returns
the reader again
Exceptions
std::length_errorif the buffer is overrun while deserializing

Definition at line 49 of file rr_data.cpp.

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.

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

Definition at line 67 of file rr_data.h.

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

Serialize data into the given buffer

Parameters
writerWriter to use for serialization
Returns
the writer again
Exceptions
std::length_errorif the buffer is too small for the header data

Definition at line 38 of file rr_data.cpp.

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

Deserialize the data for this specific implementation

Parameters
itemthe 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

EIP_UDINT eip::RRData::interface_handle

Definition at line 55 of file rr_data.h.

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:


odva_ethernetip
Author(s): Kareem Shehata
autogenerated on Mon Jun 10 2019 14:00:16