Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename Object to Description #192

Open
emiltin opened this issue Nov 12, 2024 · 1 comment
Open

rename Object to Description #192

emiltin opened this issue Nov 12, 2024 · 1 comment
Labels

Comments

@emiltin
Copy link
Contributor

emiltin commented Nov 12, 2024

Currently RSMP object have ObjectType (e.g ”Detector logic”), Object (e.g. ”A120-1”) and component-id (e.g. A+48281=482DL001).

Only the component id is used to reference objects in messages.

It seems to me Object is not an id, but rather a description of the object. Therefore i suggest we rename this to Description, and don't have any requirement about uniqueness. It would be good to be able to fetch the list of component from a device, and this should include the description.

It also implies that list of components should always use the component id as key, not the Object/Description.

@otterdahl
Copy link
Contributor

It seems to me Object is not an id, but rather a description of the object. Therefore i suggest we rename this to Description, and don't have any requirement about uniqueness. It would be good to be able to fetch the list of component from a device, and this should include the description.

In the SXL, each ObjectType defines a list the alarms, command and statuses. The Objects are then mapped to a specific ObjectType. I suppose we could rename Object to description, but I think it would make this relationship slightly less obvious.

Another option is to rename ObjectType => ComponentType and Object => Component

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants