From f3ec96574b41a2d5971bd300259b800cd60d6167 Mon Sep 17 00:00:00 2001 From: jonathan-r-thorpe <64410119+jonathan-r-thorpe@users.noreply.github.com> Date: Fri, 4 Aug 2023 18:06:14 +0100 Subject: [PATCH] Minor tweaks (#58) --- docs/Feature sets.md | 2 +- docs/Managers.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/Feature sets.md b/docs/Feature sets.md index c2d7122..e20d8d3 100644 --- a/docs/Feature sets.md +++ b/docs/Feature sets.md @@ -1,6 +1,6 @@ # Feature sets -Feature sets are models (classes and datatypes) required for a specific functionality devices expose. +Feature sets are models (classes and datatypes) required for devices to expose specific functionality. Feature sets are defined in the [Control feature sets register](https://specs.amwa.tv/nmos-control-feature-sets/). diff --git a/docs/Managers.md b/docs/Managers.md index aa5833f..11873c1 100644 --- a/docs/Managers.md +++ b/docs/Managers.md @@ -35,12 +35,12 @@ A minimal device implementation MUST have a class manager in the root block. The manager has two properties: -* controlClasses (lists all class descriptors in the device using the [NcClassDescriptor](Framework.md#ncclassdescriptor) type - descriptors do not contain inherited elements) -* datatypes (lists all data type descriptors in the device using the [NcDatatypeDescriptor](Framework.md#ncdatatypedescriptor) type - descriptors do not contain inherited elements) +* controlClasses (lists all class descriptors in the device using the [NcClassDescriptor](Framework.md#ncclassdescriptor) type - descriptors MUST NOT contain inherited elements) +* datatypes (lists all data type descriptors in the device using the [NcDatatypeDescriptor](Framework.md#ncdatatypedescriptor) type - descriptors MUST NOT contain inherited elements) -The descriptor for an individual control class can be retrieved using the `GetControlClass` method (`[element("3m1")]`) and passing the classId (type [NcClassId](Framework.md#ncclassid)) and includeInherited (if all inherited elements should be included - type [NcBoolean](Framework.md#primitives)) as arguments. The method has a response of type [NcMethodResultClassDescriptor](Framework.md#ncmethodresultclassdescriptor). +The descriptor for an individual control class can be retrieved using the `GetControlClass` method (`[element("3m1")]`) and passing the `classId` (type [NcClassId](Framework.md#ncclassid)) and `includeInherited` (if all inherited elements should be included - type [NcBoolean](Framework.md#primitives)) arguments. The method has a response of type [NcMethodResultClassDescriptor](Framework.md#ncmethodresultclassdescriptor). -The descriptor for an individual data type can be retrieved using the `GetDatatype` method (`[element("3m2")]`) and passing the name (type [NcName](Framework.md#ncname)) and includeInherited (if all inherited elements should be included - type [NcBoolean](Framework.md#primitives)) as arguments. The method has a response of type [NcMethodResultDatatypeDescriptor](Framework.md#ncmethodresultdatatypedescriptor). +The descriptor for an individual data type can be retrieved using the `GetDatatype` method (`[element("3m2")]`) and passing the `name` (type [NcName](Framework.md#ncname)) and `includeInherited` (if all inherited elements should be included - type [NcBoolean](Framework.md#primitives)) arguments. The method has a response of type [NcMethodResultDatatypeDescriptor](Framework.md#ncmethodresultdatatypedescriptor). Where the device model instantiates a control class, its class descriptor MUST be made available through the properties and methods defined in the class manager. Control class descriptors MUST correctly reflect any properties which have an immutable `readonly` state.