documentation

This commit is contained in:
pb 2024-07-04 15:56:36 +02:00
parent a1f04dc2f0
commit b40879d8aa
4 changed files with 63 additions and 2 deletions

View File

@ -55,9 +55,9 @@ Deploy :
## Populating the MongoDB database ## Populating the MongoDB database
From the root of the projet run : On the machine running the mongoDB container, from the root of the project run this line :
`./scripts/multinode.sh ./scripts/demo.json` `./scripts/populate_models.sh ./scripts/demo.json`
This script should be updated to be ran from anywhere. This script should be updated to be ran from anywhere.

54
docs/UML/mxgraph.puml Normal file
View File

@ -0,0 +1,54 @@
@startuml mxgraph
package MxGraph {
class MxGraphModel {
- XMLName xml.Name
+ Root : RootStruct
+ createLinks()
}
class RootStruct {
- XMLName xml.Name
- MxCell[] MxCell
- MxObject[] MxObject
- MxLink[] MxLink
}
class MxCell {
- XMLName xml.Name
+ ID string
+ RID *string
+ Rtype string
+ Parent *string
+ Edge *string
+ Source *string
+ Target *string
+ processLinks()
}
class MxLink {
+ ID string
+ Source string
+ Target string
}
class MxObject {
- XMLName xml.Name
+ ID string
+ Settings []xml.Attr
+ MxCell MxCell
}
class mxissue {
- msg string
+ Error() string
}
MxGraphModel *-- RootStruct : Root
RootStruct *-- MxCell : MxCell
RootStruct *-- MxObject : MxObject
RootStruct *-- MxLink : MxLink
MxObject *-- MxCell : MxCell
}
@enduml

View File

@ -0,0 +1,2 @@
@startuml
@enduml

View File

@ -0,0 +1,5 @@
For an easier parsing and constrution of dependencies we decided that :
- Computing elements must be linked between one another, to represent the chaining of events
- A storage component can be shared by several computing component, the direction of the arrow will determine if it's for writting or reading