Skip to content

Commit

Permalink
Expand the doc and add notes
Browse files Browse the repository at this point in the history
  • Loading branch information
oleg-alexandrov committed Nov 11, 2023
1 parent fa6bf64 commit 9af6f7a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
7 changes: 4 additions & 3 deletions doc/development/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 2 additions & 0 deletions pdal/PointTable.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,8 @@ class PDAL_DLL StreamPointTable : public SimplePointTable
std::vector<bool> m_skips;
};

// A concrete implementation of StreamPointTable that uses a fixed-size
// buffer for point data.
class PDAL_DLL FixedPointTable : public StreamPointTable
{
public:
Expand Down

0 comments on commit 9af6f7a

Please sign in to comment.