Public Types | Static Public Member Functions | List of all members
RTC::DataPortStatus Class Reference

DataPortStatus mixin class. More...

#include <DataPortStatus.h>

Inheritance diagram for RTC::DataPortStatus:
Inheritance graph
[legend]

Public Types

enum  Enum {
  PORT_OK = 0, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL,
  BUFFER_EMPTY, BUFFER_TIMEOUT, SEND_FULL, SEND_TIMEOUT,
  RECV_EMPTY, RECV_TIMEOUT, INVALID_ARGS, PRECONDITION_NOT_MET,
  CONNECTION_LOST, UNKNOWN_ERROR
}
 DataPortStatus return codes. More...
 

Static Public Member Functions

static const char * toString (DataPortStatus::Enum status)
 Convert DataPortStatus into the string. More...
 

Detailed Description

DataPortStatus mixin class.

This is a mixin class to provide enumed return codes that are commonly utilised in data port related sub-classes. To use this class, sub-class should inherit this class as a public super class, and declare DATAPORTSTATUS_ENUM defined below. Consequently, ReturnCode_t type that is typedefed by this macro can be used in the sub-class, and enumed identifiers are imported to the class's namespace.

Definition at line 54 of file DataPortStatus.h.

Member Enumeration Documentation

◆ Enum

DataPortStatus return codes.

Common return codes for data ports related classes.

  • PORT_OK: Normal return
  • PORT_ERROR: Error return
  • BUFFER_ERROR: Buffer error
  • BUFFER_FULL: Buffer full
  • BUFFER_EMPTY: Buffer empty
  • BUFFER_TIMEOUT: Buffer timeout
  • SEND_FULL: Buffer full although OutPort tried to send data
  • SEND_TIMEOUT: Timeout although OutPort tried to send data
  • RECV_EMPTY: Buffer empty although InPort tried to receive data
  • RECV_TIMEOUT: Timeout although InPort tried to receive data
  • INVALID_ARGS: Invalid arguments
  • PRECONDITION_NOT_MET: Precondition not met
  • CONNECTION_LOST: Connection has been lost
  • UNKNOWN_ERROR: Unknown error

This error codes might be used to propagate error status from the error occurring point to the function caller in the data stream path. It would occur in data-transfer path and data receiver/sender. The errors that occur in the interface of each portion of data port are shown below.

(1) Push Type a) The return codes between InPortConsumer and Publisher/Activity PORT_OK, PORT_ERROR, SEND_FULL, SEND_TIMEOUT, CONNECTION_LOST, UNKNOWN_ERROR b) The return codes between Activity and Buffer/Connector of OutPort PORT_OK, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL, BUFFER_TIMEOUT, UNKNOWN_ERROR,

(2) Pull Type a) The return codes between Activity and InPort PORT_OK, PORT_ERROR, RECV_EMPTY, RECV_TIMEOUT, CONNETION_LOST, UNKNOWN_ERROR

See function references for detailed return codes for each function.

Enumerator
PORT_OK 
PORT_ERROR 
BUFFER_ERROR 
BUFFER_FULL 
BUFFER_EMPTY 
BUFFER_TIMEOUT 
SEND_FULL 
SEND_TIMEOUT 
RECV_EMPTY 
RECV_TIMEOUT 
INVALID_ARGS 
PRECONDITION_NOT_MET 
CONNECTION_LOST 
UNKNOWN_ERROR 

Definition at line 143 of file DataPortStatus.h.

Member Function Documentation

◆ toString()

static const char* RTC::DataPortStatus::toString ( DataPortStatus::Enum  status)
inlinestatic

Convert DataPortStatus into the string.

Convert DataPortStatus into the string.

Parameters
statusThe target DataPortStatus for transformation
Returns
Trnasformation result of string representation

Definition at line 184 of file DataPortStatus.h.


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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Feb 28 2022 23:00:47