next

doc/UsersGuide.md

@@ -34,16 +34,57 @@ The model is the following:
 * A Crateboard contains some Boards
 * A Board contains some Channels
 
-The structures are:
-* Board
+The _Board_ structure is:
 
-Members | Type
---------|-----
+**Members** | **Type** 
+------------|---------
 eventType | uint16_t
 crate | uint8_t
 nbChannels | uint16_t
 boardType | BoardType
 
+The _BoardType_ type has the following values:
+
+**Constant** | **Value**
+-------------|---------- 
+CFD_BOARD_TYPE | 0
+V1751_BOARD_TYPE | 1
+V1724_BOARD_TYPE | 2
+V1730_BOARD_TYPE | 3
+
+The _Crate_ structure is:
+
+**Members** | **Type** 
+------------|---------
+nbBoards | uint16_t
+boards | Board*
+
+The _boards_ pointer is the address of the array containing _nbBoards_ _Board_ objects.
+
+The _CrateBoard_ structure is:
+
+**Members** | **Type** 
+------------|---------
+nbCrates | uint16_t
+crates | Crate*
+
+The _crates_ pointer is the address of the array containing _nbCrates_ _Crate_ objects.
+
+The global *listModeContext* object of type _ListModeContext_ has the structure:
+
+**Members** | **Type** 
+------------|---------
+version | uint32_t
+timeBase | uint32_t
+nbEvents | uint32_t
+crateBoard | CrateBoard
+
+The _version_ member represents the version of the format of the file. The _timeBase_ is the unit of time of the events. The value 9 means that the time base is 10^-9.
+
+
+
+
+