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

Review verbs for DFG v1.0 #1085

Open
5 tasks
Affie opened this issue Jul 11, 2024 · 1 comment
Open
5 tasks

Review verbs for DFG v1.0 #1085

Affie opened this issue Jul 11, 2024 · 1 comment

Comments

@Affie
Copy link
Member

Affie commented Jul 11, 2024

Verbs here: https://github.com/JuliaRobotics/DistributedFactorGraphs.jl/wiki/Standard-Definitions-of-API-via-verbs-and-set-theory
With regard to:

  • Signature
  • Return Type
  • Error Behaviour

Verbs:

  • list
  • get
  • add
  • update
  • delete

TODO add all verbs for DFG v1.0

@Affie Affie added this to the v1.0.0 milestone Jul 11, 2024
@Affie
Copy link
Member Author

Affie commented Aug 28, 2024

list
Synchronously list the labels of an existing (composite) data container/object with optional filters.
- Regex filter on label
- Filter on Solvable
- Filter on Tags (tag in variable.tags)

  • Synchronous
  • Example nouns Variables, Factors, VariableNodeData, PPE -> Vector{Symbol}
  • Returns empty list if the container exists but empty
  • Throw typed Exeption KeyError or custom exeption if the container does not exist.

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

No branches or pull requests

1 participant