MySQL 8.4.2
Source Code Documentation
Point_stepper Class Reference

For iterating points inside multipoint and linestring. More...

Inheritance diagram for Point_stepper:
[legend]

Public Member Functions

 Point_stepper (char dim, Geometry::wkbByteOrder bo, bool has_wkb_hdr)
 
const char * operator() (const char *p)
 Parsing operator. More...
 
- Public Member Functions inherited from Stepper_base
 Stepper_base (char dim, Geometry::wkbByteOrder bo, bool has_wkb_hdr, Geometry::wkbType geotype)
 Constructor. More...
 
Geometry::wkbByteOrder get_current_byte_order () const
 
Geometry::wkbType get_current_geotype () const
 

Additional Inherited Members

- Protected Attributes inherited from Stepper_base
char m_dim
 Current geometry dimension. More...
 
bool m_has_wkb_hdr
 Current geometry has a WKB header or not. More...
 
Geometry::wkbByteOrder m_bo
 Current geometry's byte order. More...
 
Geometry::wkbType m_geotype
 Current geometry's type, e.g. polygon, linestring, etc. More...
 

Detailed Description

For iterating points inside multipoint and linestring.

Expected multipoint format: NUM-pts|WKB-HDR1 pt1|WKB-HDR2 pt2|...|WKB-HDRn ptn Expected linestring format doesn't have the WKB headers.

Constructor & Destructor Documentation

◆ Point_stepper()

Point_stepper::Point_stepper ( char  dim,
Geometry::wkbByteOrder  bo,
bool  has_wkb_hdr 
)
inline

Member Function Documentation

◆ operator()()

const char * Point_stepper::operator() ( const char *  p)

Parsing operator.

Note that the returned pointer may point past end of WKB string, and caller is responsible for stopping reading after last geometry is read, this is true for all parsing operator of all stepper classes.

Parameters
ppoints to the 1st byte of a point's wkb data, right after its wkb header if any; returns the next point's wkb data's 1st byte pointer, skipping its wkb header if any.

The documentation for this class was generated from the following file: