A collection of geometries. More...

#include <geometries.h>

Inheritance diagram for gis::Geometrycollection:

Public Member Functions
Geometry_type	type () const override
	Gets the geometry type of the object. More...

bool	accept (Geometry_visitor *v) override=0
	Applies a hierarchical visitor to this geometry. More...

virtual void	push_back (const Geometry &g)=0
	Adds a geometry to the collection. More...

virtual void	push_back (Geometry &&g)=0

virtual void	pop_front ()=0
	Removes a geometry from the front of the collection. More...

virtual bool	empty () const =0
	Checks if the collection is empty. More...

virtual std::size_t	size () const =0
	Returns the size of the geometrycollection. More...

virtual void	resize (std::size_t count)=0
	Resizes the geometrycollection to contain a given number of elements. More...

virtual void	clear () noexcept=0
	Removes all geometries from the geometrycollection. More...

virtual Geometry &	front ()=0
	Returns the first geometry of the collection. More...

virtual const Geometry &	front () const =0

virtual Geometry &	operator[] (std::size_t i)=0

virtual const Geometry &	operator[] (std::size_t i) const =0

Geometrycollection *	clone () const override=0
	Clone pattern to easily duplicate a Geometrycollection. More...

Public Member Functions inherited from gis::Geometry
	Geometry ()=default

virtual	~Geometry ()=default

	Geometry (const Geometry &)=default

Geometry &	operator= (const Geometry &)=default

virtual Coordinate_system	coordinate_system () const =0
	Gets the coordinate system. More...

virtual bool	is_empty () const =0
	Check if this is an empty geometry. More...

Static Public Member Functions
static Geometrycollection *	CreateGeometrycollection (Coordinate_system coordinate_system)
	Creates a subclass of Geometrycollection from a Coordinate_system. More...

static Geometrycollection *	create_geometrycollection (Coordinate_system coordinate_system)
	Creates a subclass from a Coordinate_system. More...

Detailed Description

A collection of geometries.

Geometrycollection is an instantiable type in SQL. It is the only instantiable non-leaf geometry type.

The Geometrycollection class places no restrictions on type, overlapping, etc. Subclasses do.

Member Function Documentation

◆ accept()

bool gis::Geometrycollection::accept ( Geometry_visitor * v )

overridepure virtual

Applies a hierarchical visitor to this geometry.

See also: gis::Geometry_visitor

Parameters

v	A hierarchical visitor.

Return values

true	The execution was aborted by the visitor.
false	The execution completed.

Implements gis::Geometry.

Implemented in gis::Cartesian_geometrycollection, gis::Geographic_geometrycollection, gis::Cartesian_multipoint, gis::Geographic_multipoint, gis::Cartesian_multilinestring, gis::Geographic_multilinestring, gis::Cartesian_multipolygon, gis::Geographic_multipolygon, gis::Multipoint, gis::Multicurve, gis::Multilinestring, gis::Multisurface, and gis::Multipolygon.

◆ clear()

virtual void gis::Geometrycollection::clear ( )

pure virtualnoexcept

Removes all geometries from the geometrycollection.

Implemented in gis::Cartesian_geometrycollection, gis::Geographic_geometrycollection, gis::Cartesian_multipoint, gis::Geographic_multipoint, gis::Cartesian_multilinestring, gis::Geographic_multilinestring, gis::Cartesian_multipolygon, and gis::Geographic_multipolygon.

◆ clone()

Geometrycollection * gis::Geometrycollection::clone ( ) const

overridepure virtual

Clone pattern to easily duplicate a Geometrycollection.

Returns: A pointer to a copy of the Geometrycollection that caller must free when it is done with it.

Implements gis::Geometry.

Implemented in gis::Cartesian_geometrycollection, gis::Geographic_geometrycollection, gis::Cartesian_multipoint, gis::Geographic_multipoint, gis::Cartesian_multilinestring, gis::Geographic_multilinestring, gis::Cartesian_multipolygon, gis::Geographic_multipolygon, gis::Multipoint, gis::Multilinestring, and gis::Multipolygon.

◆ create_geometrycollection()

Geometrycollection * gis::Geometrycollection::create_geometrycollection ( Coordinate_system coordinate_system )

static

Creates a subclass from a Coordinate_system.

Parameters

[in] coordinate_system Coordinate system to create a geometrycollection for

Returns: A pointer to a Geometrycollection that caller must free when it is done with it.

◆ CreateGeometrycollection()

static Geometrycollection * gis::Geometrycollection::CreateGeometrycollection ( Coordinate_system coordinate_system )

static

Creates a subclass of Geometrycollection from a Coordinate_system.

Parameters

[in] coordinate_system Coordinate system to create a Geometrycollection for.

Returns: A pointer to a Geometrycollection that caller must free when it is done with it.

◆ empty()

virtual bool gis::Geometrycollection::empty ( ) const

pure virtual

Checks if the collection is empty.

Return values

true	The polygon is empty.
false	The polygon is not empty.

Implemented in gis::Cartesian_geometrycollection, gis::Geographic_geometrycollection, gis::Cartesian_multipoint, gis::Geographic_multipoint, gis::Cartesian_multilinestring, gis::Geographic_multilinestring, gis::Cartesian_multipolygon, and gis::Geographic_multipolygon.

◆ front() [1/2]

virtual const Geometry & gis::Geometrycollection::front ( ) const

pure virtual

Implemented in gis::Cartesian_geometrycollection, gis::Geographic_geometrycollection, gis::Cartesian_multipoint, gis::Geographic_multipoint, gis::Cartesian_multilinestring, gis::Geographic_multilinestring, gis::Cartesian_multipolygon, gis::Geographic_multipolygon, gis::Multipoint, gis::Multilinestring, and gis::Multipolygon.

◆ front() [2/2]

virtual Geometry & gis::Geometrycollection::front ( )

pure virtual

Returns the first geometry of the collection.

Returns: First geometry of the collection

Implemented in gis::Cartesian_geometrycollection, gis::Geographic_geometrycollection, gis::Cartesian_multipoint, gis::Geographic_multipoint, gis::Cartesian_multilinestring, gis::Geographic_multilinestring, gis::Cartesian_multipolygon, gis::Geographic_multipolygon, gis::Multipoint, gis::Multilinestring, and gis::Multipolygon.

◆ operator[]() [1/2]

virtual const Geometry & gis::Geometrycollection::operator[] ( std::size_t i ) const

pure virtual

Implemented in gis::Cartesian_geometrycollection, gis::Geographic_geometrycollection, gis::Cartesian_multipoint, gis::Geographic_multipoint, gis::Cartesian_multilinestring, gis::Geographic_multilinestring, gis::Cartesian_multipolygon, and gis::Geographic_multipolygon.

◆ operator[]() [2/2]

virtual Geometry & gis::Geometrycollection::operator[] ( std::size_t i )

pure virtual

Implemented in gis::Cartesian_geometrycollection, gis::Geographic_geometrycollection, gis::Cartesian_multipoint, gis::Geographic_multipoint, gis::Cartesian_multilinestring, gis::Geographic_multilinestring, gis::Cartesian_multipolygon, and gis::Geographic_multipolygon.

◆ pop_front()

virtual void gis::Geometrycollection::pop_front ( )

pure virtual

Removes a geometry from the front of the collection.

Implemented in gis::Cartesian_geometrycollection, gis::Geographic_geometrycollection, gis::Cartesian_multipoint, gis::Geographic_multipoint, gis::Cartesian_multilinestring, gis::Geographic_multilinestring, gis::Cartesian_multipolygon, and gis::Geographic_multipolygon.

◆ push_back() [1/2]

virtual void gis::Geometrycollection::push_back ( const Geometry & g )

pure virtual

Adds a geometry to the collection.

Parameters

g	The geometry to add.

Implemented in gis::Cartesian_geometrycollection, gis::Geographic_geometrycollection, gis::Cartesian_multipoint, gis::Geographic_multipoint, gis::Cartesian_multilinestring, gis::Geographic_multilinestring, gis::Cartesian_multipolygon, and gis::Geographic_multipolygon.

◆ push_back() [2/2]

virtual void gis::Geometrycollection::push_back ( Geometry && g )

pure virtual

Implemented in gis::Cartesian_geometrycollection, gis::Geographic_geometrycollection, gis::Cartesian_multipoint, gis::Geographic_multipoint, gis::Cartesian_multilinestring, gis::Geographic_multilinestring, gis::Cartesian_multipolygon, and gis::Geographic_multipolygon.

◆ resize()

virtual void gis::Geometrycollection::resize ( std::size_t count )

pure virtual

Resizes the geometrycollection to contain a given number of elements.

If the new size is smaller than the current size, the remaining geometries are discarded.

Parameters

[in] count The new number of geometries.

Implemented in gis::Cartesian_geometrycollection, gis::Geographic_geometrycollection, gis::Cartesian_multipoint, gis::Geographic_multipoint, gis::Cartesian_multilinestring, gis::Geographic_multilinestring, gis::Cartesian_multipolygon, and gis::Geographic_multipolygon.

◆ size()

virtual std::size_t gis::Geometrycollection::size ( ) const

pure virtual

Returns the size of the geometrycollection.

Returns: Number of geometries in the geometrycollection.

Implemented in gis::Cartesian_geometrycollection, gis::Geographic_geometrycollection, gis::Cartesian_multipoint, gis::Geographic_multipoint, gis::Cartesian_multilinestring, gis::Geographic_multilinestring, gis::Cartesian_multipolygon, and gis::Geographic_multipolygon.

◆ type()

Geometry_type gis::Geometrycollection::type ( ) const

inlineoverridevirtual

Gets the geometry type of the object.

Returns: The type of this object

Implements gis::Geometry.

Reimplemented in gis::Multipoint, gis::Multilinestring, gis::Multipolygon, gis::Multicurve, and gis::Multisurface.

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

sql/gis/geometries.h
sql/gis/geometries.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ accept()

◆ clear()

◆ clone()

◆ create_geometrycollection()

◆ CreateGeometrycollection()

◆ empty()

◆ front() [1/2]

◆ front() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ pop_front()

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ resize()

◆ size()

◆ type()