lib/EditorGraphicBBS/bbsKernelEditorGraphic/GPortModel.h

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