From 41a3d1c448ced0bb1ee30f0ccef857d015a37ff5 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Tue, 19 Jan 2021 16:43:17 +0000 Subject: [PATCH] Add initial version of doc of with_info classes --- ..._Delaunay_graph_storage_site_with_info_2.h | 50 +++++++++++++++++++ ...elaunay_graph_storage_traits_with_info_2.h | 35 +++++++++++++ .../PackageDescription.txt | 3 +- 3 files changed, 87 insertions(+), 1 deletion(-) create mode 100644 Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_site_with_info_2.h create mode 100644 Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_traits_with_info_2.h diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_site_with_info_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_site_with_info_2.h new file mode 100644 index 00000000000..fc8180ff3d8 --- /dev/null +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_site_with_info_2.h @@ -0,0 +1,50 @@ + +namespace CGAL { + +/*! +\ingroup PkgSegmentDelaunayGraph2Ref + +The class `Segment_Delaunay_graph_storage_site_with_info_2` is a model for the concept +`SegmentDelaunayGraphStorageSite_2`. + +\tparam STraits must be a model of the `SegmentDelaunayGraphStorageTraits_2` concept. +\tparam Base must be a model of `SegmentDelaunayGraphStorageSite_2` + +\cgalModels `SegmentDelaunayGraphStorageSite_2` + +\sa `CGAL::Segment_Delaunay_graph_site_2` +*/ +template< typename STraits, typename Info_, typename Base > +class Segment_Delaunay_graph_storage_site_with_info_2 : public Base { +public: + + /// \name Types + /// The class + /// @{ + + typedef STraits Storage_traits; + /*! + */ + typedef Info_ Info; + + typedef typename Storage_traits::Geom_traits Geom_traits; + typedef typename Geom_traits::Site_2 Site_2; + typedef typename Storage_traits::Point_handle Point_handle; + + struct Has_info_tag {}; + /// @} + + /*! + */ + const Info& info() const; + + /*! + */ + void set_info(const Info&) const; + + /*! + */ + bool info_has_been_set() const; + +}; /* end Segment_Delaunay_graph_storage_site_with_info_2 */ +} /* end namespace CGAL */ diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_traits_with_info_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_traits_with_info_2.h new file mode 100644 index 00000000000..eb032cea795 --- /dev/null +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_traits_with_info_2.h @@ -0,0 +1,35 @@ +namespace CGAL { + +/*! +\ingroup PkgSegmentDelaunayGraph2Ref + +The class `Segment_Delaunay_graph_storage_traits_with_info_2` provides a model for the +`SegmentDelaunayGraphStorageTraits_2` concept. + + +\tparam Gt must be a model of the concept `SegmentDelaunayGraphTraits_2`. + +\cgalModels `SegmentDelaunayGraphStorageTraits_2` + +\sa `CGAL::`Segment_Delaunay_graph_storage_site_with_info_2` +*/ + template +class Segment_Delaunay_graph_storage_traits_with_info_2 + : public Segment_Delaunay_graph_storage_traits_2 +{ +public: + /*! + */ + typedef Info_ Info; + typedef Converter Convert_info; + typedef Merger Merge_info; + typedef typename Base::Geom_traits Geom_traits; + + typedef + Segment_Delaunay_graph_storage_site_with_info_2 Storage_site_2; + +}; + +} //namespace CGAL diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt index b07d2b2a84b..947f7034f0d 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt @@ -56,7 +56,9 @@ the class - `CGAL::Segment_Delaunay_graph_2` - `CGAL::Segment_Delaunay_graph_site_2` - `CGAL::Segment_Delaunay_graph_storage_site_2` +- `CGAL::Segment_Delaunay_graph_storage_site_with_info_2` - `CGAL::Segment_Delaunay_graph_storage_traits_2` +- `CGAL::Segment_Delaunay_graph_storage_traits_with_info_2` - `CGAL::Segment_Delaunay_graph_vertex_base_2` - `CGAL::Segment_Delaunay_graph_face_base_2` - `CGAL::Segment_Delaunay_graph_traits_2` @@ -67,4 +69,3 @@ the class - `CGAL::Segment_Delaunay_graph_hierarchy_vertex_base_2` */ -