Quick links: Tutorial - Examples - Files - Symbols.
Classes: Hierarchy - Index - List - Members.
Namespaces: Index - base - cs - display.

Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
cogitant::OperationBase Class Referenceabstract

Classe abstraite pour toutes les opérations définies dans la bibliothèque. More...

#include "cogitant/operation.h"

Inheritance diagram for cogitant::OperationBase:
cogitant::ObservableObject cogitant::CogitantObject cogitant::Operation cogitantcs::OperationCSIO cogitantcs::OpeServer cogitantdisplay::Operation cogitant::OpeAcceptableProjection cogitant::OpeConnectedComponent cogitant::OpeConstraintSatisfaction cogitant::OpeDisjointSum cogitant::OpeGraphObjectCompatibility cogitant::OpeIndividualGraphExpand cogitant::OpeIndividualGraphMultipleExpand cogitant::OpeIrredundant cogitant::OpeNormalForm cogitant::OpeProjAcceptableCouple cogitant::OpeProjAcceptableLIPs cogitant::OpeProjBacktrackChoice cogitant::OpeProjection cogitant::OpeProjectionImage cogitant::OpeProjLIPIndividual cogitant::OpeProjLIPInit cogitant::OpeProjLIPUpdate cogitant::OpeProjPrecalcImages cogitant::OperationCgToRdfsTranslation cogitant::OperationIO cogitant::OperationRdfsToCgTranslation cogitant::OpeRuleApplications cogitant::OpeRuleApply cogitant::OpeRulesClosure cogitant::OpeSignatureApply cogitant::OpeSupportSignatureSpecialize cogitant::OpeVerification cogitantcs::OperationCSIO_HTTP cogitantcs::OperationCSIO_Simple cogitantcs::OperationCSIO_TCP cogitantcs::OpeServerAddEdge cogitantcs::OpeServerAddGraphObject cogitantcs::OpeServerBannedTypes cogitantcs::OpeServerCommitEnvironmentObject cogitantcs::OpeServerCommitImmediateLess cogitantcs::OpeServerCommitSupportObject cogitantcs::OpeServerComparison cogitantcs::OpeServerConstraintSatisfaction cogitantcs::OpeServerCopyEnvironmentObject cogitantcs::OpeServerDelEdge cogitantcs::OpeServerDeleteEnvironment cogitantcs::OpeServerDeleteEnvironmentObject cogitantcs::OpeServerDelGraphObject cogitantcs::OpeServerEnvironment cogitantcs::OpeServerGraphObject cogitantcs::OpeServerImmediateLG cogitantcs::OpeServerLoadGraphs cogitantcs::OpeServerLoadSupport cogitantcs::OpeServerNewEnvironment cogitantcs::OpeServerNewEnvironmentObject cogitantcs::OpeServerNewSupportObject cogitantcs::OpeServerOperationConfig cogitantcs::OpeServerProjections cogitantcs::OpeServerRuleApply cogitantcs::OpeServerRulesClosure cogitantcs::OpeServerSaveEnvironmentObjects cogitantcs::OpeServerSaveSupport cogitantcs::OpeServerServer cogitantcs::OpeServerSetContent cogitantcs::OpeServerViewLog cogitantdisplay::OperationDraw cogitantdisplay::OperationLayout cogitantdisplay::OperationPropertyDialog

Public Types

typedef unsigned int Error
 Résultat de la vérification des arguments d'une opération. More...
 

Public Member Functions

virtual Error check ()=0
 Vérification des paramètres. More...
 
virtual void run ()=0
 Lancement de l'opération. More...
 
void stop ()
 Stopper l'opération dès que possible. More...
 
bool isStopped () const
 Est-ce que l'opération a été stoppée. More...
 
Constructeurs - destructeur.
 OperationBase ()
 Constructeur. More...
 
 OperationBase (OperationBase const &o)
 Constructeur par recopie. More...
 
 ~OperationBase ()
 Destructeur. More...
 
- Public Member Functions inherited from cogitant::ObservableObject
 ObservableObject ()
 Constructeur. More...
 
 ObservableObject (ObservableObject const &o)
 Constructeur par recopie. More...
 
 ~ObservableObject ()
 Destructeur. More...
 
ObserverSet const & observers () const
 Accès à l'ensemble des observateurs. More...
 
bool hasObservers () const
 Existence d'observateurs. More...
 
bool hasObservers (ObserverMessage::Type mt) const
 Existence d'observateurs qui écoutent le type de message passé. More...
 
void attachObserver (Observer *obs)
 Ajoute un nouvel observateur à l'objet. More...
 
void detachObserver (Observer *obs)
 Supprime le lien entre l'observateur et l'objet. More...
 
void notifyObservers (ObserverMessage const *msg)
 Envoie le message de modification à tous les observateurs. More...
 
- Public Member Functions inherited from cogitant::CogitantObject
 CogitantObject ()
 Constructeur. More...
 
 CogitantObject (CogitantObject const &o)
 Constructeur par recopie. More...
 
virtual ~CogitantObject ()
 Destructeur. More...
 
PropertySetproperties ()
 Accès à l'ensemble des propriétés. More...
 
virtual std::string toString () const
 Transformation en chaîne de caractères. More...
 
std::string className () const
 Nom de la classe. More...
 
PropertySet const * properties () const
 Accès en lecture seule à l'ensemble des propriétés. More...
 
bool hasProperties () const
 Existence de propriétés. More...
 
CogitantObjectoperator= (CogitantObject const &ob)
 Affectation. More...
 

Static Public Attributes

static const Error CHECKOK
 Pas d'erreur. More...
 
static const Error ARGUMENTS
 Certains paramètres de l'opération n'ont pas été fixés. More...
 
static const Error UNUSED
 Symbole d'erreur inutilisé. More...
 

Protected Attributes

bool m_stop
 Arrêt de l'exécution de l'opération demandé. More...
 

Additional Inherited Members

- Protected Member Functions inherited from cogitant::ObservableObject
virtual ObserverSetallocObservers () const
 Fonction créant l'instance d'une sous classe de ObserverSet pour la représentation de l'ensemble des observateurs de l'objet. More...
 
ObserverSetobservers ()
 Accès à l'ensemble des observateurs. More...
 
- Protected Member Functions inherited from cogitant::CogitantObject
virtual PropertySetallocProperties () const
 Fonction créant l'instance d'une sous classe de PropertySet pour la représentation des propriétés de l'objet. More...
 

Detailed Description

Classe abstraite pour toutes les opérations définies dans la bibliothèque.

Cette classe est racine de toutes les opérations, y compris celles qui ne font pas intervenir directement des graphes liés à un environnement, par exemple les opérations d'analyse/génération de fichiers au format XML. Les opérations opérant directement sur des graphes conceptuels sont des sous classes de Operation.

Member Typedef Documentation

typedef unsigned int cogitant::OperationBase::Error

Résultat de la vérification des arguments d'une opération.

Des valeurs de ce type sont retournées par la méthode check().

Constructor & Destructor Documentation

cogitant::OperationBase::OperationBase ( )

Constructeur.

cogitant::OperationBase::OperationBase ( OperationBase const &  o)

Constructeur par recopie.

cogitant::OperationBase::~OperationBase ( )

Destructeur.

Member Function Documentation

virtual Error cogitant::OperationBase::check ( )
pure virtual

Vérification des paramètres.

Retourne Operation::CHECKOK si l'opération peut être exécutée (méthode run()) ou un code d'erreur dans le cas contraire.

Implemented in cogitant::OpeProjectionImage, cogitant::OpeProjection, cogitant::OpeProjLIPIndividual, cogitant::OperationOutput, cogitant::OpeProjLIPUpdate, cogitant::OpeProjLIPInit, cogitant::OpeProjAcceptableLIPs, cogitant::OpeVerifCoreferenceClass, cogitant::OpeVerifBannedType, cogitant::OpeVerifConjunctiveType, cogitant::OperationInput, cogitant::OpeVerifSupportBannedType, cogitant::OpeProjAcceptableCouple, cogitant::OpeVerifConjunctive, cogitant::OpeVerifEdges, cogitant::OpeVerifConformity, cogitant::OpeProjPrecalcImages, cogitant::OpeRulesClosure, cogitant::OpeVerificationGraph, cogitant::OpeVerification, cogitant::OpeProjBacktrackChoice, cogitant::OpeRuleIrredundantProjection, cogitant::OperationCgToRdfsTranslation, cogitantcs::OperationCSIO, cogitant::OpeAcceptableProjection, cogitant::OpeSupportSignatureSpecialize, cogitant::OpeConstraintSatisfaction, cogitant::OpeRuleApply, cogitant::OpeNormalForm, cogitant::OpeIndividualGraphMultipleExpand, cogitant::OpeVerifSupportSignature, cogitant::OpeDisjointSum, cogitant::OpeIrredundant, cogitant::OpeConnectedComponent, cogitant::OperationLinearOutput, cogitantcs::OpeServer, cogitant::OpeSignatureApply, cogitant::OpeVerifIrredundant, cogitant::OperationRdfsToCgTranslation, cogitant::OpeRuleApplications, cogitant::OpeIndividualGraphExpand, cogitant::OpeGraphObjectCompatibility, cogitantdisplay::Operation, cogitant::OpeVerifNormalForm, cogitant::OpeAcceptableProjectionNonInjective, and cogitant::OpeVerifSignature.

bool cogitant::OperationBase::isStopped ( ) const
inline

Est-ce que l'opération a été stoppée.

Cette méthode peut être utilisée après un appel à run() afin de déterminer si l'opération a été prématurément stoppée ou non.

virtual void cogitant::OperationBase::run ( )
pure virtual

Lancement de l'opération.

Cette méthode ne retourne rien mais le résultat de l'opération peut être récupéré avec les méthodes getResultxxx() (différentes selon les sous classes de Operation).

Implemented in cogitant::OpeProjectionImage, cogitant::OpeProjection, cogitant::OpeProjLIPIndividual, cogitant::OperationOutput, cogitant::OpeProjLIPUpdate, cogitant::OpeProjLIPInit, cogitant::OperationRdfsN3Input, cogitantcs::OpeServerViewLog, cogitant::OpeProjAcceptableLIPs, cogitant::OpeVerifCoreferenceClass, cogitantcs::OpeServerDelEdge, cogitant::OpeVerifBannedType, cogitantcs::OpeServerAddEdge, cogitantcs::OpeServerDelGraphObject, cogitantcs::OpeServerAddGraphObject, cogitant::OpeVerifConjunctiveType, cogitant::OperationInput, cogitantcs::OpeServerOperationConfig, cogitantcs::OpeServerCopyEnvironmentObject, cogitantcs::OpeServerConstraintSatisfaction, cogitant::OpeVerifSupportBannedType, cogitantcs::OpeServerRulesClosure, cogitant::OpeProjAcceptableCouple, cogitantcs::OpeServerRuleApply, cogitantdisplay::OperationFIGOutput, cogitantdisplay::OperationPropertyDialogTabbed, cogitantdisplay::OperationPropertyDialogTabbed_Wx, cogitant::OpeVerifConjunctive, cogitantcs::OpeServerRuleApplications, cogitantcs::OpeServerProjections, cogitant::OpeVerifEdges, cogitantcs::OpeServerDeleteEnvironmentObject, cogitantcs::OpeServerDeleteEnvironment, cogitantcs::OpeServerSaveEnvironmentObjects, cogitant::OpeVerifConformity, cogitant::OpeProjPrecalcImages, cogitantcs::OpeServerLoadGraphs, cogitant::OpeRulesClosure, cogitantcs::OpeServerSaveSupport, cogitantcs::OpeServerLoadSupport, cogitantcs::OpeServerCommitImmediateLess, cogitantcs::OpeServerCommitSupportObject, cogitantcs::OpeServerNewSupportObject, cogitant::OperationBCGCTInput, cogitant::OpeProjBacktrackChoice, cogitant::OpeRuleIrredundantProjection, cogitantcs::OpeServerNewEnvironmentObject, cogitant::OperationCgToRdfsTranslation, cogitantcs::OpeServerNewEnvironment, cogitantcs::OpeServerGraphObject, cogitantcs::OpeServerBannedTypes, cogitantcs::OperationCSIO, cogitantcs::OpeServerImmediateLG, cogitantdisplay::OperationPDG_Java, cogitantcs::OpeServerComparison, cogitant::OpeAcceptableProjection, cogitantcs::OpeServerCommitEnvironmentObject, cogitant::OpeSupportSignatureSpecialize, cogitantcs::OpeServerSetContent, cogitantcs::OpeServerEnvironment, cogitantdisplay::OperationLayoutCrop, cogitant::OpeConstraintSatisfaction, cogitant::OpeRuleApply, cogitantcs::OpeServerServer, cogitant::OpeNormalForm, cogitant::OpeIndividualGraphMultipleExpand, cogitant::OpeVerifSupportSignature, cogitant::OpeDisjointSum, cogitant::OpeIrredundant, cogitant::OpeConnectedComponent, cogitant::OperationCGIFInput, cogitant::OperationInputXml, cogitant::OpeSignatureApply, cogitant::OpeVerifIrredundant, cogitant::OperationRdfsToCgTranslation, cogitant::OpeRuleApplications, cogitantdisplay::Operation, cogitant::OpeIndividualGraphExpand, cogitantdisplay::OperationGraphLayout, cogitant::OpeGraphObjectCompatibility, cogitant::OpeVerifNormalForm, cogitant::OpeAcceptableProjectionNonInjective, and cogitant::OpeVerifSignature.

void cogitant::OperationBase::stop ( )
inline

Stopper l'opération dès que possible.

Seules certaines opérations répondent à un arrêt demandé. Une fois qu'une opération a été stoppée, elle ne peut pas être reprise, et elle devrait lever une ExceptionInterrupted.

Member Data Documentation

const Error cogitant::OperationBase::ARGUMENTS
static

Certains paramètres de l'opération n'ont pas été fixés.

Certains paramètres obligatoires n'ont pas été fixés par un appel à la méthode SetParam...(). L'opération ne peut donc pas être exécutée. Se reporter à la documentation de l'opération utilisée.

const Error cogitant::OperationBase::CHECKOK
static

Pas d'erreur.

La vérification n'a détecté aucune erreur, l'opération peut donc être lancée (méthode run()).

bool cogitant::OperationBase::m_stop
protected

Arrêt de l'exécution de l'opération demandé.

Seules certaines opérations (OpeProjection) prennent en compte cet attribut qui est à true pour demander un arrêt de l'opération. Une sous-classe qui prend en compte cet attribut doit fixer sa valeur à false au début de run() puis tester régulièrement sa valeur et se terminer dans le cas où il passe à true. Ainsi, il est possible de lancer une opération dans une thread et demander, depuis une autre thread, l'arrêt de l'exécution de l'opération à l'aide de la méthode stop(). Quand l'opération se termine, elle lève une ExceptionInterrupted.

const Error cogitant::OperationBase::UNUSED
static

Symbole d'erreur inutilisé.

Toutes les valeurs supérieurs à UNUSED ne sont pas utilisées dans la plate-forme et peuvent donc être représenter des erreurs spécifiques aux opérations des utilisateurs.