summaryrefslogtreecommitdiff
path: root/interfaces/distrio_manager.idl
blob: f4ae80f0c1a6a2c1a1f1ccfc56abdd8b9411ae2c (plain)
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
46
47
48
49
50
51
#ifndef DISTRDistrio_CONTROLLER_IDL
#define DISTRDistrio_CONTROLLER_IDL

#include "distrio_common.idl"
#include "distrio_io.idl"

/**
 * @brief logical view of IO's and Devices (not HW specific)
 *
 * @author Manuel Traut <manut@mecka.net>
 * @copyright GPLv2
 */

module Distrio {

/**
 * @brief manage io/device lists, error handling
 *
 * - all modules need to register their IO's and devices
 * - registered IO's and devices can be obtained
 */
	interface Manager {
		/** returns list of registered digital IO's */
		Distrio::Error digital (out Distrio::Digital_list io_list);
		/** returns list of registered analog IO's */
		Distrio::Error analog (out Distrio::Analog_list io_list);
		/** returns list of registered devices */
		Distrio::Error device (out Distrio::Device_list dev_list);
		/** register a digital io */
		Distrio::Error register_io_digital (inout Distrio::Digital io_dig);
		/** register a analog io */
		Distrio::Error register_io_analog (inout Distrio::Analog io_ana);
		/** register a device */
		Distrio::Error register_io_device (inout Distrio::Device io_dev);
		/** unregister a digital io */
		Distrio::Error unregister_io_digital (in Distrio::Digital io_dig);
		/** unregister a analog io */
		Distrio::Error unregister_io_analog (in Distrio::Analog io_ana);
		/** unregister a device */
		Distrio::Error unregister_io_device (in Distrio::Device io_dev);
		/** used by modules to send errors to a central point
		 *   The implementation of this function could:
		 *    - thispatch errors to a GUI
		 *    - log the errors e.g. with log4*
		 */
		void log_error (in Distrio::Error error);
	};

};

#endif