yarp-devices
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
roboticslab::PdoTransmissionType Class Referencefinal

Wrapped enumeration of a PDO transmission type. More...

#include <PdoProtocol.hpp>

Public Types

enum  transmission_type : std::uint8_t {
  SYNCHRONOUS_ACYCLIC = 0x00 , SYNCHRONOUS_CYCLIC = 0x01 , RTR_SYNCHRONOUS = 0xFC , RTR_EVENT_DRIVEN = 0xFD ,
  EVENT_DRIVEN_MANUFACTURER = 0xFE , EVENT_DRIVEN_DEVICE_APP_PROFILE = 0xFF
}
 Wrapped enumerators. More...
 

Public Member Functions

constexpr PdoTransmissionType ()=default
 Default constructor.
 
constexpr PdoTransmissionType (transmission_type type)
 Constructor, accepts initial transmission type.
 
constexpr operator std::uint8_t () const
 User-defined conversion operator.
 

Static Public Member Functions

static constexpr PdoTransmissionType SYNCHRONOUS_CYCLIC_N (std::uint8_t n)
 Cast input byte to an PdoTransmissionType enumerator.
 
template<std::uint8_t n>
static constexpr PdoTransmissionType SYNCHRONOUS_CYCLIC_N ()
 Cast input byte to an PdoTransmissionType enumerator, performs static check on range [0x01-0xF0].
 

Private Attributes

transmission_type type = SYNCHRONOUS_ACYCLIC
 

Detailed Description

Inspired by this SO answer.

Member Enumeration Documentation

◆ transmission_type

Enumerator
SYNCHRONOUS_ACYCLIC 

Synchronous acyclic.

SYNCHRONOUS_CYCLIC 

Synchronous cyclic.

RTR_SYNCHRONOUS 

Synchronous RTR.

RTR_EVENT_DRIVEN 

Event-driven RTR.

EVENT_DRIVEN_MANUFACTURER 

Manufacturer-specific event-driven.

EVENT_DRIVEN_DEVICE_APP_PROFILE 

Device application profile-specific event-driven.


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