• Table of contents
• DCOD
  • Launch your own DCOD
  • DCOD Internal Interfaces
    • DCOD Dev
• Documentation
  • Code documentation
    • Package documentation
    • Function documentation

DCOD¶

DCOD stands for Distributed Caen-Orsay DAQ.
DCOD provides high level DAQ services:

• Basic functionnalities
  • Launcher
  • Posix Memory Handler (PMH) + use case
  • Common Transport Layer (CTL)
• Logic Tier
  • ENX : https://forge.in2p3.fr/projects/enx/wiki
  • Narval : https://forge.in2p3.fr/projects/narval/wiki

Launch your own DCOD¶

if you want to launch a dcod example (DCOD + Narval)

DCOD Internal Interfaces¶

• Auto generated documentation

These links present object template interfaces used to communicate in DCOD framework.

1. DCOD Services
2. DCOD Object
3. DCOD Posix Memory Handler
4. Diagrams

DCOD Dev¶

1. Mercurial Configuration
2. DCOD Download
3. DCOD Ada Programming Style

Documentation¶

Code documentation¶

All ada code should follow simple format to ease automatic documentation generation. The format is based on javadoc idea and use simple inside commentary blocks.

Package documentation¶

The first lines of each package should contain information about the functionnalitries in this package and could have the following tags :

• @version Version_Number : version number of the package in the format Major.Minor.Modif_Number

Function documentation¶

The used tags are :

• @param param_name : for each method / function / ....
• @return : for function only
• @exception Exception_Name : the exception thrown by the method / function

Example :

-- This function print an "Hello World" 
-- very nicely
-- @param Name : Name of the people to bounce
-- @return : returns value define if the display was graphical (0) or just textual (1)
-- @exception Unknown_People : Thrown if the name is not known in teh database
function Hello_World (Name : String) return Integer;