io.native_readers API#

This page documents the io.native_readers package.

Functions#

Function Reference#

get_motor_measurement_csv_structure#

HydraForge_Windows11.io.native_readers.get_motor_measurement_csv_structure()[source]#

Return the column schema for motor measurement ASCII CSV files.

This structure defines the exact contract expected by the native CSV readers. Each entry describes how a column should be interpreted when parsing the file at native speed.

Column specification format#

Each column is defined as a list with three elements:

[column_name, is_string, skip]

where:

  • column_name : str Name of the output field as exposed to Python. This will become a key in the returned dictionary from the native reader.

  • is_string : bool Whether the column should be interpreted as a string. Numerical columns must set this to False.

  • skip : bool Whether the column should be skipped entirely during parsing. This allows the native reader to efficiently ignore unused columns without modifying the file format.

Notes

  • All numerical values are returned as float64 NumPy arrays.

  • Column order must match the order in the CSV file.

  • Header handling is controlled separately by the reader call.

  • This structure is intentionally explicit to avoid ambiguity and silent parsing errors.

returns:

A list of column specifications defining the native CSV schema.

rtype:

list[list]

Examples

>>> structure = get_motor_measurement_csv_structure()
>>> name, is_string, skip = structure[0]
>>> name
'u_q'

See also

read_ascii_csv, read_ascii_csv_mt

On this page