Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TblName not processor specific (comment clarification) #1507

Closed
skliper opened this issue May 12, 2021 · 0 comments · Fixed by #1558 or #1584
Closed

TblName not processor specific (comment clarification) #1507

skliper opened this issue May 12, 2021 · 0 comments · Fixed by #1558 or #1584
Assignees
Labels
cFE-TBL Table services docs This change only affects documentation. enhancement
Milestone

Comments

@skliper
Copy link
Contributor

skliper commented May 12, 2021

Is your feature request related to a problem? Please describe.
Multiple locations refer to TblName as "processor specific", which doesn't make sense since it's just AppName.TableName. Even if the table is processor specific, it should likely have a non-processor specific name such that apps are portable.

Examples:

/* Modify specified name to be processor specific name */
/* of the form "AppName.TableName" */
CFE_TBL_FormTableName(TblName, Name, ThisAppId);

** \param[in] Name The application-specific name. This name will be combined with the name of the
** application to produce a processor specific name of the form
** "ApplicationName.TableName". The processor specific name will be used in commands
** for modifying or viewing the contents of the table.

** \param[in] TblName The processor specific name of the table. It is important to note
** that the processor specific table name is different from the table
** name specified in the #CFE_TBL_Register API call. The processor
** specific table name includes the name of the application that created
** the table. The name would be of the form "ApplicationName.TableName".
** An example of this would be "ACS.TamParams" for a table called "TamParams"
** that was registered by the application called "ACS".

** \param[in] TblName The processor specific name of the table. It is important to note
** that the processor specific table name is different from the table
** name specified in the #CFE_TBL_Register API call. The processor
** specific table name includes the name of the application that created
** the table. The name would be of the form "ApplicationName.TableName".
** An example of this would be "ACS.TamParams" for a table called "TamParams"
** that was registered by the application called "ACS".

/* Complete formation of processor specific table name */

** \par Description
** Takes a given Table Name and combines it with the calling
** Application's name to make a processor specific name of the
** form: "AppName.TblName"
**
** \par Assumptions, External Events, and Notes:
** Note: AppName portion will be truncated to OS_MAX_API_NAME.
**
** \param[in, out] FullTblName pointer to character buffer of #CFE_TBL_MAX_FULL_NAME_LEN size that will be filled with
** the processor specific Table Name. *FullTblName is the processor specific Table Name of the form
** "AppName.TblName".

Note TblName is described as ApplicationName.TableName which is somewhat circular, but this could be addressed as part of #1412 (similar to #1401). Suggestions - FullName, QualifiedName, ResourceName...

Describe the solution you'd like
Remove processor specific language

Describe alternatives you've considered
None

Additional context
#1401 is similar wrt CDS names
#1412 is a general issue related to resource naming

Requester Info
Jacob Hageman - NASA/GSFC

@skliper skliper added the docs This change only affects documentation. label May 12, 2021
@skliper skliper added this to the 7.0.0 milestone May 12, 2021
@skliper skliper self-assigned this May 20, 2021
skliper added a commit to skliper/cFE that referenced this issue May 20, 2021
astrogeco added a commit that referenced this issue May 27, 2021
@astrogeco astrogeco added enhancement cFE-TBL Table services labels May 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cFE-TBL Table services docs This change only affects documentation. enhancement
Projects
None yet
2 participants