NoRailcomDriver Class Reference

Empty implementation of the railcom driver for boards that have no railcom hardware. More...

#include <RailcomDriver.hxx>

Inheritance diagram for NoRailcomDriver:

Private Member Functions
void	feedback_sample () OVERRIDE
	Call to the driver for sampling the current sensors.
void	start_cutout () OVERRIDE
	Instructs the driver that the railcom cutout is starting now.
void	middle_cutout () OVERRIDE
	Notifies the driver that the railcom cutout has reached the middle point, i.e., the first window is passed and the second window is starting.
void	end_cutout () OVERRIDE
	Instructs the driver that the railcom cutout is over now.
void	no_cutout () OVERRIDE
	Called instead of start/mid/end-cutout at the end of the current packet if there was no cutout requested.
void	set_feedback_key (uint32_t key) OVERRIDE
	Specifies the feedback key to write into the received railcom data packets.

Additional Inherited Members
Public Member Functions inherited from RailcomDriver
virtual void	send_ch1 (const DCCFeedback *ch1_pkt)
	Specifies what packet should be sent for the channel1 cutout.
virtual void	send_ch2 (const DCCFeedback *ch2_pkt)
	Specifies what packet should be sent for the channel2 cutout.

Detailed Description

Empty implementation of the railcom driver for boards that have no railcom hardware.

Definition at line 100 of file RailcomDriver.hxx.

Member Function Documentation

end_cutout()

void NoRailcomDriver::end_cutout ( )

inlineprivatevirtual

Instructs the driver that the railcom cutout is over now.

The driver will use this information to disable the UART receiver.

Implements RailcomDriver.

Definition at line 104 of file RailcomDriver.hxx.

feedback_sample()

void NoRailcomDriver::feedback_sample ( )

inlineprivatevirtual

Call to the driver for sampling the current sensors.

This call is performed repeatedly, in a configurable interval, on the next positive edge.

Implements RailcomDriver.

Definition at line 101 of file RailcomDriver.hxx.

middle_cutout()

void NoRailcomDriver::middle_cutout ( )

inlineprivatevirtual

Notifies the driver that the railcom cutout has reached the middle point, i.e., the first window is passed and the second window is starting.

The driver will use this information to separate channel 1 nd channel 2 data.

Implements RailcomDriver.

Definition at line 103 of file RailcomDriver.hxx.

no_cutout()

void NoRailcomDriver::no_cutout ( )

inlineprivatevirtual

Called instead of start/mid/end-cutout at the end of the current packet if there was no cutout requested.

Implements RailcomDriver.

Definition at line 105 of file RailcomDriver.hxx.

set_feedback_key()

void NoRailcomDriver::set_feedback_key ( uint32_t  key )

inlineprivatevirtual

Specifies the feedback key to write into the received railcom data packets.

This feedback key is used by the application layer to correlate the stream of DCC packets to the stream of Railcom packets. This method shall be called before start_cutout. The feedback key set here is used until this method is called again.

Parameters

key	is the new feedback key.

Implements RailcomDriver.

Definition at line 106 of file RailcomDriver.hxx.

start_cutout()

void NoRailcomDriver::start_cutout ( )

inlineprivatevirtual

Instructs the driver that the railcom cutout is starting now.

The driver will use this information to enable the UART receiver.

Implements RailcomDriver.

Definition at line 102 of file RailcomDriver.hxx.

---

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

• RailcomDriver.hxx