Struct Encoder

pub struct Encoder { /* private fields */ }

Trait Implementations

impl<'cl> CuSrcTask<'cl> for Encoder

type Output = &'cl mut CuMsg<EncoderPayload>

fn new(config: Option<&ComponentConfig>) -> CuResult<Self>

where Self: Sized,

Here you need to initialize everything your task will need for the duration of its lifetime. The config allows you to access the configuration of the task.

fn start(&mut self, clock: &RobotClock) -> CuResult<()>

Start is called between the creation of the task and the first call to pre/process.

fn process(&mut self, clock: &RobotClock, new_msg: Self::Output) -> CuResult<()>

Process is the most critical execution of the task. The goal will be to produce the output message as soon as possible. Use preprocess to prepare the task to make this method as short as possible.

fn stop(&mut self, _clock: &RobotClock) -> CuResult<()>

Called to stop the task. It signals that the *process method won’t be called until start is called again.

fn preprocess(&mut self, _clock: &RobotClock) -> Result<(), CuError>

This is a method called by the runtime before “process”. This is a kind of best effort, as soon as possible call to give a chance for the task to do some work before to prepare to make “process” as short as possible.

fn postprocess(&mut self, _clock: &RobotClock) -> Result<(), CuError>

This is a method called by the runtime after “process”. It is best effort a chance for the task to update some state after process is out of the way. It can be use for example to maintain statistics etc. that are not time-critical for the robot.

impl Freezable for Encoder

fn freeze<E>(&self, encoder: &mut E) -> Result<(), EncodeError>

where E: Encoder,

This method is called by the framework when it wants to save the task state. The default implementation is to encode nothing (stateless). If you have a state, you need to implement this method.

fn thaw<D>(&mut self, decoder: &mut D) -> Result<(), DecodeError>

where D: Decoder,

This method is called by the framework when it wants to restore the task to a specific state. Here it is similar to Decode but the framework will give you a new instance of the task (the new method will be called)