Commit eef220d9 authored by legoc's avatar legoc
Browse files

Continuing with doc

parent 0caedc6b
Pipeline #327 skipped
......@@ -2,7 +2,7 @@ Introduction
------------
The LstDataProcess library provides tools to read, write and process Lst binary files produced at the ILL.
Read The [User's Guide](doc/UsersGuide.md)
Read the [User's Guide](doc/UsersGuide.md)
Installation
------------
......
Introduction
------------
The User's Guide provides essential information on how to use the library.
\ No newline at end of file
The User's Guide provides essential information on how to use the library.
To access the library API you should include:
#include <lstdpp128/lstdpp.h>
Open a File
-----------
First of all, you have to open a file.
// Initialize a reader with a buffer of size 4096.
Reader reader(4096);
// Open the file.
bool success = reader.open(fileName);
// Exit in case of error.
if (!success) {
return EXIT_FAILURE;
}
// Print the list mode context.
cout << listModeContext << endl;
The *listModeContext* object contains the context of the loaded file. It represents the configuration of the electronic cards.
The model is the following:
* The context contains a Crateboard
* A Crateboard contains some Boards
* A Board contains some Channels
The structures are:
* Board
Members|Type
------------
eventType|uint16_t
crate|uint8_t
nbChannels|uint16_t
boardType|BoardType
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment