Comment lire cette documentation ?
Cette partie de la documentation fournit un aperçu de différents aspects de la bibliothèque et peut être vue comme un tutoriel destiné à familiariser le lecteur à l'utilisation de la bibliothèque. Si la partie décrivant par le menu la totalité des classes de la bibliothèque et les méthodes associées peut être utilisée comme référence à l'utilisation de la bibliothèque, une telle présentation n'est pas adaptée pour comprendre ce qu'il est possible de faire avec Cogitant, comment le faire, savoir où chercher une fonctionnalité donnée (dans quelle classe), savoir comment faire pour étendre les classes, définir de nouvelles opérations, etc.
Il est donc conseillé de parcourir cette partie de la documentation avant d'étudier en détail les méthodes offertes par chaque classe. Toutefois, ce tutoriel comporte des liens vers les descriptions détaillées et il peut être intéressant de consulter certaines de ces descriptions pendant la lecture du tutoriel.
Présentation de la documentation
Plus précisément, cette partie de la documentation peut être divisée en quatre sections :
-
Une première section donne des informations concernant l'utilisation de la bibliothèque sans entrer dans une présentation des classes et plus particulièrement l'Installation de Cogitant à partir des sources, ainsi que les Conventions utilisées dans le nommage des fichiers, classes et méthodes. Le dernier point évoqué dans cette section concerne la marche à suivre pour Compilation de programmes utilisant Cogitant, et plus particulièrement les problèmes de fichiers entêtes et bibliothèques.
-
La deuxième partie concerne plus particulièrement l'utilisation de la bibliothèque pour construire des programmes et propose une description des différentes fonctionnalités offertes dans la bibliothèque : Après une présentation de l'Architecture générale de la bibliothèque, les fonctionnalités pour la Manipulation du support sont décrites ainsi que celles pour la Manipulation de graphes conceptuels et la Manipulation de règles et contraintes. Certaines opérations pouvant se révéler incorrectes, Cogitant dispose d'une Gestion d'erreur. Les Opérations disponibles ne sont pas directement des méthodes des classes cogitant::Graph ou cogitant::Rule mais sont accessibles à travers des classes particulières. Ces classes, sous-classes de cogitant::Operation, offrent aussi bien les opérations définies dans le modèle (projection, application de règles) que les opérations d'entrées/sorties dans différents formats, et l'opération de vérification des objets. Enfin, la bibliothèque étant prévue pour être étendue, le mécanisme d'Allocation d'objets est décrit. L'utilisation des classes cogitant::Allocator facilite la définition de nouvelles classes à partir de classes existantes (par héritage) : grace à ces allocateurs, ces nouvelles classes peuvent être facilement prises en compte au sein des mécanismes existants.
-
La troisième section décrit deux extensions de Cogitant: l'Architecture client-serveur ainsi que les classes permettant le Dessin de graphes.
-
Enfin, la dernière partie fournit une référence des formats de fichiers utilisés dans Cogitant, et plus particulièrement le Format BCGCT et le Format CoGXML et se termine par une Bibliographie ainsi que liste des Dernières modifications.
Fichiers contenus dans l'archive
Cette section donne une description rapide de l'arborescence de répertoires et des fichiers contenus dans l'archive.
-
doc/
Répertoire contenant la documentation de la bibliothèque. Les fichiers présents dans ce répertoire sont, pour la plupart, destinés à Doxygen, qui est l'outil utilisé pour générer la documentation HTML, PS ou PDF.
-
cogxml.dtd
La DTD du format CoGXML.
-
cogitant_html/
La documentation en HTML de la bibliothèque. Pour consulter cette documentation, ouvrir le fichier index.html dans votre navigateur.
-
cogitantjava_html
La documentation en HTML de l'API Java. Pour consulter cette documentation, ouvrir le fichier index.html dans votre navigateur.
-
cogitantcs.dtd
La DTD du format d'échange entre serveur et client Cogitant.
-
docpages/
Ce répertoire contient les "sources Doxygen" du tutoriel. Vous n'avez pas besoin de ce répertoire, sauf si vous voulez modifier et regénérer la documentation.
-
include/
Répertoire contenant les fichiers header de la bibliothèque. En fait, aucun fichier ne réside dans ce répertoire, mais ils figurent tous dans le sous répertoire cogitant afin de pouvoir copier facilement ce répertoire dans un répertoire standard (/usr/local/include par exemple) et rendre ainsi les fichiers accessibles par un #include "cogitant/xxx.h"
-
cogitant/
Fichiers header de la bibliothèque.
-
cs/
Fichiers header de l'extension client-serveur de la bibliothèque.
-
display/
Fichiers header de l'extension de la bibliothèque permettant l'affichage de graphes.
-
java/
Fichiers header permettant l'interfacage avec java.
-
samples/
Des exemples de programmes utilisant la bibliothèque ainsi que des fichiers contenant graphes et supports.
-
bcgct/
Exemples de supports, graphes et règles au format BCGCT. Chaque sous répertoire contient un support (extension bcs) et des graphes (bcg) et/ou des règles (bcr).
-
doc/
Les exemples de sources donnés dans la documentation.
-
minimal/
Un exemple de programme utilisant la bibliothèque, chargeant un support et des graphes, et calculant des projections.
-
xml/
Des exemples de fichiers au format CoGXML.
-
javadisplay/ et wxdisplay/
Deux exemples d'affichage et édition de graphes conceptuels, en utilisant respectivement l'API Java et la bibliothèque wxWidgets (voir Dessin de graphes).
-
cgiserver/
Le module d'interfacage HTTP/TCP pour le serveur Cogitant (voir Architecture client-serveur).
-
src/
Les fichiers sources de la bibliothèque. Les fichiers sources correspondant à une extension du modèle de base sont préfixés de deux lettres correspondant au nom du namespace. ir pour recherche d'informations, cs pour client/serveur et dp pour affichage.
-
test/
Des programmes de test de différentes fonctionnalités de la bibliothèque.
-
java/
Le code source Java de classes permettant d'utiliser certaines fonctionnalités de Cogitant à partir de programmes Java.
-
configure, Makefile.am, Makefile.in
Fichiers nécessaires à la compilation de la bibliothèque sous les systèmes de type Unix.
Licence d'utilisation
La bibliothèque Cogitant est distribuée sous la licence GPL (GNU General Public License) version 2. Cette licence peut être consultée dans le fichier COPYING fourni avec la bibliothèque ou à l'adresse suivante : http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
Cogitant 5 - 2000-2017
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 2 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, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- Documentation
- Cette documentation a été générée à l'aide de Doxygen
http://www.doxygen.org
écrit par Dimitri van Heesch © 1997-2017.
