source: PSPA/madxPSPA/src/mad_api.h @ 430

Last change on this file since 430 was 430, checked in by touze, 11 years ago

import madx-5.01.00

File size: 1.1 KB
Line 
1#ifndef MAD_API_H
2#define MAD_API_H
3
4/**
5 * @file mad_api.h Calls to use for external libraries
6 *
7 * This is a header that can be included in external libraries that wants to
8 * link against the mad-x library. It was mostly needed because
9 * we did not have clean headers before.
10 *
11 * Since that has now changed, have a look instead at the functions
12 * madx_start() and madx_finish() in mad_core.h,
13 * and pro_input() in mad_eval.h. Those provide everything
14 * you need for a basic interface.
15 *
16 * @author Yngve Inntjore Levinsen
17 */
18
19// types
20
21struct sequence_list;
22
23// variables
24
25extern struct sequence_list* sequences;
26
27/**
28 * @brief Get list of available sequences
29 *
30 * This function is part of the madextern external functions.
31 * These are not supposed to be used by any internal mad-x code.
32 *
33 * This function returns a name_list structure of all currently
34 *  available sequences. Reason we do not return sequence_list
35 *  is that name_list are "cleaner" structures which are easier
36 *  to access in python (currently only use-case).
37 *
38 */
39struct sequence_list* madextern_get_sequence_list(void);
40
41#endif // MAD_API_H
42
Note: See TracBrowser for help on using the repository browser.