Salome HOME
b637a7c75a994de7984d3f8b005308838035ba4b
[tools/medcoupling.git] / doc / user / doxygen / fakesources / MEDCouplingPointSet.C
1 // Copyright (C) 2013-2015  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 // This file contains some code used only for
21 // * generation of documentation for inline methods of MEDCouplingPointSet
22
23 namespace ParaMEDMEM
24 {
25
26   /*!
27    * Tries to use a coordinates array of \a other mesh for \a this one. If all nodes
28    * of \a this mesh coincide, within a specified precision, with some nodes of \a
29    * other mesh, then \a this mesh refers to the coordinates array of the \a other mesh,
30    * i.e. \a this->_coords = \a other._coords. Otherwise an exception is thrown and \a
31    * this remains unchanged.
32    *  \param [in] other - the other mesh.
33    *  \param [in] epsilon - the precision to compare node coordinates of the two meshes.
34    *  \throw If the coordinates array of \a this is not set.
35    *  \throw If the coordinates array of \a other is not set.
36    *  \throw If not all nodes of \a this mesh are present in the \a other mesh.
37    */
38   void MEDCouplingPointSet::tryToShareSameCoordsPermute(const MEDCouplingPointSet& other, double epsilon) throw(INTERP_KERNEL::Exception) {}
39
40   /*!
41    * Returns a const pointer to the node coordinates array of \a this mesh \b without
42    * incrementing its reference counter, thus there is no need to decrRef() it by the caller.
43    */
44   const DataArrayDouble *MEDCouplingPointSet::getCoords() const { return _coords; }
45
46   /*!
47    * Returns a pointer to the node coordinates array of \a this mesh \b without
48    * incrementing its reference counter, thus there is no need to decrRef() it by the caller.
49    */
50   DataArrayDouble *MEDCouplingPointSet::getCoords() { return _coords; }
51
52
53   //! size of returned tinyInfo must be always the same.
54   void MEDCouplingPointSet::getTinySerializationInformation(std::vector<double>& tinyInfoD, std::vector<int>& tinyInfo, std::vector<std::string>& littleStrings) const {}
55 }