Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
dcc::Feedback Struct Reference

Structure used for reading (railcom) feedback data from DCC / Railcom device drivers. More...

#include <RailCom.hxx>

Inheritance diagram for dcc::Feedback:
DCCFeedback

Public Member Functions

void reset (uint32_t feedback_key)
 Clears the structure and sets the feedback key to a specific value.
 
void add_ch1_data (uint8_t data)
 Appends a byte to the channel 1 payload.
 
void add_ch2_data (uint8_t data)
 Appends a byte to the channel 2 payload.
 

Additional Inherited Members

- Public Attributes inherited from DCCFeedback
uint8_t ch1Size
 Number of bytes in channel one.
 
uint8_t ch1Data [2]
 Payload of channel 1.
 
uint8_t ch2Size
 Number of bytes in channel two.
 
uint8_t ch2Data [6]
 Payload of channel 2.
 
uint8_t channel
 Used by multi-channel railcom receiver drivers.
 
uintptr_t feedbackKey
 Opaque identifier that allows linking outgoing dcc::Packet sent to the DCC waveform generator to the incoming dcc::Feedback structure read back from the railcom driver.
 

Detailed Description

Structure used for reading (railcom) feedback data from DCC / Railcom device drivers.

Definition at line 49 of file RailCom.hxx.

Member Function Documentation

◆ add_ch1_data()

void dcc::Feedback::add_ch1_data ( uint8_t  data)
inline

Appends a byte to the channel 1 payload.

Definition at line 61 of file RailCom.hxx.

◆ add_ch2_data()

void dcc::Feedback::add_ch2_data ( uint8_t  data)
inline

Appends a byte to the channel 2 payload.

Definition at line 70 of file RailCom.hxx.

◆ reset()

void dcc::Feedback::reset ( uint32_t  feedback_key)
inline

Clears the structure and sets the feedback key to a specific value.

Definition at line 52 of file RailCom.hxx.


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