0fea03e587d7501f01408215e48d258dc92dfb00
[scilab.git] / scilab / modules / output_stream / src / cpp / diary_manager.hxx
1 /*
2 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3 * Copyright (C) 2009 - DIGITEO - Allan CORNET
4
5 * This file must be used under the terms of the CeCILL.
6 * This source file is licensed as described in the file COPYING, which
7 * you should have received as part of this distribution.  The terms
8 * are also available at    
9 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
10 *
11 */
12 /*--------------------------------------------------------------------------*/
13 #ifndef __DIARY_MANAGER_HXX__
14 #define __DIARY_MANAGER_HXX__
15
16 #include <wchar.h>
17
18 /**
19 * get filename of a ID
20 * @param[in] _Id
21 * @return filename
22 */
23 wchar_t *getDiaryFilename(int _Id);
24
25 /**
26 * get all filenames in manager
27 * @param[out] size of returned array
28 * @return filenames
29 */
30 wchar_t **getDiaryFilenames(int *array_size);
31
32 /**
33 * get all IDs in manager
34 * @param[out] size of returned array
35 * @return IDs
36 */
37 int *getDiaryIDs(int *array_size);
38
39 /**
40 * get all IDs in manager
41 * @param[out] size of returned array
42 * @return Ids (as double)
43 */
44 double *getDiaryIDsAsDouble(int *array_size);
45
46 /**
47 * close all diaries
48 * @return 0
49 */
50 int diaryCloseAll(void);
51
52 /**
53 * close a diary by ID
54 * @param[in] ID
55 * @return 0 (OK) 1 (NOK)
56 */
57 int diaryClose(int _iId);
58
59 /**
60 * close a diary by filename
61 * @param[in] filename
62 * @return 0 (OK) 1 (NOK)
63 */
64 int diaryClose(wchar_t *filename);
65
66 /**
67 * Pause all diaries
68 * @return 0
69 */
70 int diaryPauseAll(void);
71
72 /**
73 * Pause a diary by ID
74 * @param[in] ID
75 * @return 0 (OK) 1 (NOK)
76 */
77 int diaryPause(int _iId);
78
79 /**
80 * Pause a diary by filename
81 * @param[in] filename
82 * @return 0 (OK) 1 (NOK)
83 */
84 int diaryPause(wchar_t *filename);
85
86 /**
87 * Resume All diaries
88 * @return 0
89 */
90 int diaryResumeAll(void);
91
92 /**
93 * Resume a diary by ID
94 * @param[in] ID
95 * @return 0 (OK) 1 (NOK)
96 */
97 int diaryResume(int _iId);
98
99 /**
100 * Resume a diary by filename
101 * @param[in] filename
102 * @return 0 (OK) 1 (NOK)
103 */
104 int diaryResume(wchar_t *filename);
105
106 /**
107 * check if a ID exists
108 * @param[in] ID
109 * @return 0 (OK) 1 (NOK)
110 */
111 int diaryExists(int _iId);
112
113 /**
114 * checks if a filename exists
115 * @param[in] filename
116 * @return 0 (OK) 1 (NOK)
117 */
118 int diaryExists(wchar_t *filename);
119
120 /**
121 * create a new diary
122 * @param[in] filename
123 * @return ID or -1 (NOK)
124 */
125 int diaryNew(wchar_t *filename);
126
127 /**
128 * append to a diary
129 * @param[in] filename
130 * @return ID or -1 (NOK)
131 */
132 int diaryAppend(wchar_t *filename);
133
134 /*
135 * Set filter mode (input, output)
136 * @param[in] ID
137 * @param[in] mode
138 * 0 all (output and input)
139 * 1 input
140 * 2 output
141 * @return 0 (OK) 1 (NOK)
142 */
143 int diarySetFilterMode(int _iId, int mode);
144
145 /*
146 * Set prefix time mode 
147 * @param[in] ID
148 * @param[in] mode
149 * 0 prefix @ beginning of Input and Output
150 * 1 prefix only @ beginning of Input
151 * 2 prefix only @ beginning of Output
152 * 3 no prefix
153 * @return 0 (OK) 1 (NOK)
154 */
155 int diarySetPrefixMode(int ID_diary,int iPrefixMode);
156
157 /*
158 * get prefix mode
159 * @param[in] ID
160 * @return prefix mode
161 */
162 int diaryGetPrefixMode(int ID_diary);
163
164 /*
165 * set prefix IO mode filter
166 * @param[in] ID
167 * @param[in] mode
168 * @return 0 (OK) 1 (NOK)
169 */
170 int diarySetPrefixIoModeFilter(int ID_diary,int mode);
171
172 /*
173 * get prefix IO mode filter
174 * @param[in] ID
175 * @return mode 
176 */
177 int diaryGetPrefixIoModeFilter(int ID_diary);
178
179 #endif /* __DIARY_MANAGER_HXX__ */
180 /*--------------------------------------------------------------------------*/