SMPTE / ris-osvp-metadata-camdkit

Implements the SMPTE RIS OSVP camera metadata model
BSD 3-Clause "New" or "Revised" License
40 stars 6 forks source link

Eliminate 'free' as modifier for strings #111

Closed JGoldstone closed 1 month ago

JGoldstone commented 1 month ago

There are only three strings whose values are constrained to match a pattern: a sampleId, a protocol version number and an FDL link. The current situation has 'free' as a modifier for CameraLabel, the name property of Protocol, Status, Slate and Notes. There are, however, many other properties based on StringParameter that are unencumbered by any convention: for all of cameras, lenses and 'devices', each has an unconstrained 'make', 'model', 'firmware' and 'serial number' property (12 in total), and then there is FDLLink,, making 13.

The suggested remedy eliminates 'free' and modifies the docstrings for constrained-string-containing properties as follows: SampleID: """URN serving as unique identifier of the sample in which data is being transported.""" Protocol (in validate()): """Protocol name is nonblank string; protocol version is basic x.y.z semantic versioning string"" FDLLink: """URN identifying the ASC Framing Decision List used by the camera."""