Epok Engine

EPOK RUNTIME

epok::rail_prepare

Function · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Function

Performs `rail prepare` as part of the rail navigation module.

Belongs to
epok
Header
rail_navigation.hpp
Overloads
1

Declaration

Declaration
inline void rail_prepare(uint16_t sample,uint16_t route,bool crossing,bool forward)

Performs `rail prepare` as part of the rail navigation module.

ParameterTypeMeaning
sampleuint16_tNot documented; consult the linked header.
routeuint16_tNot documented; consult the linked header.
crossingboolNot documented; consult the linked header.
forwardboolNot documented; consult the linked header.

Returns: Nothing (void).

Example sketch

C++ example
#include "rail_navigation.hpp"

// Assume these named values have been initialized with valid data:
// uint16_t sample
// uint16_t route
// bool crossing
// bool forward

epok::rail_prepare(sample, route, crossing, forward);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/rail_navigation.hpp:24

Related members