Module: RGeo::Feature::GeometryCollection
 Extended by:
 Type
 Includes:
 Enumerable, Geometry
 Included in:
 Cartesian::GeometryCollectionImpl, MultiCurve, MultiPoint, MultiSurface, Geographic::ProjectedGeometryCollectionImpl, Geographic::SphericalGeometryCollectionImpl
 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.
Constant Summary
Constants included from Type
Instance Method Summary (collapse)

 (Object) [](n_)
Returns the Nth geometry in this GeometryCollection, or nil if the given N is out of range.

 (Object) each(&block_)
Iterates over the geometries of this GeometryCollection.

 (Object) geometry_n(n_)
SFS 1.1 Description.

 (Object) num_geometries
SFS 1.1 Description.

 (Object) size
Alias of the num_geometries method.
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, #crosses?, #difference, #dimension, #disjoint?, #distance, #envelope, #eql?, #equals?, #factory, #geometry_type, #intersection, #intersects?, #is_empty?, #is_simple?, #overlaps?, #relate, #srid, #sym_difference, #touches?, #union, #within?
Instance Method Details
 (Object) [](n_)
Returns the Nth geometry in this GeometryCollection, or nil if the given N is out of range. N is zerobased.
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.
117 118 119 
# File 'lib/rgeo/feature/geometry_collection.rb', line 117 def [](n_) raise Error::UnsupportedOperation, "Method GeometryCollection#[] not defined." end 
 (Object) each(&block_)
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.
129 130 131 
# File 'lib/rgeo/feature/geometry_collection.rb', line 129 def each(&block_) raise Error::UnsupportedOperation, "Method GeometryCollection#each not defined." end 
 (Object) geometry_n(n_)
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 zerobased. Also note that this method is different from GeometryCollection#[] in that it does not support negative indexes.
95 96 97 
# File 'lib/rgeo/feature/geometry_collection.rb', line 95 def geometry_n(n_) raise Error::UnsupportedOperation, "Method GeometryCollection#geometry_n not defined." end 
 (Object) num_geometries
SFS 1.1 Description
Returns the number of geometries in this GeometryCollection.
Notes
Returns an integer.
79 80 81 
# File 'lib/rgeo/feature/geometry_collection.rb', line 79 def num_geometries raise Error::UnsupportedOperation, "Method GeometryCollection#num_geometries not defined." end 
 (Object) size
Alias of the num_geometries method.
102 103 104 
# File 'lib/rgeo/feature/geometry_collection.rb', line 102 def size num_geometries end 