From a4fd32648599b9d7b72f76da5ffdf4c973f346c7 Mon Sep 17 00:00:00 2001 From: Benjamin Erb Date: Tue, 25 Jun 2024 23:33:02 +0200 Subject: [PATCH] cleanup Readme --- README.md | 33 --------------------------------- 1 file changed, 33 deletions(-) diff --git a/README.md b/README.md index 4e9c28d..1b968a6 100644 --- a/README.md +++ b/README.md @@ -2,36 +2,3 @@ Interface for defining TLEE/TAF interface. -## Implementing the Interfaces - -As Go interfaces are implemented implicitly, the following steps would be necessary to get the interface running: - -Add this module to the project in which the TLEE is implemented. Given the fact that the module is not published under its name, you can do so by checking out this repository next to the tlee-implementation: - -``` -. -├── tlee-implementation -└── tlee-interface -``` - -Then, use the following code in the `go.mod` file of your tlee-implementation project: -``` -replace ( - github.com/vs-uulm/taf-tlee-interface => ../tlee-interface -) -``` - -This will now allow you to access the packages `tleeinterface` and `trustmodelstructure` from within your code. - -Next, you need to add functions to your structs so they will implicitly implement the interfaces. -This will probably include the following: - -| Generic Interface in tlee-interface | Struct in tlee-implementation | -|----------------------------------------------------------------| -- | -| `trustmodelstructure.TrustGraphStructure` | `StructureGraphTAFMultipleProp` | -| `trustmodelstructure.AdjacencyListEntry` | `VertexEdgeDTO` | -| `trustmodelstructure.TrustRelationship` | `OpinionDTO` | -| `subjectivelogic.QueryableOpinion` from [go-subjectivelogic](https://github.com/vs-uulm/go-subjectivelogic/blob/0eed3084529279af0be08f5bc0de270f3028ae7b/pkg/subjectivelogic/Opinion.go#L44) | `OpinionDTOValue` | - -Furthermore, you will need to adapt your code to handle the input parameters that it will no longer by the structs on the right side that are used, but rather the interfaces from left side. -Alternatively, you can implement some wrapper code that converts the interface-typed inputs into your own internal DTOs at the beginning of the `RunTLEE()` implementation. \ No newline at end of file