neclib.recorders.writer_base#

class Writer(*args, **kwargs)[source]#

Bases: ABC

abstract start_recording(record_dir)[source]#
Parameters:

record_dir (Path) –

Return type:

None

abstract append(*args, **kwargs)[source]#

Append a chunk of data.

Returns:

Whether the data is handled by this writer.

Return type:

handled

Parameters:

  • args (Any) –

  • kwargs (Any) –

Notes

The subclass should check the input type, as Writer would handle some essentially different data, and Recorder won’t implement the type checking for extensibility.

abstract stop_recording()[source]#
Return type:

None