From 9af6f7a8e1c8afae93e8bf6a6e47c1cf852ffb91 Mon Sep 17 00:00:00 2001 From: Oleg Alexandrov Date: Fri, 10 Nov 2023 18:48:45 -0800 Subject: [PATCH] Expand the doc and add notes --- doc/development/overview.rst | 7 ++++--- pdal/PointTable.hpp | 2 ++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/development/overview.rst b/doc/development/overview.rst index 477ddd62f4..7f73a3a321 100755 --- a/doc/development/overview.rst +++ b/doc/development/overview.rst @@ -101,11 +101,12 @@ pipeline stages are executed. Most functions receive a PointTableRef object, which refers to the active point table. A PointTableRef can be stored or copied cheaply. -A subclass of PointTable called StreamPointTable exists to allow a pipeline -to run without loading all points in memory. A StreamPointTable holds a +A subclass of PointTable called FixedPointTable exists to allow a pipeline +to run without loading all points in memory. A FixedPointTable holds a fixed number of points. Some filters can't operate in streaming mode and an attempt to run a pipeline with a stage that doesn't support streaming -will raise an exception. +will raise an exception. A custom implementation of this can be created +by inheriting from a class called StreamPointTable. Point View ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/pdal/PointTable.hpp b/pdal/PointTable.hpp index 8c633a3809..21668021a3 100644 --- a/pdal/PointTable.hpp +++ b/pdal/PointTable.hpp @@ -274,6 +274,8 @@ class PDAL_DLL StreamPointTable : public SimplePointTable std::vector m_skips; }; +// A concrete implementation of StreamPointTable that uses a fixed-size +// buffer for point data. class PDAL_DLL FixedPointTable : public StreamPointTable { public: