Salome HOME
NRI : Merge from V1_2.
[modules/med.git] / src / MEDMEM / MEDMEM_Group.hxx
index 29f0e1f005a9af662d05c5a30bbacf329b3f928a..c19dcdbba7064f8db294156b51815af3671eea27 100644 (file)
@@ -1,3 +1,29 @@
+//  MED MEDMEM : MED files in memory
+//
+//  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
+// 
+//  This library is free software; you can redistribute it and/or 
+//  modify it under the terms of the GNU Lesser General Public 
+//  License as published by the Free Software Foundation; either 
+//  version 2.1 of the License. 
+// 
+//  This library is distributed in the hope that it will be useful, 
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of 
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
+//  Lesser General Public License for more details. 
+// 
+//  You should have received a copy of the GNU Lesser General Public 
+//  License along with this library; if not, write to the Free Software 
+//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
+// 
+//  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org 
+//
+//
+//
+//  File   : MEDMEM_Group.hxx
+//  Module : MED
+
 /*
  File Group.hxx
  $Header$
 
 class FAMILY;
 
+/*!
+
+  This class describe a group of elements on an entity./n
+  It inherits from SUPPORT./n
+  It is a blending of some FAMILY class./n/n
+
+*/
+
 class GROUP : public SUPPORT
 {
 protected :
-                                 /*! Number of families in the group */
+  /*!
+    \if developper
+    Number of families in the group.
+  */
   int             _numberOfFamilies ;
-                                 /*! Vector of families in the group */
+  /*!
+    \if developper
+    Vector of families in the group.
+    Note that Families are numbered from 1 to N.
+  */
   vector<FAMILY*> _family ;
   
 public:
+  /*! Constructor. */
   GROUP();
-  GROUP(const string & name, const list<FAMILY*> & family);
+  /*! Constructor. */
+  GROUP(const string & name, const list<FAMILY*> & family) throw (MEDEXCEPTION) ;
+  /*! Copy Constructor. */
+  GROUP(const GROUP & m);
+  /*! Destructor. */
   ~GROUP();
+
+  /*! Copy operator. */
+  // PN ATTention il n y a pas de copie du vecteur Family ????
   GROUP & operator=(const GROUP &group);
-  
+
+  /*! Operator << */
+  friend ostream & operator<<(ostream &os, GROUP &my) ;
+
   inline void setNumberOfFamilies(int numberOfFamilies);
   inline void setFamilies(vector<FAMILY*> Family);
   
@@ -34,7 +86,6 @@ public:
   inline vector<FAMILY*> getFamilies() const ;
   inline FAMILY *       getFamily(int i) const ;
 
-  void init(const list<FAMILY*> & family);
 };
 
 // inline method :