diff --git a/software/monitor/monitor-python/.gitignore b/software/monitor/monitor-python/.gitignore deleted file mode 100644 index 372c13e..0000000 --- a/software/monitor/monitor-python/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -__pycache__/ - diff --git a/software/monitor/monitor-python/monitor-python.py b/software/monitor/monitor-python/monitor-python.py deleted file mode 100755 index 2ef09fb..0000000 --- a/software/monitor/monitor-python/monitor-python.py +++ /dev/null @@ -1,494 +0,0 @@ -#!/usr/bin/env python3 - -import curses -from curses.ascii import ACK -from email.message import Message -import os -import socket -import threading -from queue import Queue -import time -import sys - -class GlobVar: - port = 5544 # default server port - timeout=1.0 # default waiting time for an answer. May be increased for debugging purpose - address = "localhost" # default server address. Use this with 'nc -l ' for testing on your machine - getBatteryLevelPeriod=-1 # periodic delay for requesting battery level. If value is 0 or below, not battery check is done - - # do not modify value below this line - - connectedToPi = False - connectedToDumber = False - dumberStarted = False - - batteryLevel = -1 - currentMovement="STOP" - - last_answer = -1 - - message = [] - - exceptionmsg= "" - -# Network event from socket. -# Event are 'Connected to server' or 'disconnected from server' -class NetworkEvents: - EVENT_CONNECTED=1 - EVENT_CONNECTION_LOST=0 - UNKNOWN_EVENT=-1 - -# Network managment class -# Contain a thread for conenction to server and data reception -# Contains functions for sending message to server -# Contains functions for answer decoding -class Network(): - receiveCallback=None - eventCallback=None - reconnectionDelay =0 - waitForAnswer=False - receiveEvent = None - receivedAnswer = "" - - # List of possible answers from server - ANSWER_ACK = "AACK" - ANSWER_NACK = "ANAK" - ANSWER_COM_ERROR = "ACER" - ANSWER_TIMEOUT = "ATIM" - ANSWER_CMD_REJECTED = "ACRJ" - - # List of possible messages from server - MESSAGE = "MSSG" - ROBOT_BATTERY_LEVEL = "RBLV" - ROBOT_CURRENT_STATE = "RCST" - - # List of accepted command by server - CAMERA_OPEN = "COPN" - CAMERA_CLOSE = "CCLS" - CAMERA_IMAGE = "CIMG" - CAMERA_ARENA_ASK = "CASA" - CAMERA_ARENA_INFIRM = "CAIN" - CAMERA_ARENA_CONFIRM = "CACO" - CAMERA_POSITION_COMPUTE = "CPCO" - CAMERA_POSITION_STOP = "CPST" - CAMERA_POSITION = "CPOS" - ROBOT_COM_OPEN = "ROPN" - ROBOT_COM_CLOSE = "RCLS" - ROBOT_PING = "RPIN" - ROBOT_RESET = "RRST" - ROBOT_START_WITHOUT_WD = "RSOW" - ROBOT_START_WITH_WD = "RSWW" - ROBOT_RELOAD_WD = "RLDW" - ROBOT_MOVE = "RMOV" - ROBOT_TURN = "RTRN" - ROBOT_GO_FORWARD = "RGFW" - ROBOT_GO_BACKWARD = "RGBW" - ROBOT_GO_LEFT = "RGLF" - ROBOT_GO_RIGHT = "RGRI" - ROBOT_STOP = "RSTP" - ROBOT_POWEROFF = "RPOF" - ROBOT_GET_BATTERY = "RGBT" - ROBOT_GET_STATE = "RGST" - - SEPARATOR_CHAR = ':' - - # Decoded answers - ACK = 1 - NACK =2 - COM_ERROR =3 - TIMEOUT_ERROR=4 - CMD_REJECTED=5 - UNKNOWN=-1 - - # Initialisation method. - def __init__(self, receiveCallback=None, eventCallback=None) -> None: - self.receiveCallback = receiveCallback - self.eventCallback = eventCallback - self.waitForAnswer=False - self.receiveEvent = threading.Event() - - # Reception thread used for conencting to server and receiving data. - # Never stop, auto reconnect if connection is lost - # Send event when conencting to or disconnecting from server - # send received message to appropriate callback - def ReceptionThread(self) -> None: - while True: - try: - self.__connect() - - if self.eventCallback != None: - self.eventCallback(NetworkEvents.EVENT_CONNECTED) - self.__read() - - except (RuntimeError, TimeoutError, socket.gaierror, ConnectionResetError) as e: - if e.__class__ == RuntimeError or e.__class__== ConnectionResetError: - if self.eventCallback != None: - self.eventCallback(NetworkEvents.EVENT_CONNECTION_LOST) - - except Exception as e: - pass - - time.sleep(2.0) - - # Method helper for starting reception thread - def startReceptionThread(self) -> None: - self.threadId = threading.Thread(target=self.ReceptionThread, args=()) - self.threadId.daemon=True - self.threadId.start() - - # Private method for connecting to server - def __connect(self) -> None: - self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) - - try: - self.sock.connect((GlobVar.address, GlobVar.port)) - except ConnectionRefusedError: - raise RuntimeError("Unable to connect to " + GlobVar.address + ":" + str(GlobVar.port)) - - self.waitForAnswer=False - - # Private method for sending raw data to server - def __write(self, msg: str) -> None: - totalsent = 0 - if msg[-1] != '\n': - msg = msg + '\n' - - MSGLEN = len(msg) - msgbytes = bytes(msg,'UTF-8') - - while totalsent < MSGLEN: - sent = self.sock.send(msgbytes[totalsent:]) - if sent == 0: - GlobVar.connectedToPi=False - raise RuntimeError("Unable to send data to " + GlobVar.address + ":" + str(GlobVar.port)) - totalsent = totalsent + sent - - # Private method for receiving data from server. - # Data received are sent to callback __receiveHandler for decoding - def __read(self) -> None: - chunks = [] - bytes_recd = 0 - last_char=0 - - while True: - while last_char != 0x0A: - chunk = self.sock.recv(2048) - if chunk == b'': - raise RuntimeError("Connection lost with " + GlobVar.address + ":" + str(GlobVar.port)) - chunks.append(chunk) - bytes_recd = bytes_recd + len(chunk) - last_char=chunk[-1] - - self.__receiveHandler(b''.join(chunks).decode("utf-8")) - chunks = [] - bytes_recd =0 - last_char=0 - - # private callback for reception and decoding of data. - # If no answer is wait, send data to caller callback - def __receiveHandler(self, data: str) -> None: - # traitement a faire lors de la reception de donnée - if self.waitForAnswer: - self.receivedAnswer = data - self.waitForAnswer=False - self.receiveEvent.set() - else: - # si pas de donnée prevue en reception, alors envoie au callback - if self.receiveCallback != None: - self.receiveCallback(data) - - # Private method for sending command to server - def __sendCommand(self,cmd, waitans: bool) -> str: - if waitans == True: - self.waitForAnswer = True - else: - self.waitForAnswer = False - - self.__write(cmd) - - if waitans: - ans = self.ANSWER_TIMEOUT - try: - self.receiveEvent.wait(timeout=GlobVar.timeout) # Max waiting time = GlobVar.timeout - - if self.receiveEvent.is_set(): - ans=self.receivedAnswer - self.receivedAnswer="" - else: - ans=self.ANSWER_TIMEOUT - - self.receiveEvent.clear() - except TimeoutError: - ans=self.ANSWER_TIMEOUT - except Exception as e: - GlobVar.exceptionmsg = str(e) - - self.waitForAnswer=False - return ans - else: - return self.ANSWER_ACK - - # Private method for decoding answer from server - def __decodeAnswer(self, ans: str) -> int: - if self.ANSWER_ACK in ans: - return self.ACK - elif self.ANSWER_NACK in ans: - return self.NACK - elif self.ANSWER_COM_ERROR in ans: - return self.COM_ERROR - elif self.ANSWER_TIMEOUT in ans: - return self.TIMEOUT_ERROR - elif self.ANSWER_CMD_REJECTED in ans: - return self.CMD_REJECTED - else: - return self.UNKNOWN - - # Send OpenCom command to server - def robotOpenCom(self) -> int: - ans = self.__sendCommand(self.ROBOT_COM_OPEN, True) - return self.__decodeAnswer(ans) - - # Send CloseCom command to server - def robotCloseCom(self) -> int: - ans = self.__sendCommand(self.ROBOT_COM_CLOSE, True) - return self.__decodeAnswer(ans) - - # Send StartWithWatchdog command to server - def robotStartWithWatchdog(self) -> int: - ans = self.__sendCommand(self.ROBOT_START_WITH_WD, True) - return self.__decodeAnswer(ans) - - # Send StartWithoutWatchdog command to server - def robotStartWithoutWatchdog(self) -> int: - ans = self.__sendCommand(self.ROBOT_START_WITHOUT_WD, True) - return self.__decodeAnswer(ans) - - # Send Reset command to server - def robotReset(self) -> int: - ans = self.__sendCommand(self.ROBOT_RESET, True) - return self.__decodeAnswer(ans) - - # Send Stop command to server - def robotStop(self) -> int: - ans = self.__sendCommand(self.ROBOT_STOP, True) - return self.__decodeAnswer(ans) - - # Send GoLeft command to server - def robotGoLeft(self) -> int: - ans = self.__sendCommand(self.ROBOT_GO_LEFT, True) - return self.__decodeAnswer(ans) - - # Send GoRight command to server - def robotGoRight(self) -> int: - ans = self.__sendCommand(self.ROBOT_GO_RIGHT, True) - return self.__decodeAnswer(ans) - - # Send GoForward command to server - def robotGoForward(self) -> int: - ans = self.__sendCommand(self.ROBOT_GO_FORWARD, True) - return self.__decodeAnswer(ans) - - # Send GoBackward command to server - def robotGoBackward(self) -> int: - ans = self.__sendCommand(self.ROBOT_GO_BACKWARD, True) - return self.__decodeAnswer(ans) - - # Send GetBattery command to server - def robotGetBattery(self) -> None: - ans = self.__sendCommand(self.ROBOT_GET_BATTERY,False) - -# Function for decoding battery level -def batterylevelToStr(batlvl: int) -> str: - switcher = { - 2: "Full", - 1: "Mid", - 0: "Empty", - } - - return switcher.get(batlvl, "Unknown") - -# Function for display human readable answer -def answertoStr(ans: int) -> str: - switcher = { - Network.ACK: "Acknowledged", - Network.NACK: "Not acknowledged", - Network.TIMEOUT_ERROR: "No answer (timeout)", - Network.CMD_REJECTED: "Command rejected", - Network.COM_ERROR: "Communication error (invalid command)" - } - - return switcher.get(ans, "Unknown answer") - -# Thread for updtating display -def threadRefreshScreen(currentWindow) -> None: - while 1: - currentWindow.clear() - currentWindow.addstr("Connected to " + GlobVar.address + ":" + str(GlobVar.port) +" = " + str(GlobVar.connectedToPi)) - currentWindow.move(1,0) - currentWindow.addstr("Connected to robot = " + str(GlobVar.connectedToDumber)) - currentWindow.move(3,0) - currentWindow.addstr("Robot started = " + str(GlobVar.dumberStarted)) - currentWindow.move(4,0) - currentWindow.addstr("Current movement sent to robot = " + str(GlobVar.currentMovement)) - currentWindow.move(5,0) - currentWindow.addstr("Battery level = " + batterylevelToStr(GlobVar.batteryLevel)) - currentWindow.move(7,0) - currentWindow.addstr("Last answer received = " + answertoStr(GlobVar.last_answer)) - currentWindow.move(9,0) - currentWindow.addstr("Messages received (log)") - - # up to 8 messages - for i in range(0,len(GlobVar.message)): - currentWindow.move(10+i,0) - currentWindow.addstr("[mes "+str(i)+ "] ") - currentWindow.addstr(str(GlobVar.message[i])) - - currentWindow.move(20,0) - currentWindow.addstr("Commands : \'O\' = Open COM with robot/ \'C\' = Close COM with robot") - currentWindow.move(21,0) - currentWindow.addstr(" \'W\' = Start robot with wdt/ \'U\' = Start robot without wdt/ \'R\' = Reset robot") - currentWindow.move(22,0) - currentWindow.addstr(" \'Up\',\'Down\',\'Left\',\'Right\' = Move robot/ Space Bar = Stop robot") - currentWindow.move(23,0) - currentWindow.addstr(" CTRL-C = Quit program") - currentWindow.refresh() - time.sleep(0.5) - -# Thread for reading keyboard keys and sending corresponding commands to server -def threadGetKeys(win: curses.window, net:Network) -> None: - while 1: - try: - key = win.getkey() - win.addstr(" KEY = " + key) - - GlobVar.currentMovement = "Stop" - if GlobVar.connectedToPi: - if key == "KEY_UP": - GlobVar.currentMovement = "Go Forward" - GlobVar.last_answer = net.robotGoForward() - elif key == "KEY_DOWN": - GlobVar.currentMovement = "Go Backward" - GlobVar.last_answer = net.robotGoBackward() - elif key == "KEY_RIGHT": - GlobVar.currentMovement = "Go Right" - GlobVar.last_answer = net.robotGoRight() - elif key == "KEY_LEFT": - GlobVar.currentMovement = "Go Left" - GlobVar.last_answer = net.robotGoLeft() - elif key == " ": - GlobVar.currentMovement = "Stop" - GlobVar.last_answer = net.robotStop() - elif key == "R" or key == 'r': - GlobVar.last_answer = net.robotReset() - GlobVar.dumberStarted=False - elif key == "U" or key == 'u': - GlobVar.last_answer = net.robotStartWithoutWatchdog() - if GlobVar.last_answer == net.ACK: - GlobVar.dumberStarted=True - else: - GlobVar.dumberStarted=False - elif key == "W" or key == 'w': - GlobVar.last_answer = net.robotStartWithWatchdog() - if GlobVar.last_answer == net.ACK: - GlobVar.dumberStarted=True - else: - GlobVar.dumberStarted=False - elif key == "C" or key=='c': - GlobVar.last_answer = net.robotCloseCom() - GlobVar.connectedToDumber=False - GlobVar.dumberStarted=False - elif key == "O" or key =='o': - GlobVar.last_answer = net.robotOpenCom() - if GlobVar.last_answer == net.ACK: - GlobVar.connectedToDumber=True - else: - GlobVar.connectedToDumber=False - - #if key == os.linesep or key =='q' or key == 'Q': - # break - - except Exception as e: - GlobVar.exceptionmsg="Exception received: " + str(e) - -# Thread used for requesting battery level, exit if getBatteryLevelPeriod is 0 or below -def threadPeriodic(net: Network) -> None: - while True: - if GlobVar.getBatteryLevelPeriod>0: - time.sleep(GlobVar.getBatteryLevelPeriod) - - GlobVar.batteryLevel = -1 - if GlobVar.connectedToPi: - net.robotGetBattery() - else: - break - -# Callback used to decode non answer message from server (mainly battery level and log message) -def receptionCallback(s:str) -> None: - if Network.ROBOT_BATTERY_LEVEL in s: - str_split = s.split(':') - - try: - GlobVar.batteryLevel = int(str_split[1]) - except: - GlobVar.batteryLevel = -1 - - if Network.MESSAGE in s: - str_split = s.split(':') - - try: - GlobVar.message.append(str(str_split[1])) - except Exception as e: - GlobVar.exceptionmsg = str(e) - - if len(GlobVar.message) > 8: - GlobVar.message.pop(0) - -# Callback for connection/deconnection event from network manager -def eventCallback(event: NetworkEvents) -> None: - if event == NetworkEvents.EVENT_CONNECTED: - GlobVar.connectedToPi = True - elif event == NetworkEvents.EVENT_CONNECTION_LOST: - GlobVar.connectedToPi = False - -# Main program, wait for keys thread to end (CTRL-C) -def main(win: curses.window) -> None: - win.keypad(True) - - net = Network(receiveCallback=receptionCallback, eventCallback=eventCallback) - - net.startReceptionThread() - - windowThread = threading.Thread(target=threadRefreshScreen, args=(win,)) - windowThread.daemon=True - windowThread.start() - - keyThread = threading.Thread(target=threadGetKeys, args=(win,net,)) - keyThread.daemon=True - keyThread.start() - - periodicThread = threading.Thread(target=threadPeriodic, args=(net,)) - periodicThread.daemon=True - periodicThread.start() - - keyThread.join() - - while True: - time.sleep(2.0) - -try: - if len(sys.argv)>=2: - GlobVar.address = sys.argv[1] - else: - print ("No target address specified") - print ("Usage: monitor-python.py address [port]") - - #exit (-1) # Comment this line for connecting to localhost - - if len(sys.argv)>=3: - GlobVar.port = int(sys.argv[2]) - - curses.wrapper(main) - -except KeyboardInterrupt: # exception when pressing CTRL-C - print ("Bye bye") - diff --git a/software/monitor/monitor/.gitignore b/software/monitor/monitor/.gitignore deleted file mode 100644 index 4e82d27..0000000 --- a/software/monitor/monitor/.gitignore +++ /dev/null @@ -1,40 +0,0 @@ -# Autosave files -*~ - -# build -[Oo]bj/ -[Bb]in/ -packages/ -TestResults/ - -# globs -Makefile.in -*.DS_Store -*.sln.cache -*.suo -*.cache -*.pidb -*.userprefs -*.usertasks -config.log -config.make -config.status -aclocal.m4 -install-sh -autom4te.cache/ -*.user -*.tar.gz -tarballs/ -test-results/ -Thumbs.db - -# Mac bundle stuff -*.dmg -*.app - -# resharper -*_Resharper.* -*.Resharper - -# dotCover -*.dotCover diff --git a/software/monitor/monitor/Client.cs b/software/monitor/monitor/Client.cs deleted file mode 100644 index a2b7ecc..0000000 --- a/software/monitor/monitor/Client.cs +++ /dev/null @@ -1,272 +0,0 @@ -// -// Client.cs -// -// Author: -// Di MERCURIO Sébastien -// -// Copyright (c) 2018 INSA - DGEI -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . - -using System; -using System.Net.Sockets; -using System.Text; - -using System.Threading; - -namespace monitor -{ - /// - /// Static class for TCP client - /// - public static class Client - { - /// - /// Default server name - /// - public const string defaultIP = "10.105.1.13"; - - /// - /// Default server port number - /// - public const int defaultPort = 5544; - - /// - /// Tcp client object - /// - private static TcpClient client = null; - - /// - /// Stream object used for communication - /// - private static NetworkStream stream = null; - - /// - /// Size of internal buffer used when reading data from server - /// - private const int BufferMaxSize = 8*1024; - - /// - /// Internal buffer used when reading data from server - /// - private static byte[] buffer = new byte[BufferMaxSize]; - - /// - /// String containing received message from tcp server - /// - private static StringBuilder message = new StringBuilder(); - - /// - /// Callback to send received message to upper level - /// - public delegate void ReadEvent(string msg); - public static ReadEvent readEvent = null; - - /// - /// Open connection to server "host", on default port number. - /// - /// true if connection succeded, false otherwise - /// Hostname to connect to - public static bool Open(string host) - { - return Client.Open(host, defaultPort); - } - - /// - /// Open connection to server "host", with port number "port" - /// - /// true if connection succeded, false otherwise - /// Hostname to connect to - /// Port number for connection - public static bool Open(string host, int port) - { - bool status = true; - - try - { - client = new TcpClient(host, port); - - stream = client.GetStream(); - - // Start reading tcp stream and call "ReadCallback" method when newLength data - // will be received - // initially, "newLength" is equal to 1, so first call to ReadCallback - // will be done after reception of 1 byte. - - // received data are stored in buffer - // Next reading will be done in ReadCallback method - stream.BeginRead(buffer, 0, 1, new AsyncCallback(ReadCallback), message); - } - catch (ArgumentNullException e) - { - Console.WriteLine("ArgumentNullException: " + e); - status = false; - } - catch (SocketException e) - { - Console.WriteLine("SocketException: " + e.ToString()); - status = false; - } - catch (Exception e) - { - Console.WriteLine("Unknown Exception: " + e.ToString()); - status = false; - } - - return status; - } - - /// - /// Close connection to server - /// - public static void Close() - { - if (stream != null) stream.Close(); - if (client != null) client.Close(); - } - - /// - /// Callback call by stream.BeginRead after reception of newLength data - /// - /// Not sure of what is it, but needed for terminate reading - private static void ReadCallback(IAsyncResult ar) - { - int newLength = 1; - int index = -1; - - if (client.Connected) - { - int bytesRead; - - try - { - // Terminate read operation, and get number of byte stored in buffer - bytesRead = stream.EndRead(ar); - } - catch (ObjectDisposedException e) - { - Console.WriteLine("Connection to server dropped: " + e.ToString()); - return; - } - catch (System.IO.IOException e) - { - Console.WriteLine("Connection to server dropped: " + e.ToString()); - return; - } - - newLength = 1; - index = -1; - - // if number of byte read is not 0, concatenate string and buffer - if (bytesRead > 0) - { - //Console.WriteLine("Receive " + bytesRead + " data"); - - // Append new data to current string (expecting data are ascii) - message.Append(Encoding.ASCII.GetString(buffer, 0, bytesRead)); - index = SearchCarriageReturn(buffer, bytesRead); - } - - // if it remains received data, prepare for a new reading (get another buffer to append to current one) - if (index == -1) - { - if (client.Available > 0) - { - newLength = client.Available; - if (newLength > BufferMaxSize) newLength = BufferMaxSize; - else newLength = client.Available; - } - } - else - { - string s = message.ToString(); - - // no more data to read, buffer and string can be send to upper level - readEvent?.Invoke(s); - - message.Clear(); - - if (index != bytesRead - 1) - { - byte[] trailing=new byte[BufferMaxSize]; - - Array.Copy(buffer, index + 1, trailing, 0, bytesRead - index - 1); - message.Append(Encoding.ASCII.GetString(trailing, 0, bytesRead - index - 1)); - } - } - - // Prepare for reading new data - if (newLength> BufferMaxSize) newLength = BufferMaxSize; - if (newLength <= 0) newLength = 1; - - try - { - stream.BeginRead(buffer, 0, newLength, new AsyncCallback(ReadCallback), message); - } - catch (ObjectDisposedException e) - { - Console.WriteLine("Connection to server dropped: " + e.ToString()); - return; - } - catch (System.IO.IOException e) - { - Console.WriteLine("Connection to server dropped: " + e.ToString()); - return; - } - } - } - - /// - /// Searchs the carriage return. - /// - /// Index of carriage return, if present, -1 otherwise. - /// Buffer of byte - /// Length of buffer - private static int SearchCarriageReturn(byte[] buf, int length) - { - int index = -1; - int i = 0; - - for (i = 0; i < length; i++) - { - if (buf[i] == (byte)'\n') break; - } - - if (i!= length) index = i; - return index; - } - - /// - /// Write a string to server - /// - /// Nothing - /// Message to send to server - public static void Write(string mes) - { - if (client.Connected) - { - byte[] writeBuffer = Encoding.UTF8.GetBytes(mes); - - try - { - stream.Write(writeBuffer, 0, mes.Length); - } - catch (System.IO.IOException) { - Console.WriteLine("Server closed"); - client.Close(); - } - } - } - } -} diff --git a/software/monitor/monitor/CommandManager.cs b/software/monitor/monitor/CommandManager.cs deleted file mode 100644 index 03efac1..0000000 --- a/software/monitor/monitor/CommandManager.cs +++ /dev/null @@ -1,214 +0,0 @@ -// -// CommandManager.cs -// -// Author: -// Di MERCURIO Sébastien -// -// Copyright (c) 2018 INSA - DGEI -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . - -using System.Threading; - -namespace monitor -{ - /// - /// Command Manager. Use for timeout managment during reception of data - /// Used as intermediate layer between TCP client class (Client) and application level - /// managment of command and answers - /// - public class CommandManager - { - /// - /// Callback for sending received data to upper level - /// - public delegate void CommandReceivedEvent(string msg); - public CommandReceivedEvent commandReceivedEvent = null; - - /// - /// Timer for managing timeout - /// - private System.Timers.Timer waitTimer = new System.Timers.Timer(); - private ManualResetEvent waitEvent = new ManualResetEvent(false); - - /// - /// Flag to tell rogram to wait for an acknowledge from server - /// - private bool waitForAcknowledge = false; - - /// - /// received message - /// - private string messageReceived = null; - - /// - /// flag indicating command manager is currently busy waiting an acknowledge - /// - private bool isBusy = false; - - /// - /// Available status when sending command - /// - public enum CommandManagerStatus - { - AnswerReceived, - Timeout, - Busy - }; - - /// - /// Initializes a new instance of the class. - /// - /// Callback used when new message are received - public CommandManager(CommandReceivedEvent callback) - { - Client.readEvent += this.OnMessageReception; - - this.commandReceivedEvent += callback; - waitTimer.Elapsed += OnMessageTimeout; - } - - /// - /// Releases unmanaged resources and performs other cleanup operations before the - /// is reclaimed by garbage collection. - /// - ~CommandManager() - { - Client.Close(); - } - - /// - /// Open the specified hostname server, using default port number. - /// - /// true if connection succeded, false otherwise - /// Hostname to connect to - public bool Open(string hostname) - { - return this.Open(hostname, Client.defaultPort); - } - - /// - /// Open connection to server "host", with port number "port" - /// - /// true if connection succeded, false otherwise - /// Hostname to connect to - /// Port number for connection - public bool Open(string hostname, int port) - { - return Client.Open(hostname, port); - } - - /// - /// Close connection to server - /// - public void Close() - { - Client.Close(); - } - - /// - /// Callback called by Client class after reception of new message - /// - /// Message received from server - /// Raw buffer reived from server - private void OnMessageReception(string message) - { - waitTimer.Stop(); // Stop timeout stopwatch - - this.messageReceived = message; - isBusy = false; - - // if SendCommand wait for an acknowledge, release semaphore waitEvent - // so that SendCommand will be able to read received answer - // Received answer will not be sent to upper level - if (waitForAcknowledge) - { - waitForAcknowledge = false; - waitEvent.Set(); // Envoi de l'evenement - } - else - // if sendCommand doesn't wait for an acknowledge, message received - // is for upper level, so call callback - { - - waitForAcknowledge = false; - - this.commandReceivedEvent?.Invoke(message); - } - } - - /// - /// Callback called by stopwatch on timeout - /// - /// Sender object - /// Information on elapsed condition - private void OnMessageTimeout(object sender, System.Timers.ElapsedEventArgs e) - { - messageReceived = null; - // set buffer and message as null to indicate that no message was received - // and call to OnMessagereception is due to timeout - OnMessageReception(messageReceived); - } - - /// - /// Sends a command to TCP server - /// - /// status that is part of CommandManagerStatus enumerate - /// Command message to send to server - /// Answer from server, in case of acknowledge - /// Timeout (ms) waiting an acknowledge, 0 if no acknowledge needed - public CommandManagerStatus SendCommand(string cmd, out string answer, double timeout) - { - CommandManagerStatus status = CommandManagerStatus.AnswerReceived; - answer = null; - - - if (isBusy) status = CommandManagerStatus.Busy; - else - { - isBusy = true; - - // Send command to server - Client.Write(cmd); - - if (timeout > 0) // Command request an acknowledge - { - - waitForAcknowledge = true; // Flag used in OnMessageReception callback to avoid - // sending acknowledge message to upper level - waitTimer.Interval = timeout; - waitTimer.Start(); // Start timeout timer - - waitEvent.WaitOne(); // Stop current thread, waiting for waitEvent semaphore - // produced in OnMessageReception when either a message is received - // or a timeout occur - - waitEvent.Reset(); // reset semaphore for next message - - if (this.messageReceived == null) // timeout: server connection error - { - status = CommandManagerStatus.Timeout; - } - } - else isBusy = false; - - // return received answer, null in case of timeout - answer = this.messageReceived; - this.messageReceived = null; - } - - return status; - } - } -} diff --git a/software/monitor/monitor/DestijlCommandManager.cs b/software/monitor/monitor/DestijlCommandManager.cs deleted file mode 100644 index 84b1bb9..0000000 --- a/software/monitor/monitor/DestijlCommandManager.cs +++ /dev/null @@ -1,700 +0,0 @@ -// -// DestijlCommandManager.cs -// -// Author: -// Di MERCURIO Sébastien -// -// Copyright (c) 2018 INSA - DGEI -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . - -// 15/01/2019 dimercur -// Demande #41: Modifier les messages envoyés par les flèches de direction - -using System; -using System.Globalization; - -namespace monitor -{ - /// - /// Commands and options parameters used in Destijl project when communicating with server - /// - public static class DestijlCommandList - { - public const string ANSWER_ACK = "AACK"; - public const string ANSWER_NACK = "ANAK"; - public const string ANSWER_COM_ERROR = "ACER"; - public const string ANSWER_TIMEOUT = "ATIM"; - public const string ANSWER_CMD_REJECTED = "ACRJ"; - public const string MESSAGE = "MSSG"; - public const string CAMERA_OPEN = "COPN"; - public const string CAMERA_CLOSE = "CCLS"; - public const string CAMERA_IMAGE = "CIMG"; - public const string CAMERA_ARENA_ASK = "CASA"; - public const string CAMERA_ARENA_INFIRM = "CAIN"; - public const string CAMERA_ARENA_CONFIRM = "CACO"; - public const string CAMERA_POSITION_COMPUTE = "CPCO"; - public const string CAMERA_POSITION_STOP = "CPST"; - public const string CAMERA_POSITION = "CPOS"; - public const string ROBOT_COM_OPEN = "ROPN"; - public const string ROBOT_COM_CLOSE = "RCLS"; - public const string ROBOT_PING = "RPIN"; - public const string ROBOT_RESET = "RRST"; - public const string ROBOT_START_WITHOUT_WD = "RSOW"; - public const string ROBOT_START_WITH_WD = "RSWW"; - public const string ROBOT_RELOAD_WD = "RLDW"; - public const string ROBOT_MOVE = "RMOV"; - public const string ROBOT_TURN = "RTRN"; - public const string ROBOT_GO_FORWARD = "RGFW"; - public const string ROBOT_GO_BACKWARD = "RGBW"; - public const string ROBOT_GO_LEFT = "RGLF"; - public const string ROBOT_GO_RIGHT = "RGRI"; - public const string ROBOT_STOP = "RSTP"; - public const string ROBOT_POWEROFF = "RPOF"; - public const string ROBOT_BATTERY_LEVEL = "RBLV"; - public const string ROBOT_GET_BATTERY = "RGBT"; - public const string ROBOT_GET_STATE = "RGST"; - public const string ROBOT_CURRENT_STATE = "RCST"; - - public const char SEPARATOR_CHAR = ':'; - } - - /// - /// Specialization class for command manager, which implemnent destijl protocol between monitor and server - /// - public class DestijlCommandManager - { - /// - /// Command Manager object - /// - private CommandManager commandManager = null; - - /// - /// Part of received message corresponding to command header - /// - private string receivedHeader = null; - - /// - /// Part of received message corresponding to command data - /// - private string receivedData = null; - - /// - /// Callback for sending received data to application level - /// - public delegate void CommandReceivedEvent(string header, string data); - public CommandReceivedEvent commandReceivedEvent = null; - - /// - /// Timeout used for command with acknowledge - /// - public double timeout = 100; - - /// - /// List of available return status - /// - public enum CommandStatus - { - Success, - Rejected, - InvalidAnswer, - Busy, - CommunicationLostWithRobot, - CommunicationLostWithServer - } - - public struct Point { - public double x; - public double y; - } - - public class Position { - public int robotID; - public double angle; - public Point centre; - public Point direction; - - public Position() { - robotID = 0; - angle = 0.0; - centre.x = 0.0; - centre.y = 0.0; - direction.x = 0.0; - direction.y = 0.0; - } - - public override string ToString() { - string s = "ID: " + robotID + ", Angle: " + angle + - ", Centre (x: " + centre.x + ", y: " + centre.y + - "), Direction (x: " + direction.x + ", y: " + direction.y + ")"; - return s; - } - } - - /// - /// Initializes a new instance of the class. - /// - /// Callback reference for reception of data - public DestijlCommandManager(CommandReceivedEvent callback) - { - commandManager = new CommandManager(OnCommandReceived); - this.commandReceivedEvent += callback; - } - - /// - /// Releases unmanaged resources and performs other cleanup operations before the - /// is reclaimed by garbage collection. - /// - ~DestijlCommandManager() - { - if (commandManager != null) commandManager.Close(); - } - - /// - /// Callback used for receiving data from lower layer (CommandManager class) - /// - /// String containing received message - /// Raw buffer to be used when data are not in ascii format (image for example) - private void OnCommandReceived(string msg) - { - // Firstly, remove ending \n and everything after - string[] msgsCarriageReturn = msg.Split('\n'); - - // Second, split message in (at least) two part : header, and data - string[] msgs = msgsCarriageReturn[0].Split(DestijlCommandList.SEPARATOR_CHAR); - - // If it exist at least on element in string array, it should be command header - if (msgs.Length >= 1) receivedHeader = msgs[0]; - else receivedHeader = null; - - // if msgs array contains at least two elements, second element is normally data - if (msgs.Length >= 2) receivedData = msgs[1]; - else receivedData = null; - - // when split is done, provide data to application - this.commandReceivedEvent?.Invoke(receivedHeader, receivedData); - } - - /// - /// Open the specified hostname server, using default port number. - /// - /// true if connection succeded, false otherwise - /// Hostname to connect to - public bool Open(string hostname) - { - return this.Open(hostname, Client.defaultPort); - } - - /// - /// Open connection to server "host", with port number "port" - /// - /// true if connection succeded, false otherwise - /// Hostname to connect to - /// Port number for connection - public bool Open(string hostname, int port) - { - if (commandManager != null) return commandManager.Open(hostname, port); - else return false; - } - - /// - /// Close connection to server - /// - public void Close() - { - if (commandManager != null) commandManager.Close(); - } - - /// - /// Creates the command to send to server, based on header and data provided - /// - /// The command string - /// Header part of the command - /// Data part of the command - private string CreateCommand(string header, string data) - { - return header + DestijlCommandList.SEPARATOR_CHAR + data+"\n"; - } - - /// - /// Creates the command to send to server, based on header - /// - /// The command string - /// Header part of the command - private string CreateCommand(string header) - { - return header + DestijlCommandList.SEPARATOR_CHAR+"\n"; - } - - /// - /// Provide DestijlCommandManager.CommandStatus based on status received by CommandManager.SendCommand and answer string - /// - /// Status compatible with DestijlCommandManager.CommandStatus type - /// Status provided by CommandManager.SendCommand - /// Answer provided by CommandManager.SendCommand - private CommandStatus DecodeStatus(CommandManager.CommandManagerStatus localStatus, string answer) - { - CommandStatus status = CommandStatus.Success; - - // if timeout occures, return CommandStatus.CommunicationLostWithServer - if (localStatus == CommandManager.CommandManagerStatus.Timeout) status = CommandStatus.CommunicationLostWithServer; - // if a command is currently processed, return Busy - else if (localStatus == CommandManager.CommandManagerStatus.Busy) status = CommandStatus.Busy; - else - { - if (answer != null) - { - // if command is not acknowledged, return Rejected - if (answer.ToUpper().Contains(DestijlCommandList.ANSWER_NACK)) status = CommandStatus.Rejected; - // if communication is lost with robot, return CommunicationLostWithRobot - else if (answer.ToUpper().Contains(DestijlCommandList.ANSWER_TIMEOUT)) status = CommandStatus.CommunicationLostWithRobot; - // if answer is empty, communication with robot is lost - else if (answer.Length == 0) status = CommandStatus.CommunicationLostWithServer; - //else status = CommandStatus.InvalidAnswer; - } - } - - return status; - } - - /// - /// Open communication with robot and wait acknowledge - /// - /// Command status (see DecodeStatus) - public CommandStatus RobotOpenCom() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.ROBOT_COM_OPEN), - out answer, - this.timeout); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Close communication with robot and wait acknowledge - /// - /// Command status (see DecodeStatus) - public CommandStatus RobotCloseCom() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.ROBOT_COM_CLOSE), - out answer, - this.timeout); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Ping the robot. - /// - /// Command status (see DecodeStatus) - public CommandStatus RobotPing() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.ROBOT_PING), - out answer, - this.timeout); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Reset robot and let it in idle mode - /// - /// Command status (see DecodeStatus) - public CommandStatus RobotReset() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.ROBOT_RESET), - out answer, - 0); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Start robot, enabling watchdog - /// - /// Command status (see DecodeStatus) - public CommandStatus RobotStartWithWatchdog() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.ROBOT_START_WITH_WD), - out answer, - this.timeout); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Start robot, without enabling watchdog - /// - /// Command status (see DecodeStatus) - public CommandStatus RobotStartWithoutWatchdog() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.ROBOT_START_WITHOUT_WD), - out answer, - this.timeout); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Move robot forward for an unlimited distance - /// - /// Command status (see DecodeStatus) - public CommandStatus RobotGoForward() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.ROBOT_GO_FORWARD), - out answer, - 0); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Move robot backward for an unlimited distance - /// - /// Command status (see DecodeStatus) - public CommandStatus RobotGoBackward() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.ROBOT_GO_BACKWARD), - out answer, - 0); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Turn robot to the left for an unlimited number of turn - /// - /// Command status (see DecodeStatus) - public CommandStatus RobotGoLeft() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.ROBOT_GO_LEFT), - out answer, - 0); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Turn robot to the right for an unlimited number of turn - /// - /// Command status (see DecodeStatus) - public CommandStatus RobotGoRight() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.ROBOT_GO_RIGHT), - out answer, - 0); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Stop robot mouvement - /// - /// Command status (see DecodeStatus) - public CommandStatus RobotStop() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.ROBOT_STOP), - out answer, - 0); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Make robot turn left or right, for a given angle - /// - /// Command status (see DecodeStatus) - /// Angle of turn, in degree (negative for left, positive for right) - public CommandStatus RobotTurn(int angle) - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.ROBOT_TURN, Convert.ToString(angle)), - out answer, - 0); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Request robot battery level - /// - /// Command status (see DecodeStatus) - public CommandStatus RobotGetBattery() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.ROBOT_GET_BATTERY), - out answer, - 0); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Power off robot - /// - /// Command status (see DecodeStatus) - public CommandStatus RobotPowerOff() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.ROBOT_POWEROFF), - out answer, - 0); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Open camera on remote device - /// - /// Command status (see DecodeStatus) - public CommandStatus CameraOpen() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.CAMERA_OPEN), - out answer, - this.timeout); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Close camera on remote device - /// - /// Command status (see DecodeStatus) - public CommandStatus CameraClose() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.CAMERA_CLOSE), - out answer, - 0); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Request still image of detected arena - /// - /// Command status (see DecodeStatus) - public CommandStatus CameraAskArena() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.CAMERA_ARENA_ASK), - out answer, - 0); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Confirm arena detection (after requesting image of detected arena, using CameraAskArena - /// - /// Command status (see DecodeStatus) - public CommandStatus CameraArenaConfirm() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.CAMERA_ARENA_CONFIRM), - out answer, - 0); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Reject arena detected (after requesting image of detected arena, using CameraAskArena - /// - /// Command status (see DecodeStatus) - public CommandStatus CameraArenaInfirm() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.CAMERA_ARENA_INFIRM), - out answer, - 0); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Request robot position computing - /// - /// Command status (see DecodeStatus) - public CommandStatus CameraComputePosition() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.CAMERA_POSITION_COMPUTE), - out answer, - 0); - - return DecodeStatus(localStatus, answer); - } - - /// - /// Stop robot position computing - /// - /// Command status (see DecodeStatus) - public CommandStatus CameraStopComputePosition() - { - CommandManager.CommandManagerStatus localStatus; - string answer; - - localStatus = commandManager.SendCommand( - CreateCommand(DestijlCommandList.CAMERA_POSITION_STOP), - out answer, - 0); - - return DecodeStatus(localStatus, answer); - } - - public static Position DecodePosition(string data) { - Position pos = new Position(); - - pos.robotID = 0; - pos.angle = 0.0; - pos.centre.x = 0.0; - pos.centre.y=0.0; - pos.direction.x = 0.0; - pos.direction.y = 0.0; - - string[] parts = data.Split(';'); - - NumberFormatInfo provider = new NumberFormatInfo(); - provider.NumberDecimalSeparator = "."; - provider.NumberGroupSeparator = ","; - provider.NumberGroupSizes = new int[] { 3 }; - - if (parts.Length == 6) { - pos.robotID = Convert.ToInt32(parts[0]); - - try - { - pos.angle = Convert.ToDouble(parts[1]); - } catch (FormatException) - { - pos.angle = Convert.ToDouble(parts[1],provider); - } - - try - { - pos.centre.x = Convert.ToDouble(parts[2]); - } catch (FormatException) - { - pos.centre.x = Convert.ToDouble(parts[2], provider); - } - - try - { - pos.centre.y = Convert.ToDouble(parts[3]); - } - catch (FormatException) - { - pos.centre.y = Convert.ToDouble(parts[3], provider); - } - - try - { - pos.direction.x = Convert.ToDouble(parts[4]); - } - catch (FormatException) - { - pos.direction.x = Convert.ToDouble(parts[4], provider); - } - - try - { - pos.direction.y = Convert.ToDouble(parts[5]); - } - catch (FormatException) - { - pos.direction.y = Convert.ToDouble(parts[5], provider); - } - - } else { - // misformatted data, return 0 filled position - Console.WriteLine("Misformated position"); - } - - return pos; - } - } -} diff --git a/software/monitor/monitor/Doxyfile b/software/monitor/monitor/Doxyfile deleted file mode 100644 index 176d44e..0000000 --- a/software/monitor/monitor/Doxyfile +++ /dev/null @@ -1,2494 +0,0 @@ -# Doxyfile 1.8.13 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = Monitor - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = - -# With the PROJECT_LOGO tag one can specify a logo or an icon that is included -# in the documentation. The maximum height of the logo should not exceed 55 -# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy -# the logo to the output directory. - -PROJECT_LOGO = /home/dimercur/Documents/Travail/git/dumber/software/monitor/monitor/ressources/robot-icon.resized.png - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = /home/dimercur/Documents/Travail/git/dumber/software/monitor/monitor/docs - -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new -# page for each member. If set to NO, the documentation of a member will be part -# of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. - -ALIASES = - -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = YES - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: -# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: -# Fortran. In the later case the parser tries to guess whether the code is fixed -# or free formatted code, this is the default for Fortran type files), VHDL. For -# instance to make doxygen treat .inc files as Fortran files (default is PHP), -# and .f files as C (default is Fortran), use: inc=Fortran f=C. -# -# Note: For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up -# to that level are automatically included in the table of contents, even if -# they do not have an id attribute. -# Note: This feature currently applies only to Markdown headings. -# Minimum value: 0, maximum value: 99, default value: 0. -# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. - -TOC_INCLUDE_HEADINGS = 0 - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# If one adds a struct or class to a group and this option is enabled, then also -# any nested class or struct is added to the same group. By default this option -# is disabled and one has to add nested compounds explicitly via \ingroup. -# The default value is: NO. - -GROUP_NESTED_COMPOUNDS = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = YES - -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = YES - -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = YES - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO, -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. If set to YES, local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO, only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = YES - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO, these declarations will be -# included in the documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES, upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES, the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. - -HIDE_COMPOUND_REFERENCE= NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo -# list. This list is created by putting \todo commands in the documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test -# list. This list is created by putting \test commands in the documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES, the -# list will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong or incomplete -# parameter documentation, but not about the absence of documentation. -# The default value is: NO. - -WARN_NO_PARAMDOC = NO - -# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when -# a warning is encountered. -# The default value is: NO. - -WARN_AS_ERROR = NO - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING -# Note: If this tag is empty the current directory is searched. - -INPUT = /home/dimercur/Documents/Travail/git/dumber/software/monitor/monitor - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. -# -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, -# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. - -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.idl \ - *.ddl \ - *.odl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.cs \ - *.d \ - *.php \ - *.php4 \ - *.php5 \ - *.phtml \ - *.inc \ - *.m \ - *.markdown \ - *.md \ - *.mm \ - *.dox \ - *.py \ - *.pyw \ - *.f90 \ - *.f95 \ - *.f03 \ - *.f08 \ - *.f \ - *.for \ - *.tcl \ - *.vhd \ - *.vhdl \ - *.ucf \ - *.qsf - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = NO - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = * - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = YES - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the -# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the -# cost of reduced performance. This can be particularly helpful with template -# rich C++ code for which doxygen's built-in parser lacks the necessary type -# information. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse-libclang=ON option for CMake. -# The default value is: NO. - -CLANG_ASSISTED_PARSING = NO - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_OPTIONS = - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = NO - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler (hhc.exe). If non-empty, -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated -# (YES) or that it should be included in the master .chm file (NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated -# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = YES - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /