From 3d1861a232a018d51a07f1830dcec157a9ba94d1 Mon Sep 17 00:00:00 2001 From: cristian-recoseanu <cristian.recoseanu@hotmail.com> Date: Fri, 4 Aug 2023 14:44:39 +0100 Subject: [PATCH] Clarifications (#57) * Update Managers.md To correct argument for GetControlClass * Update NcObject.md to add paragraph for GetSequenceLength * Update How does it work to help with clarity * Update docs/NcObject.md Co-authored-by: jonathan-r-thorpe <64410119+jonathan-r-thorpe@users.noreply.github.com> --------- Co-authored-by: jonathan-r-thorpe <64410119+jonathan-r-thorpe@users.noreply.github.com> --- README.md | 2 +- docs/Managers.md | 2 +- docs/NcObject.md | 3 +++ 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0abe5b8..14fe04a 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Sets out the rules and framework for building control models in NMOS devices. ### How does it work? -Web IDL definitions and supporting documentation describe the way control models may be created. +Model definitions and supporting documentation describe the way control models can be created. ### Other specifications in the suite diff --git a/docs/Managers.md b/docs/Managers.md index 287034a..aa5833f 100644 --- a/docs/Managers.md +++ b/docs/Managers.md @@ -38,7 +38,7 @@ 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) -The descriptor for an individual control class can be retrieved using the `GetControlClass` method (`[element("3m1")]`) and passing the identity (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)) as 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). diff --git a/docs/NcObject.md b/docs/NcObject.md index 60dfc31..b3d2680 100644 --- a/docs/NcObject.md +++ b/docs/NcObject.md @@ -52,6 +52,9 @@ The result is of type [NcMethodResultId](Framework.md#ncmethodresultid) which co Removing an item from a collection is done through the `RemoveSequenceItem` method (\[element("1m6")\]) by specifying the property identifier [NcPropertyId](Framework.md#ncpropertyid) and the index as arguments. The result is of type [NcMethodResult](Framework.md#ncmethodresult). +Checking the size of a collection is done through the `GetSequenceLength` method (\[element("1m7")\]) by specifying the property identifier [NcPropertyId](Framework.md#ncpropertyid) as an argument. +The result is of type [NcMethodResultLength](Framework.md#ncmethodresultlength). + ## Touchpoints Touchpoints represent the way in which a control model object may expose identity mappings across other contexts.