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

Improve the XtcePacketDefinition API #99

Open
medley56 opened this issue Oct 3, 2024 · 1 comment
Open

Improve the XtcePacketDefinition API #99

medley56 opened this issue Oct 3, 2024 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@medley56
Copy link
Owner

medley56 commented Oct 3, 2024

Context

The packet definition object represents the XTCE document but not all attributes are currently exposed. Users should be able to access all of the packet definition information via the packet definition properties.

Implementation Plan

  • Change named_parameters to parameter_set
  • Change named_containers to sequence_container_set
  • Improve the repr methods for Parameter, ParameterType, DataEncoding, and Calibrator so if the user accesses those properties, they are useful.
@medley56 medley56 added enhancement New feature or request good first issue Good for newcomers labels Oct 3, 2024
@greglucas
Copy link
Collaborator

Along a similar vein with working on this API: Is there a way to "know" the root container? Right now we have the user pass the root_container_name into the packet generator. I'm wondering if this means there can be multiple "roots"? Alternatively are we able to just detect that automatically for a user and start with the sequence container that is the root we found. Another option would be to have the root_container_name be passed to the XtcePacketDefinition constructor instead of the packet generator.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants