Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-31029

IDL metadata issues: missing topic description and missing xID units

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: ts_middleware
    • Labels:
    • Story Points:
      1
    • Epic Link:
    • Sprint:
      TSSW Sprint - Aug 16 - Aug 30
    • Team:
      Telescope and Site
    • Urgent?:
      No

      Description

      In implementing DM-31017 I found a few minor issues with metadata in the IDL files:

      1) The Description metadata for each topic is an empty string.

      This is true not only for generic topics (for which it would be nice to have useful descriptions), but also for topics in the XML that I know have description strings.

      Here is an example from the XML. The following in Test_Commands.xml:

      <EFDB_Topic>Test_command_setArrays</EFDB_Topic>
      <Description>Set array values.</Description>
      

      translates to the following in sal_revCoded_Test.idl (this includes a few extra lines to illustrate the next point):

      struct command_setArrays_0dd79125 {  // @Metadata=(Description="")
      	  long	TestID;	//private // @Metadata=(Description="Index number for CSC with multiple instances")
      	  string<8>	private_revCode; //private // @Metadata=(Units="unitless",Description="Revision code of topic")
      

      2) There is no Units field for the metadata of the xID field.

      See the example just above. It should be Units="unitless", as in the private_revCode field shown.

        Attachments

          Issue Links

            Activity

            Hide
            dmills Dave Mills added a comment -

            Fixed in PR #136, See attached idl

            Show
            dmills Dave Mills added a comment - Fixed in PR #136, See attached idl
            Hide
            rbovill Rob Bovill added a comment -

            The issues with the IDL metadata are fixed.

            Show
            rbovill Rob Bovill added a comment - The issues with the IDL metadata are fixed.

              People

              Assignee:
              dmills Dave Mills
              Reporter:
              rowen Russell Owen
              Reviewers:
              Rob Bovill
              Watchers:
              Dave Mills, Rob Bovill, Russell Owen
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.