-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathPublicAPI_design.jl
More file actions
53 lines (28 loc) · 1.39 KB
/
PublicAPI_design.jl
File metadata and controls
53 lines (28 loc) · 1.39 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
### Public API - supported in all SDKs
# All funcitons should follow DistributedFactorGraphs.jl and we use Julia here to define the signitures.
# Other lanuages should follow DFG.jl/NvaSDK.jl as closely as possible with the following exceptions
# - labels are Symbols in julia and strings elsewhere.
# - mutation in julia is done with ! at the end of the function name and not in other languages.
# - notably C and Rust do not support function overloading and may also be different or more explicit and perhaps using adjectives.
## Structs
## Functions
### Singular `get`
getVariable(dfg::NavAbilityDFG, label::Symbol)
getFactor(dfg::NavAbilityDFG, label::Symbol)
getBlobentry(dfg::NavAbilityDFG, variableLabel::Symbol, label::Symbol)
getVariableBlobentry(dfg::NavAbilityDFG, variableLabel::Symbol, label::Symbol)
getFactorBlobentry(dfg::NavAbilityDFG, factorLabel::Symbol, label::Symbol)
getGraphBlobentry(dfg::NavAbilityDFG, label::Symbol)
getAgentBlobentry(dfg::NavAbilityDFG, label::Symbol)
getVariableState(dfg::NavAbilityDFG, variableLabel::Symbol, label::Symbol)
getFactorState(dfg::NavAbilityDFG, factorLabel::Symbol)
getBlob(store::NavAbilityBlobstore, blobId::UUID)
### Plural `get`
### Singular `add`
addBlob!(store::NavAbilityBlobstore, blobId::UUID, blob::Vector{UInt8})
### Plural `add`
### Singular `update`
### Plural `update`
### Singular `delete`
### Plural `delete`
### `list`