Module: RGeo::Feature::GeometryCollection

Extended by:
Type
Includes:
Enumerable, Geometry
Included in:
Cartesian::GeometryCollectionImpl, MultiCurve, MultiPoint, MultiSurface, Geographic::ProjectedGeometryCollectionImpl, Geographic::SphericalGeometryCollectionImpl, Geos::CAPIGeometryCollectionImpl, Geos::FFIGeometryCollectionImpl
Defined in:
lib/rgeo/feature/geometry_collection.rb

Overview

SFS 1.1 Description

A GeometryCollection is a geometric object that is a collection of 1 or more geometric objects.

All the elements in a GeometryCollection shall be in the same Spatial Reference. This is also the Spatial Reference for the GeometryCollection.

GeometryCollection places no other constraints on its elements. Subclasses of GeometryCollection may restrict membership based on dimension and may also place other constraints on the degree of spatial overlap between elements.

Notes

GeometryCollection is defined as a module and is provided primarily for the sake of documentation. Implementations need not necessarily include this module itself. Therefore, you should not depend on the kind_of? method to check type. Instead, use the provided check_type class method (or === operator) defined in the Type module.

Instance Method Summary collapse

Methods included from Type

add_subtype, check_type, each_immediate_subtype, extended, subtype_of?, supertype, type_name

Methods included from Geometry

#*, #+, #-, #==, #as_binary, #as_text, #boundary, #buffer, #contains?, #convex_hull, #coordinate_dimension, #crosses?, #difference, #dimension, #disjoint?, #distance, #empty?, #envelope, #eql?, #equals?, #factory, #geometry_type, #intersection, #intersects?, #is_3d?, #locate_along, #locate_between, #measured?, #overlaps?, #relate?, #rep_equals?, #simple?, #spatial_dimension, #srid, #sym_difference, #touches?, #transform, #unary_union, #union, #within?

Instance Method Details

#[](_idx) ⇒ Object

Returns the Nth geometry in this GeometryCollection, or nil if the given N is out of range. N is zero-based.

This behaves slightly different from GeometryCollection#geometry_n. GeometryCollection#geometry_n accepts only nonnegative indexes, as specified by the SFS. However, GeometryCollection#[] also accepts negative indexes counting backwards from the end of the collection, the same way Ruby’s array indexing works. Hence, geometry_n(-1) returns nil, where [-1] returns the last element of the collection.

Raises:



80
81
82
 
# File 'lib/rgeo/feature/geometry_collection.rb', line 80

def [](_idx)
  raise Error::UnsupportedOperation, "Method #{self.class}#[] not defined."
end

#each(&_block) ⇒ Object

Iterates over the geometries of this GeometryCollection.

This is not a standard SFS method, but is provided so that a GeometryCollection can behave as a Ruby enumerable. Note that all GeometryCollection implementations must also include the Enumerable mixin.

Raises:



97
98
99
 
# File 'lib/rgeo/feature/geometry_collection.rb', line 97

def each(&_block)
  raise Error::UnsupportedOperation, "Method #{self.class}#each not defined."
end

#geometry_n(_idx) ⇒ Object

SFS 1.1 Description

Returns the Nth geometry in this GeometryCollection.

Notes

Returns an object that supports the Geometry interface, or nil if the given N is out of range. N is zero-based. Also note that this method is different from GeometryCollection#[] in that it does not support negative indexes.

Raises:



60
61
62
 
# File 'lib/rgeo/feature/geometry_collection.rb', line 60

def geometry_n(_idx)
  raise Error::UnsupportedOperation, "Method #{self.class}#geometry_n not defined."
end

#node ⇒ Object

Nodes the linework in a list of Geometries

Raises:



86
87
88
 
# File 'lib/rgeo/feature/geometry_collection.rb', line 86

def node
  raise Error::UnsupportedOperation, "Method #{self.class}#node not defined."
end

#num_geometries ⇒ Object

SFS 1.1 Description

Returns the number of geometries in this GeometryCollection.

Notes

Returns an integer.

Raises:



45
46
47
 
# File 'lib/rgeo/feature/geometry_collection.rb', line 45

def num_geometries
  raise Error::UnsupportedOperation, "Method #{self.class}#num_geometries not defined."
end

#point_on_surface ⇒ Object

Gives a point that is guaranteed to be within the geometry.

Extends OGC SFS 1.1 and follows PostGIS standards.

Raises:

See Also:



105
106
107
 
# File 'lib/rgeo/feature/geometry_collection.rb', line 105

def point_on_surface
  raise Error::UnsupportedOperation, "Method #{self.class}#each not defined."
end

#size ⇒ Object

Alias of the num_geometries method.



66
67
68
 
# File 'lib/rgeo/feature/geometry_collection.rb', line 66

def size
  num_geometries
end