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

#include <message_router_response.h>

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

Public Member Functions

virtual Reader & deserialize (Reader &reader, size_t length)
 
virtual Reader & deserialize (Reader &reader)
 
shared_ptr< Serializable > getAdditionalStatus () const
 
virtual size_t getLength () const
 
shared_ptr< Serializable > getResponseData () const
 
 MessageRouterResponse ()
 
virtual Writer & serialize (Writer &writer) const
 

Public Attributes

EIP_USINT general_status
 
EIP_USINT service
 

Private Member Functions

shared_ptr< Serializable > readData (Reader &reader, int length)
 

Private Attributes

shared_ptr< Serializable > additional_status_
 
shared_ptr< Serializable > response_data_
 

Detailed Description

Class to encapsulate a MessageRouterResponse data.

Definition at line 48 of file message_router_response.h.

Constructor & Destructor Documentation

eip::MessageRouterResponse::MessageRouterResponse ( )
inline

Construct an empty RR data holder

Definition at line 58 of file message_router_response.h.

Member Function Documentation

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

Deserialize response data from the given reader and length

Definition at line 52 of file message_router_response.cpp.

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

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

Definition at line 103 of file message_router_response.h.

shared_ptr<Serializable> eip::MessageRouterResponse::getAdditionalStatus ( ) const
inline

Get the additional status data object in this message

Returns
Serializable additional status to be used for this response

Definition at line 64 of file message_router_response.h.

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

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

Returns
Total length in bytes to be serialized

Definition at line 37 of file message_router_response.cpp.

shared_ptr<Serializable> eip::MessageRouterResponse::getResponseData ( ) const
inline

Get the response data object in this message

Returns
Serializable data to be used for this response

Definition at line 73 of file message_router_response.h.

shared_ptr< Serializable > eip::MessageRouterResponse::readData ( Reader &  reader,
int  length 
)
private

Helper to read data fields. Simply produces SerializableBuffers of the given length, or a null pointer if length <= 0.

Parameters
readerReader to use to read buffer data
lengthLength in bytes to read. If less than or equal to zero, then null pointer is returned.
Returns
shared_ptr to a SerializableBuffer with the data read

Definition at line 65 of file message_router_response.cpp.

virtual Writer& eip::MessageRouterResponse::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

Definition at line 90 of file message_router_response.h.

Member Data Documentation

shared_ptr<Serializable> eip::MessageRouterResponse::additional_status_
private

Definition at line 109 of file message_router_response.h.

EIP_USINT eip::MessageRouterResponse::general_status

Definition at line 53 of file message_router_response.h.

shared_ptr<Serializable> eip::MessageRouterResponse::response_data_
private

Definition at line 110 of file message_router_response.h.

EIP_USINT eip::MessageRouterResponse::service

Definition at line 52 of file message_router_response.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