File: index.rst

package info (click to toggle)
odil 0.12.2-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 5,320 kB
  • sloc: cpp: 55,035; python: 3,971; javascript: 460; xml: 182; makefile: 98
file content (28 lines) | stat: -rw-r--r-- 1,028 bytes parent folder | download | duplicates (3)
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
C++ API
=======

The primary programming language of Odil is C++11: other languages (as :doc:`Python <../python/index>` or :doc:`Javascript <../javascript/index>`) are wrappers of the C++ code and try to mimic the C++ API. All classes, functions and variables of Odil are declared in the ``odil`` namespace. The include files reflect the classes: the ``odil::DataSet`` class will be declared in the ``odil/DataSet.h``. 

Odil can be included in another project using e.g.:

::

  find_package(Odil 0.12.0 REQUIRED)
  # Add targets, then for each target call
  target_link_libraries(... Odil::libodil)
  
Odil_DIR might need to be passed as cmake argument if odil was built from source and was not installed to the default location (CMAKE_INSTALL_PREFIX). For example ``cmake -DOdil_DIR=/opt/odil/install/lib/CMake/Odil``.

The full Doxygen reference is also `available`_.

.. toctree::
  :maxdepth: 2
  
  data_sets
  io
  association
  services-scu
  services-scp
  webservices

.. _available: ../../_static/doxygen/index.html