added source items

[blast.git] / ConnectedInterface.h

diff --git a/ConnectedInterface.h b/ConnectedInterface.h
index a8ce4de7861bda09abe777c8e0fc8948975c6b49..fc89e22c31a811d5e41b137dc0db85e8b67621da 100644 (file)
--- a/ConnectedInterface.h
+++ b/ConnectedInterface.h
@@ -14,7 +14,10 @@ class ReferenceInterface;
 using namespace std;
 using namespace Qt;
 
 using namespace std;
 using namespace Qt;
 

-
+/*!
+ * \brief The ConnectedInterface class represents an interface of block (functional or group) that may be connected from/to other interfaces
+ * A ConnectedInterface is used to establish connection between blocks.
+ */

 class ConnectedInterface : public AbstractInterface {
 
 public :
 class ConnectedInterface : public AbstractInterface {
 
 public :


@@ -33,14 +36,13 @@ public :
   virtual bool canConnectTo(AbstractInterface* iface) = 0;
   virtual bool canConnectFrom(AbstractInterface* iface) = 0;
 
   virtual bool canConnectTo(AbstractInterface* iface) = 0;
   virtual bool canConnectFrom(AbstractInterface* iface) = 0;
 

-  // others
+  // others  

   bool connectTo(ConnectedInterface* iface);
   bool connectFrom(ConnectedInterface* iface);
   ConnectedInterface* getConnectionToParentGroup();
   ConnectedInterface* getConnectionFromParentGroup();
 
   bool connectTo(ConnectedInterface* iface);
   bool connectFrom(ConnectedInterface* iface);
   ConnectedInterface* getConnectionToParentGroup();
   ConnectedInterface* getConnectionFromParentGroup();
 

-  virtual AbstractInterface *clone() = 0;
-
+  virtual AbstractInterface *clone() = 0;  

   void removeConnectedTo(ConnectedInterface *inter);
 
   virtual void clearConnectedTo();
   void removeConnectedTo(ConnectedInterface *inter);
 
   virtual void clearConnectedTo();


@@ -49,9 +51,20 @@ public :
   //virtual void connectionsValidation(QStack<AbstractInterface*> *interfacetoValidate, QList<AbstractInterface*> *validatedInterfaces) throw(Exception) = 0;  
 
 protected:
   //virtual void connectionsValidation(QStack<AbstractInterface*> *interfacetoValidate, QList<AbstractInterface*> *validatedInterfaces) throw(Exception) = 0;  
 
 protected:

+  /*!
+   * \brief connectedTo lists of connections to interfaces owned by other blocks (functional or group)
+   * Since the graph is oriented, and taking into account it modles a FPGA desing,
+   * this interface may be connected to several interfaces owned by other blocks (functional or group).
+   * connectedTo references such interfaces if they exist.
+   */

   QList<ConnectedInterface*> connectedTo;
   QList<ConnectedInterface*> connectedTo;

-  ConnectedInterface* connectedFrom;
-
+  /*!
+   * \brief connectedFrom connection from an interface owned by another blocks (functional or group)
+   * Since the graph is oriented, and taking into account it modles a FPGA desing,
+   * there may be a single interface owned by another block (functional or group) that is connected to
+   * this interface. connecteFrom references such an interface if it exists.
+   */
+  ConnectedInterface* connectedFrom;  

 };
 
 
 };