Documentation of the wxLibrary

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

diff --git a/lib/EditorGraphicBBS/bbsKernelEditorGraphic/GConnectorModel.h b/lib/EditorGraphicBBS/bbsKernelEditorGraphic/GConnectorModel.h
index d590b849aae30daf7553a206b15ca8ad2a35466d..9a79ad4fcc39e3d3710b81876e612ea66fa03b33 100644 (file)
--- a/lib/EditorGraphicBBS/bbsKernelEditorGraphic/GConnectorModel.h
+++ b/lib/EditorGraphicBBS/bbsKernelEditorGraphic/GConnectorModel.h
@@ -29,16 +29,11 @@ Version:   $Revision$
 * ------------------------------------------------------------------------ */                                                                         
 
 
-
-/**
-*  \file 
-*  \brief Class bbtk::GConnectorModel : abstract black-box interface. 
-*/
-
-/**
-* \class bbtk::GConnectorModel
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __GConnectorModel_h__
 #define __GConnectorModel_h__
@@ -67,29 +62,44 @@ namespace bbtk
                GConnectorModel();
                ~GConnectorModel();
                
-               //Public methods                
+               //Public methods
+
+               // Sets the start port of the connection that will be used in the manualContourModel
                void setStartPort(GPortModel* startPort);
+
+               // Sets the end port in the BBTKGEditor connector model and also in the contour model
                void setEndPort(GPortModel* endPort);
+
+               // Assigns the creaMaracasVisu model
                void setManualContourModel(manualContourModel* model);
+               manualContourModel* getManualContourModel();
 
                GPortModel* getStartPort();
                GPortModel* getEndPort();               
-               manualContourModel* getManualContourModel();
+
+               // Refresh the position of the contourModel first and last points with the data of the connector model
                void updateStartEndPoints();
+
+               // Set the ports as NO connected
                void disconnectConnection();
-               virtual bool isPointInside(double x,double y, double z);
+
                virtual void save(std::string &content);
                
        private:
 
-               //Attributes
+               //Private Attributes
+
                GPortModel* _startPort;
                GPortModel* _endPort;
+
                manualContourModel* _model;
 
                //Private Methods
 
        protected:
+
+               //Protected Attributes
+
                //Protected methods
                
        };