Public Member Functions | Public Attributes | Private Attributes | List of all members
eip::MessageRouterRequest Class Reference

#include <message_router_request.h>

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

Public Member Functions

virtual Readerdeserialize (Reader &reader)
 
virtual Readerdeserialize (Reader &reader, size_t length)
 
shared_ptr< SerializablegetData () const
 
virtual size_t getLength () const
 
PathgetPath ()
 
 MessageRouterRequest (EIP_USINT service_code=0)
 
virtual Writerserialize (Writer &writer) const
 
void setData (shared_ptr< Serializable > data)
 

Public Attributes

EIP_USINT service
 

Private Attributes

shared_ptr< Serializabledata_
 
Path path_
 

Detailed Description

Class to encapsulate a MessageRouterRequest data.

Definition at line 49 of file message_router_request.h.

Constructor & Destructor Documentation

◆ MessageRouterRequest()

eip::MessageRouterRequest::MessageRouterRequest ( EIP_USINT  service_code = 0)
inline

Construct an empty RR data holder

Definition at line 58 of file message_router_request.h.

Member Function Documentation

◆ deserialize() [1/2]

virtual Reader& eip::MessageRouterRequest::deserialize ( Reader reader)
inlinevirtual

Not implemented. Never expect to have to receive this type of message.

Implements eip::serialization::Serializable.

Definition at line 128 of file message_router_request.h.

◆ deserialize() [2/2]

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

Not implemented. Never expect to have to receive this type of message.

Implements eip::serialization::Serializable.

Definition at line 120 of file message_router_request.h.

◆ getData()

shared_ptr<Serializable> eip::MessageRouterRequest::getData ( ) const
inline

Get the data object in this message request

Returns
Serializable data to be used for this request

Definition at line 82 of file message_router_request.h.

◆ getLength()

virtual size_t eip::MessageRouterRequest::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 91 of file message_router_request.h.

◆ getPath()

Path& eip::MessageRouterRequest::getPath ( )
inline

Get the path in the given message router request

Returns
reference to the current Path

Definition at line 64 of file message_router_request.h.

◆ serialize()

virtual Writer& eip::MessageRouterRequest::serialize ( Writer writer) const
inlinevirtual

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

Implements eip::serialization::Serializable.

Definition at line 107 of file message_router_request.h.

◆ setData()

void eip::MessageRouterRequest::setData ( shared_ptr< Serializable data)
inline

Set the data to be used for this message router request

Parameters
dataSerializable that will be used as the data object

Definition at line 73 of file message_router_request.h.

Member Data Documentation

◆ data_

shared_ptr<Serializable> eip::MessageRouterRequest::data_
private

Definition at line 134 of file message_router_request.h.

◆ path_

Path eip::MessageRouterRequest::path_
private

Definition at line 135 of file message_router_request.h.

◆ service

EIP_USINT eip::MessageRouterRequest::service

Definition at line 53 of file message_router_request.h.


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


odva_ethernetip
Author(s): Kareem Shehata
autogenerated on Wed Mar 2 2022 00:38:56