Skip to content

Commit

Permalink
Minor tweaks (#58)
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathan-r-thorpe authored Aug 4, 2023
1 parent 3d1861a commit f3ec965
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/Feature sets.md
Original file line number Diff line number Diff line change
@@ -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/).

Expand Down
8 changes: 4 additions & 4 deletions docs/Managers.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit f3ec965

Please sign in to comment.