Uploaded image for project: 'Commissioning Activity Planning'
  1. Commissioning Activity Planning
  2. CAP-572

Add character escaping policy to descriptions of additionalValues attributes

    XMLWordPrintable

Details

    • Story
    • Status: Done
    • Major
    • Resolution: Done
    • None
    • ts_xml 6.1
    • None
    • None

    Description

      In all of the camera messages that contain the additionalValues attribute, text should be added that if the content contains a delimiter character, which is :, it will be escaped and look like \:.

      Attachments

        Issue Links

          Activity

            tjohnson Tony Johnson added a comment -

            Since this escaping policy will be common to all camera generated delimited strings (i.e. string arrays) it should be documented in one place and referenced in all descriptions. For the moment I am documenting it here.

            SAL does not support string arrays, so in place of this we typically use a single string with a well defined delimiter between strings. For camera we typically use : as the delimiter. This causes problems if the delimiter occurs in one of the values, so we have adopted the following convention:

            • If the delimiter occurs in a string value, it will be escaped with backslash (), e.g. \:
            • If a backslash () occurs in the string value, it will also be escaped with a backslash, e.g.

            Note: One shortcoming with this scheme is that there is no way to represent a zero length array, a single token or empty string is interpreted as a length one array.

            tjohnson Tony Johnson added a comment - Since this escaping policy will be common to all camera generated delimited strings (i.e. string arrays) it should be documented in one place and referenced in all descriptions. For the moment I am documenting it here. SAL does not support string arrays, so in place of this we typically use a single string with a well defined delimiter between strings. For camera we typically use : as the delimiter. This causes problems if the delimiter occurs in one of the values, so we have adopted the following convention: If the delimiter occurs in a string value, it will be escaped with backslash (), e.g. \: If a backslash () occurs in the string value, it will also be escaped with a backslash, e.g. Note: One shortcoming with this scheme is that there is no way to represent a zero length array, a single token or empty string is interpreted as a length one array.

            mareuter Did we decide to document the escaping convention in confluence somewhere, or should I just modify the XML description to refer to this JIRA?

            tjohnson Tony Johnson added a comment - mareuter Did we decide to document the escaping convention in confluence somewhere, or should I just modify the XML description to refer to this JIRA?

            Please reference this Jira for now. We'll try to find a more permanent place for this documentation.

            mareuter Michael Reuter added a comment - Please reference this Jira for now. We'll try to find a more permanent place for this documentation.

            People

              tjohnson Tony Johnson
              mareuter Michael Reuter
              Michael Reuter, Tony Johnson
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Jenkins

                  No builds found.