File: README.md

package info (click to toggle)
sight 25.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 42,180 kB
  • sloc: cpp: 289,476; xml: 17,257; ansic: 9,878; python: 1,379; sh: 144; makefile: 33
file content (45 lines) | stat: -rw-r--r-- 1,639 bytes parent folder | download | duplicates (2)
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
# sight::activity

This is one of the most important library in _Sight_. It allows to build, to configure, and to launch _activities_:

- **Builder**: contains the base interface for the data Activity builder.
- **Extension**:
- **Validator**: contains the classes defining validators checking properties and requirements.

## Classes

### Activity builders

- **Activity**: defines the default builder for the data Activity.

### Activity interfaces

- **launcher**: defines the interface for services that launches Activity instances.
- **sequencer**: defines the interface for services that creates Activity instances sequentially.
- **builder**: defines the interface for all activity builder's classes.

### Validators

- **base**: defines the interface for all activity validator's classes.
- **activity**: defines the interface for all activity validator's classes.
- **object**: defines the interface for all activity data validator's classes.
- **default_activity**: defines a validator which checks that activity requirements are valid.
- **image_properties**: defines a validator which checks that properties of given images are the same.
- **related_study**: defines a validator which checks that given series refer to the same study.

### Other

- **message**: defines Activity information sent by signal to launch new activities in a tab.

## How to use it

### CMake

```cmake
target_link_libraries(my_target <PUBLIC|PRIVATE> activity)
```

### XML

Please read the dedicated [Activities](https://sight.pages.ircad.fr/sight-doc/SAD/src/Activities.html) page on
[Sight documentation](https://sight.pages.ircad.fr/sight-doc).