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 #include "DiaryModesEnum.hxx"
  18
  19 /**
  20 * get filename of a ID
  21 * @param[in] _Id
  22 * @return filename
  23 */
  24 wchar_t *getDiaryFilename(int _Id);
  25
  26 /**
  27 * get all filenames in manager
  28 * @param[out] size of returned array
  29 * @return filenames
  30 */
  31 wchar_t **getDiaryFilenames(int *array_size);
  32
  33 /**
  34 * get all IDs in manager
  35 * @param[out] size of returned array
  36 * @return IDs
  37 */
  38 int *getDiaryIDs(int *array_size);
  39
  40 /**
  41 * get all IDs in manager
  42 * @param[out] size of returned array
  43 * @return Ids (as double)
  44 */
  45 double *getDiaryIDsAsDouble(int *array_size);
  46
  47 /**
  48 * close all diaries
  49 * @return 0
  50 */
  51 int diaryCloseAll(void);
  52
  53 /**
  54 * close a diary by ID
  55 * @param[in] ID
  56 * @return 0 (OK) 1 (NOK)
  57 */
  58 int diaryClose(int _iId);
  59
  60 /**
  61 * close a diary by filename
  62 * @param[in] filename
  63 * @return 0 (OK) 1 (NOK)
  64 */
  65 int diaryClose(wchar_t *filename);
  66
  67 /**
  68 * Pause all diaries
  69 * @return 0
  70 */
  71 int diaryPauseAll(void);
  72
  73 /**
  74 * Pause a diary by ID
  75 * @param[in] ID
  76 * @return 0 (OK) 1 (NOK)
  77 */
  78 int diaryPause(int _iId);
  79
  80 /**
  81 * Pause a diary by filename
  82 * @param[in] filename
  83 * @return 0 (OK) 1 (NOK)
  84 */
  85 int diaryPause(wchar_t *filename);
  86
  87 /**
  88 * Resume All diaries
  89 * @return 0
  90 */
  91 int diaryResumeAll(void);
  92
  93 /**
  94 * Resume a diary by ID
  95 * @param[in] ID
  96 * @return 0 (OK) 1 (NOK)
  97 */
  98 int diaryResume(int _iId);
  99
 100 /**
 101 * Resume a diary by filename
 102 * @param[in] filename
 103 * @return 0 (OK) 1 (NOK)
 104 */
 105 int diaryResume(wchar_t *filename);
 106
 107 /**
 108 * check if a ID exists
 109 * @param[in] ID
 110 * @return 0 (OK) 1 (NOK)
 111 */
 112 int diaryExists(int _iId);
 113
 114 /**
 115 * checks if a filename exists
 116 * @param[in] filename
 117 * @return 0 (OK) 1 (NOK)
 118 */
 119 int diaryExists(wchar_t *filename);
 120
 121 /**
 122 * create a new diary
 123 * @param[in] filename
 124 * @return ID or -1 (NOK)
 125 */
 126 int diaryNew(wchar_t *filename);
 127
 128 /**
 129 * append to a diary
 130 * @param[in] filename
 131 * @return ID or -1 (NOK)
 132 */
 133 int diaryAppend(wchar_t *filename);
 134
 135 /*
 136 * Set filter mode (input, output)
 137 * @param[in] ID
 138 * @param[in] mode
 139 * @return 0 (OK) 1 (NOK)
 140 */
 141 int diarySetFilterMode(int _iId, diary_filter mode);
 142
 143 /*
 144 * Set prefix time mode
 145 * @param[in] ID
 146 * @param[in] mode
 147 * @return 0 (OK) 1 (NOK)
 148 */
 149 int diarySetPrefixMode(int ID_diary,diary_prefix_time_format iPrefixMode);
 150
 151 /*
 152 * get prefix mode
 153 * @param[in] ID
 154 * @return prefix mode
 155 */
 156 int diaryGetPrefixMode(int ID_diary);
 157
 158 /*
 159 * set prefix IO mode filter
 160 * @param[in] ID
 161 * @param[in] mode
 162 * @return 0 (OK) 1 (NOK)
 163 */
 164 int diarySetPrefixIoModeFilter(int ID_diary,diary_prefix_time_filter mode);
 165
 166 /*
 167 * get prefix IO mode filter
 168 * @param[in] ID
 169 * @return mode
 170 */
 171 diary_prefix_time_filter diaryGetPrefixIoModeFilter(int ID_diary);
 172
 173 #endif /* __DIARY_MANAGER_HXX__ */
 174 /*--------------------------------------------------------------------------*/