Documentation of the wxLibrary

[bbtkGEditor.git] / lib / EditorGraphicBBS / bbsKernelEditorGraphic / GBlackBoxModel.h

diff --git a/lib/EditorGraphicBBS/bbsKernelEditorGraphic/GBlackBoxModel.h b/lib/EditorGraphicBBS/bbsKernelEditorGraphic/GBlackBoxModel.h
index a45910235a0d3fd33297bff3310c030f343be1b9..f6ad73bd883d053a4a6a45edebdbbcc6fd8317ee 100644 (file)
--- a/lib/EditorGraphicBBS/bbsKernelEditorGraphic/GBlackBoxModel.h
+++ b/lib/EditorGraphicBBS/bbsKernelEditorGraphic/GBlackBoxModel.h
@@ -9,7 +9,7 @@ Version:   $Revision$
 /* ---------------------------------------------------------------------
 
 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
-* Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
+* Authors : Ricardo A Corredor, Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
 *
 *  This software is governed by the CeCILL-B license under French law and 
 *  abiding by the rules of distribution of free software. You can  use, 
@@ -28,17 +28,11 @@ Version:   $Revision$
 *  knowledge of the CeCILL-B license and that you accept its terms.
 * ------------------------------------------------------------------------ */                                                                         
 
-
-
-/**
-*  \file 
-*  \brief Class bbtk::GBlackBox : abstract black-box interface. 
-*/
-
-/**
-* \class bbtk::GBlackBox
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __GBlackBoxModel_h__
 #define __GBlackBoxModel_h__
@@ -65,23 +59,37 @@ namespace bbtk
                GBlackBoxModel();
                ~GBlackBoxModel();
                
-               //Public methods                
+               //Public methods
+
+               // The black box has an specific package (important to search in the list with the BBTK Interpreter)
                std::string getBBTKPackage();
                void setBBTKPackage(std::string obpackage);
 
+               // Text in the status bar
                virtual std::string getStatusText();
+
+               // Method to write the information of the black box to be saved in the parameter string
                virtual void save(std::string &content);
 
+               // Is the black box executable or not
                bool isExecutable();
                void setExecutable(bool executable);
 
+               // Set 'value' to the port in position 'pos'
                void setValueToInputPort(int pos,std::string value);
+               
+               // Set 'value' to the port with name 'name'
                void setValueToInput(std::string name,std::string value);
 
+               // Get the value of the port in position 'pos'
                std::string getValueInputPort(int pos);
+
+               // Get the value of the port with name 'name'
                std::string getValueInput(std::string name);
 
+               // Get id's of the connected inputs 
                std::vector<int> getConnectedInputs();
+               // Get id's of the connected outputs
                std::vector<int> getConnectedOutputs();
 
        private: