lib/EditorGraphicBBS/bbsKernelEditorGraphic/GPortModel.h

   1 /*
   2 # ---------------------------------------------------------------------
   3 #
   4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   5 #                        pour la Santé)
   6 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   7 #
   8 #  This software is governed by the CeCILL-B license under French law and
   9 #  abiding by the rules of distribution of free software. You can  use,
  10 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  11 #  license as circulated by CEA, CNRS and INRIA at the following URL
  12 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  13 #  or in the file LICENSE.txt.
  14 #
  15 #  As a counterpart to the access to the source code and  rights to copy,
  16 #  modify and redistribute granted by the license, users are provided only
  17 #  with a limited warranty  and the software's author,  the holder of the
  18 #  economic rights,  and the successive licensors  have only  limited
  19 #  liability.
  20 #
  21 #  The fact that you are presently reading this means that you have had
  22 #  knowledge of the CeCILL-B license and that you accept its terms.
  23 # ------------------------------------------------------------------------
  24 */
  25
  26 /*=========================================================================
  27 Program:   bbtk
  28 Module:    $RCSfile$
  29 Language:  C++
  30 Date:      $Date$
  31 Version:   $Revision$
  32 =========================================================================*/
  33
  34 /* ---------------------------------------------------------------------
  35
  36 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
  37 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
  38 *
  39 *  This software is governed by the CeCILL-B license under French law and
  40 *  abiding by the rules of distribution of free software. You can  use,
  41 *  modify and/ or redistribute the software under the terms of the CeCILL-B
  42 *  license as circulated by CEA, CNRS and INRIA at the following URL
  43 *  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  44 *  or in the file LICENSE.txt.
  45 *
  46 *  As a counterpart to the access to the source code and  rights to copy,
  47 *  modify and redistribute granted by the license, users are provided only
  48 *  with a limited warranty  and the software's author,  the holder of the
  49 *  economic rights,  and the successive licensors  have only  limited
  50 *  liability.
  51 *
  52 *  The fact that you are presently reading this means that you have had
  53 *  knowledge of the CeCILL-B license and that you accept its terms.
  54 * ------------------------------------------------------------------------ */
  55
  56
  57
  58 /**
  59 *  \file
  60 *  \brief Class bbtk::GPortModel : abstract black-box interface.
  61 */
  62
  63 /****
  64 * Design and Developpement of BBTK GEditor
  65 * Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
  66 * RaC - 2010
  67 ****/
  68
  69 #ifndef __GPortModel_h__
  70 #define __GPortModel_h__
  71
  72 //Includes same project
  73 #include "GlobalConstants.h"
  74 #include "GObjectModel.h"
  75 #include "GBoxModel.h"
  76
  77 //Includes creaMaracasVisu
  78
  79 //Includes std
  80 #include <iostream>
  81
  82
  83 namespace bbtk
  84 {
  85
  86         // Mandatory when exists a bidirectional relation: GPortModel includes GBoxModel and viceversa
  87         class GBoxModel;
  88
  89         class GPortModel : public GObjectModel
  90         {
  91
  92         public:
  93
  94                 //Constructors
  95                 GPortModel();
  96                 virtual ~GPortModel();
  97
  98                 //Public methods
  99
 100                 // Register the input or output in a position of the black box, depending in the portType(INPUT/OUTPUT).
 101                 void registerInBox(GBoxModel *blackBox,int portType, int pos);
 102
 103                 // Update the port position based in the parent box initial point
 104                 void updatePortPosition();
 105
 106                 // Port type (INPUT/OUTPUT)
 107                 int getPortType();
 108
 109                 GBoxModel* getParentBox();
 110
 111                 // Returns the position of the port in the box
 112                 int getPosInBox();
 113
 114                 bool isConnected();
 115                 void setConnected(bool value);
 116
 117                 bool isValueSet();
 118                 void setValue(std::string value);
 119
 120                 std::string getValue();
 121
 122                 virtual std::string getStatusText();
 123                 virtual void save(std::string &content);
 124
 125         private:
 126                 //Private Attributes
 127                 GBoxModel *_parentBox;
 128                 // Port type (INPUT/OUTPUT)
 129                 int _portType;
 130                 // The position of the port in the box
 131                 int _posInBox;
 132                 bool _isConnected;
 133                 std::string _value;
 134                 bool _isValueSet;
 135                 //Private Methods
 136         protected:
 137                 //Protected methods
 138         };
 139 }
 140 // namespace bbtk
 141 #endif
 142