search

SamCooper / COMMON_SPEC_RIDS

1 stars 0 forks source link

Improvement suggestion on COM Objects and COM Events #55

Closed CesarCoelho closed 7 years ago

CesarCoelho commented 7 years ago

There are two separate suggestions.

  1. Change the alignment of the representation on the COM Objects and COM Events. Example: From: A ServiceProvider object represents a service provider. The COM object body shall hold the service provider name. The ServiceProvider COM object related link shall not be used and therefore set to NULL. The ServiceProvider COM object source link shall not be used and therefore set to NULL. A ProviderCapabilities object represents the supported capabilities of a service provider. The COM object body shall hold the provider details of the service provider. The ProviderCapabilities COM object related link shall indicate which ServiceProvider COM object it links to. The ProviderCapabilities COM object source link shall not be used and therefore set to NULL. ServiceProvider and ProviderCapabilities objects shall be created by the publishService operation. The object instance identifier for the ServiceProvider and ProviderCapabilities objects shall be populated by the provider of the directory service. For the AddressDetails of a particular ProviderCapabilities object, if the brokerProviderObjInstId field contains a value and the brokerURI field is NULL, then the brokerURI value of the referenced provider shall be used.

To: A ServiceProvider object represents a service provider. The COM object body shall hold the service provider name.

  1. The ServiceProvider COM object related link shall not be used and therefore set to NULL.
  2. The ServiceProvider COM object source link shall not be used and therefore set to NULL.

A ProviderCapabilities object represents the supported capabilities of a service provider. The COM object body shall hold the provider details of the service provider.

  1. The ProviderCapabilities COM object related link shall indicate which ServiceProvider COM object it links to.
  2. The ProviderCapabilities COM object related link shall indicate which ServiceProvider COM object it links to.
  3. The ProviderCapabilities COM object source link shall not be used and therefore set to NULL. ServiceProvider and ProviderCapabilities objects shall be created by the publishService operation.

....

  1. One can follow the guidelines presented here: https://docs.google.com/document/d/1pDTS2Ff8X8Cjb0DnzXFYjRU2DDtHRxXOifT2JOQQNZA/edit

The services are almost all aligned with it already. Most likely, it won't take much effort to complete it.

SamCooper commented 7 years ago

I agree with your formatting suggestion but it is not within CCSDS document guidelines therefore we won't get it past Tom.