pyrtma.data_logger.dataset.Dataset

class Dataset(name, save_path, filename, formatter, subdivide_interval=0, msg_types=None, mm_ip='127.0.0.1:7111', status_interval=5.0, create_client=True)[source]

Bases: object

Methods

add

close

pause

Pause dataset recording in data_logger

poll

process_data_logger_config_msg

Process a data_logger config message

process_msg

register_client

Register a pyrtma client with this dataset :param client: client to register :type client: Client

remove

Remove dataset config from data_logger

request_data_logger_config

Request data_logger config

reset_data_logger

Reset data_logger (stop and remove all)

resume

Resume dataset recording in data_logger

start

Start dataset recording in data_logger

status_request

Request dataset status in data_logger

stop

Stop dataset recording in data_logger

unregister_client

Attributes

DATALOGGER_TYPES

added

elapsed_time

filename

formatter

is_paused

is_recording

msg_names

msg_types

name

removed

save_path

saved

started

stopped

subdivide_interval

Parameters:
  • name (str)

  • save_path (StrPath)

  • filename (str)

  • formatter (str)

  • subdivide_interval (int)

  • msg_types (List[int] | None)

  • mm_ip (str)

  • status_interval (float)

  • create_client (bool)

pause()[source]

Pause dataset recording in data_logger

Return type:

MDF_DATASET_PAUSE

static process_data_logger_config_msg(msg_data)[source]

Process a data_logger config message

Parameters:

msg_data (MDF_DATA_LOGGER_CONFIG) – unprocessed message data

Returns:

data_logger config dict

Return type:

Dict[str, Any]

register_client(client)[source]

Register a pyrtma client with this dataset :param client: client to register :type client: Client

Parameters:

client (Client)

remove()[source]

Remove dataset config from data_logger

Return type:

MDF_DATASET_REMOVE

request_data_logger_config()[source]

Request data_logger config

reset_data_logger()[source]

Reset data_logger (stop and remove all)

resume()[source]

Resume dataset recording in data_logger

Return type:

MDF_DATASET_RESUME

start()[source]

Start dataset recording in data_logger

Return type:

MDF_DATASET_START

status_request()[source]

Request dataset status in data_logger

Return type:

MDF_DATASET_STATUS_REQUEST

stop()[source]

Stop dataset recording in data_logger

Return type:

MDF_DATASET_STOP