• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/============================================================================
2  Boost.Geometry (aka GGL, Generic Geometry Library)
3
4  Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
5  Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
6  Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
7
8  Use, modification and distribution is subject to the Boost Software License,
9  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
10  http://www.boost.org/LICENSE_1_0.txt)
11=============================================================================/]
12
13
14[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
15[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1centroid__exception.xml]
16[section:centroid_exception centroid_exception]
17
18'''<indexterm><primary>centroid_exception</primary></indexterm>'''
19Centroid Exception.
20
21[heading Description]
22The centroid\u005fexception is thrown if the free centroid function is called with geometries for which the centroid cannot be calculated. For example: a linestring without points, a polygon without points, an empty multi-geometry.
23
24[heading Synopsis]
25``class centroid_exception
26      : public exception
27{
28  // ...
29};
30``
31
32[heading Constructor(s)]
33[table
34[[Function] [Description] [Parameters] ]
35[[``centroid_exception()``
36
37] [The default constructor. ] [
38
39]]
40]
41
42[heading Member Function(s)]
43[table
44[[Function] [Description] [Parameters]  [Returns]]
45[[``char const  * what()``
46
47] [Returns the explanatory string. ] [
48
49][
50Pointer to a null-terminated string with explanatory information.
51
52]
53]
54]
55
56[heading Header]
57Either
58
59`#include <boost/geometry.hpp>`
60
61
62Or
63
64`#include <boost/geometry/algorithms/centroid.hpp>`
65
66[heading See also]
67* [link geometry.reference.algorithms.centroid the centroid function]
68
69[endsect]
70
71