Salome HOME
Final version of the V2_2_0 in the main trunk of the CVS tree.
[modules/med.git] / src / MEDMEM / MEDMEM_Coordinate.hxx
1 /*
2  File Coordinate.hxx
3  $Header$
4 */
5
6 #ifndef COORDINATE_HXX
7 #define COORDINATE_HXX
8
9 #include <string>
10
11 #include "MEDMEM_PointerOf.hxx"
12 #include "MEDMEM_Exception.hxx"
13 #include "MEDMEM_define.hxx"
14
15
16 #include "MEDMEM_Array.hxx"
17
18 /*!
19     This class contains coordinates of the nodes .\n
20     It could also store useful optional information about nodes
21     as  node numbers and about axes as names or units. \n
22     spaceDimension and  numberOfNodes can be found in _coordinate object.
23 */
24
25 namespace MEDMEM {
26 class COORDINATE
27 {
28
29 protected:
30                                     /*! contains "CARTESIAN",
31                                         "CYLINDRICAL" or "SPHERICAL"*/
32   string                       _coordinateSystem;
33
34
35                                      /*! _coordinate is a MEDARRAY<double> object : \n
36                                          - spaceDimension \n
37                                          - numberOfNodes \n
38                                          - default storage mode \n
39                                          - Up to 4 "PointerOf" to an array of size spaceDimension*NumberOfNodes\n
40
41                                          Storing the object (not a pointer to this object) is more convenient for memory
42                                          management.
43                                          */
44   mutable MEDARRAY<double>            _coordinate;
45
46                                      /*! PointerOf to an array of size spaceDimension storing axes names*/
47   PointerOf<string>          _coordinateName;
48
49                                      /*! PointerOf to an array of size spaceDimension storing units */
50   PointerOf<string>          _coordinateUnit;
51
52                                      /*! PointerOf to an array of size NumberOfNodes : optional nodes numbers */
53   PointerOf<int>             _nodeNumber;
54
55
56 public :
57
58   friend class MED_MESH_RDONLY_DRIVER;
59   friend class MED_MESH_WRONLY_DRIVER;
60
61
62   COORDINATE();
63   COORDINATE(int SpaceDimension, int NumberOfNodes, MED_EN::medModeSwitch Mode);
64   COORDINATE(int SpaceDimension,const string * CoordinateName, const string * CoordinateUnit);
65   COORDINATE(const COORDINATE & m);
66   virtual ~COORDINATE();
67
68   void setCoordinates(MEDARRAY<double> *Coordinate,bool shallowCopy=false);
69   void setCoordinates(const MED_EN::medModeSwitch Mode, const double *Coordinate);
70   void setCoordinatesNames(const string * CoordinateName);
71   void setCoordinateName(const string CoordinateName, const int i);
72   void setCoordinatesUnits(const string * CoordinateUnit);
73   void setCoordinateUnit(const string CoordinateUnit, const int i);
74   void setCoordinatesSystem(const string CoordinateSystem);
75   void setNodesNumbers(const int * NodeNumber);
76
77   int             getSpaceDimension() const;
78   int             getNumberOfNodes() const;
79
80   virtual const int*      getNodesNumbers() const;
81   //const int*            getNodesNumbers() ;
82   string          getCoordinatesSystem() const;
83
84   virtual const double *  getCoordinates(MED_EN::medModeSwitch Mode);
85   virtual double          getCoordinate(int Number,int Axis);
86   virtual const double *  getCoordinateAxis(int Axis);
87
88   const string * getCoordinatesNames() const;
89   string   getCoordinateName(int Axis) const;
90   const string * getCoordinatesUnits() const;
91   string   getCoordinateUnit(int Axis) const;
92 };
93 };
94
95 #endif /* COORDINATE_HXX */