#include <rr_data_response.h>
Public Member Functions | |
| shared_ptr< Serializable > | getAdditionalStatus () |
| void | getAdditionalStatusAs (Serializable &result) |
| EIP_USINT | getGeneralStatus () const |
| shared_ptr< Serializable > | getResponseData () |
| void | getResponseDataAs (Serializable &result) |
| EIP_USINT | getServiceCode () const |
Protected Member Functions | |
| virtual shared_ptr< Serializable > | getData () const |
| virtual void | setData (CPFItem &item) |
Private Attributes | |
| MessageRouterResponse | response_data_ |
Detailed Description
Class to encapsulate an RR Data request specifically
Definition at line 56 of file rr_data_response.h.
Member Function Documentation
| shared_ptr<Serializable> eip::RRDataResponse::getAdditionalStatus | ( | ) | [inline] |
Get a shared pointer to the additional status given in the RR Data response. If no additional status given (i.e. length 0) then the pointer will be null
- Returns:
- Shared pointer to additional status, or null if none given
Definition at line 83 of file rr_data_response.h.
| void eip::RRDataResponse::getAdditionalStatusAs | ( | Serializable & | result | ) | [inline] |
Copy the additional status into the serializable type given. Note that status must be available, make sure to check pointer exists first!
- Parameters:
-
result Structure into which to copy data
Definition at line 103 of file rr_data_response.h.
| virtual shared_ptr<Serializable> eip::RRDataResponse::getData | ( | ) | const [inline, protected, virtual] |
Cannot current serialize this class
Reimplemented from eip::RRData.
Definition at line 122 of file rr_data_response.h.
| EIP_USINT eip::RRDataResponse::getGeneralStatus | ( | ) | const [inline] |
Get the general status code given in the message router section of the RR Data response
- Returns:
- general status code value
Definition at line 73 of file rr_data_response.h.
| shared_ptr<Serializable> eip::RRDataResponse::getResponseData | ( | ) | [inline] |
Get a shared pointer to the data given in the RR Data response. If no data given (i.e. length 0), then the pointer will be null.
- Returns:
- Shared pointer to response data, or null if none given
Definition at line 93 of file rr_data_response.h.
| void eip::RRDataResponse::getResponseDataAs | ( | Serializable & | result | ) | [inline] |
Copy the response data into the given serializable type. Note that data must be available, make sure to check pointer exists first!
- Parameters:
-
result Structure into which to copy data
Definition at line 113 of file rr_data_response.h.
| EIP_USINT eip::RRDataResponse::getServiceCode | ( | ) | const [inline] |
Get the response code given in the Message Router section of the RR Data Response
- Returns:
- service code value
Definition at line 64 of file rr_data_response.h.
| virtual void eip::RRDataResponse::setData | ( | CPFItem & | item | ) | [inline, protected, virtual] |
Used during deserialization to pass in the item data to be parsed
Reimplemented from eip::RRData.
Definition at line 130 of file rr_data_response.h.
Member Data Documentation
Definition at line 136 of file rr_data_response.h.
The documentation for this class was generated from the following file: