object_id.h File Reference

#include <stdint.h>

Include dependency graph for object_id.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef int32_t	ecu_object_id_t
	Object ID type. Used so the library can implicitly typecast between this value, ecu_reserved_object_ids, and user-defined object ID enumerations. More...

Enumerations
enum	ecu_reserved_object_ids { ECU_OBJECT_ID_RESERVED = -2, ECU_VALID_OBJECT_ID_BEGIN = -1, ECU_OBJECT_ID_UNUSED = ECU_VALID_OBJECT_ID_BEGIN, ECU_USER_OBJECT_ID_BEGIN = 0 }
	Object IDs reserved for ECU library. This scheme allows the library and users to uniquely define their own object IDs without conflicts. Object IDs reserved for ECU library will always be negative. Object IDs the user defines will start at 0 which is always ECU_USER_OBJECT_ID_BEGIN. More...

Detailed Description

See object_id.h section in Sphinx documentation.

Author

Ian Ress

Version

0.1

Date

2024-04-07

Copyright

Copyright (c) 2024

Typedef Documentation

ecu_object_id_t

typedef int32_t ecu_object_id_t

Object ID type. Used so the library can implicitly typecast between this value, ecu_reserved_object_ids, and user-defined object ID enumerations.

Warning

This must be a signed integer type in order to handle ecu_reserved_object_ids enumerations less than 0. A compilation error will occur if this is declared as an unsigned type.

Enumeration Type Documentation

ecu_reserved_object_ids

enum ecu_reserved_object_ids

Object IDs reserved for ECU library. This scheme allows the library and users to uniquely define their own object IDs without conflicts. Object IDs reserved for ECU library will always be negative. Object IDs the user defines will start at 0 which is always ECU_USER_OBJECT_ID_BEGIN.

Enumerator
ECU_OBJECT_ID_RESERVED	PRIVATE. FOR LIBRARY USE ONLY.
ECU_VALID_OBJECT_ID_BEGIN	PRIVATE. FOR LIBRARY USE ONLY. Start of reserved IDs that the user can assign to objects.
ECU_OBJECT_ID_UNUSED	Reserved ID. Signifies that object ID mechanism is not used.
ECU_USER_OBJECT_ID_BEGIN	0. Start of user-defined IDs. Must always be 0 for future compatibility.