Is your feature request related to a problem? Please describe.
'OS_ObjectIdToArrayIndex is an external API:
|
/*-------------------------------------------------------------------------------------*/ |
|
/** |
|
* @brief Converts an abstract ID into a number suitable for use as an array index. |
|
* |
|
* This will return a unique zero-based integer number in the range of [0,MAX) for |
|
* any valid object ID. This may be used by application code as an array index |
|
* for indexing into local tables. |
|
* |
|
* This routine operates on a specific object type, and returns a value based on the |
|
* maximum number of objects for that type. |
|
* |
|
* If the idtype is passed as #OS_OBJECT_TYPE_UNDEFINED, then object type verification |
|
* is skipped and any object ID will be accepted and converted to an index. In this |
|
* mode, the range of the output depends on the actual passed-in object type. |
|
* |
|
* If the idtype is passed as any other value, the passed-in ID value is first |
|
* confirmed to be the correct type. This check will guarantee that the output |
|
* is within an expected range; for instance, if the type is passed as |
|
* #OS_OBJECT_TYPE_OS_TASK, then the output index is guaranteed to be between 0 and |
|
* #OS_MAX_TASKS-1 after successful conversion. |
|
* |
|
* @param[in] idtype The object type to convert |
|
* @param[in] object_id The object ID to operate on |
|
* @param[out] *ArrayIndex The Index to return |
|
* |
|
* @return Execution status, see @ref OSReturnCodes |
|
* @retval #OS_SUCCESS @copybrief OS_SUCCESS |
|
* @retval #OS_ERR_INCORRECT_OBJ_TYPE @copybrief OS_ERR_INCORRECT_OBJ_TYPE |
|
* */ |
|
int32 OS_ObjectIdToArrayIndex(osal_objtype_t idtype, osal_id_t object_id, osal_index_t *ArrayIndex); |
Yet internally there's a few style patterns and references that treat it like it's internal:
|
/*---------------------------------------------------------------- |
|
* |
|
* Function: OS_ObjectIdToArrayIndex |
|
* |
|
* Purpose: Convert an object ID (which must be of the given type) to a number suitable |
|
* for use as an array index. The array index will be in the range of: |
|
* 0 <= ArrayIndex < OS_MAX_<OBJTYPE> |
|
* |
|
* If the passed-in ID type is OS_OBJECT_TYPE_UNDEFINED, then any type |
|
* is allowed. |
|
* |
|
* returns: If the passed-in ID is not of the proper type, OS_ERROR is returned |
|
* Otherwise OS_SUCCESS is returned. |
|
* |
|
*-----------------------------------------------------------------*/ |
|
/* just pass to the generic internal conversion routine */ |
Note the implementation file itself has some inconsistencies:
|
* NOTE: The only exception is OS_ConvertToArrayIndex() as this is necessary to |
|
* assist applications when storing OSAL IDs in a table. |
|
/* |
|
********************************************************************************* |
|
* IDENTIFIER MAP / UNMAP FUNCTIONS |
|
********************************************************************************* |
|
*/ |
|
/*---------------------------------------------------------------- |
|
* |
|
* Function: OS_ObjectIdInit |
|
* |
|
* Purpose: Local helper routine, not part of OSAL API. |
|
* clears the entire table and brings it to a proper initial state |
|
* |
|
*-----------------------------------------------------------------*/ |
|
/************************************************************** |
|
* LOCAL HELPER FUNCTIONS |
|
* (not used outside of this unit) |
|
**************************************************************/ |
Describe the solution you'd like
Update comments, make sure headers are in the right place
Describe alternatives you've considered
None
Additional context
None
Requester Info
Jacob Hageman - NASA/GSFC
