• 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_1model_1_1linestring.xml]
16[section:model_linestring model::linestring]
17
18'''<indexterm><primary>model</primary></indexterm><indexterm><primary>linestring</primary></indexterm>'''
19A linestring (named so by OGC) is a collection (default a vector) of points.
20
21[heading Model of]
22[link geometry.reference.concepts.concept_linestring Linestring Concept]
23
24[heading Synopsis]
25``template<typename Point, template< typename, typename > class Container, template< typename > class Allocator>
26class model::linestring
27      : public Container< Point, Allocator< Point > >
28{
29  // ...
30};
31``
32
33[heading Template parameter(s)]
34[table
35[[Parameter] [Default] [Description]]
36[[typename Point] [] [Any type fulfilling a Point Concept ]]
37[[template< typename, typename > class Container] [std::vector] [container type, for example std::vector, std::deque ]]
38[[template< typename > class Allocator] [std::allocator] [container-allocator-type]]
39]
40
41[heading Constructor(s)]
42[table
43[[Function] [Description] [Parameters] ]
44[[``linestring()``
45
46] [Default constructor, creating an empty linestring. ] [
47
48]]
49[[``template<typename Iterator>
50linestring(Iterator begin, Iterator end)``
51
52] [Constructor with begin and end, filling the linestring. ] [[* Iterator]: ['begin]:
53
54[* Iterator]: ['end]:
55
56
57
58]]
59[[``linestring(std::initializer_list< Point > l)``
60
61] [Constructor taking std::initializer_list, filling the linestring. ] [[* std::initializer_list< Point >]: ['l]:
62
63
64
65]]
66]
67
68[heading Header]
69Either
70
71`#include <boost/geometry/geometries/geometries.hpp>`
72
73
74Or
75
76`#include <boost/geometry/geometries/linestring.hpp>`
77
78[include reference/geometries/linestring.qbk]
79
80[endsect]
81
82