read_sage_structure_payload

ezga_lib_class.read_sage_structure_payload(structure_id=None, agent_id=None, row_index=None)

Read optional SAGE structure fields by row index or structure ID.

Parameters:

  • structure_id (int, optional) – Identifier of the structure. Default: None.

  • agent_id (int, optional) – EZGA agent identifier; None includes all agents in list queries. Default: None.

  • row_index (int, optional) – Zero-based table row index; when supplied to a reader, takes precedence over identifier lookup. Default: None.

Returns:

EzgaSageStructurePayload or None – Decoded payload view, or None when absent.

Raises:

ValueError – Neither row_index nor structure_id is supplied for a nonempty table.