PROJ C++ API
Public Member Functions | Static Public Member Functions | List of all members
osgeo::proj::metadata::GeographicBoundingBox Class Reference

Geographic position of the dataset. More...

#include <metadata.hpp>

Inheritance diagram for osgeo::proj::metadata::GeographicBoundingBox:
Inheritance graph
[legend]
Collaboration diagram for osgeo::proj::metadata::GeographicBoundingBox:
Collaboration graph
[legend]

Public Member Functions

double westBoundLongitude () PROJ_CONST_DECL
 Returns the western-most coordinate of the limit of the dataset extent. More...
 
double southBoundLatitude () PROJ_CONST_DECL
 Returns the southern-most coordinate of the limit of the dataset extent. More...
 
double eastBoundLongitude () PROJ_CONST_DECL
 Returns the eastern-most coordinate of the limit of the dataset extent. More...
 
double northBoundLatitude () PROJ_CONST_DECL
 Returns the northern-most coordinate of the limit of the dataset extent. More...
 
bool isEquivalentTo (const util::IComparable *other, util::IComparable::Criterion criterion=util::IComparable::Criterion::STRICT) const override
 Returns whether an object is equivalent to another one. More...
 
bool contains (const GeographicExtentNNPtr &other) const override
 Returns whether this extent contains the other one.
 
bool intersects (const GeographicExtentNNPtr &other) const override
 Returns whether this extent intersects the other one.
 
GeographicExtentPtr intersection (const GeographicExtentNNPtr &other) const override
 Returns the intersection of this extent with another one.
 

Static Public Member Functions

static GeographicBoundingBoxNNPtr create (double west, double south, double east, double north)
 Instanciate a GeographicBoundingBox. More...
 

Additional Inherited Members

- Public Types inherited from osgeo::proj::util::IComparable
enum  Criterion { Criterion::STRICT, Criterion::EQUIVALENT }
 Comparison criterion. More...
 

Detailed Description

Geographic position of the dataset.

This is only an approximate so specifying the co-ordinate reference system is unnecessary.

Remarks
Implements GeographicBoundingBox from GeoAPI

Member Function Documentation

GeographicBoundingBoxNNPtr osgeo::proj::metadata::GeographicBoundingBox::create ( double  west,
double  south,
double  east,
double  north 
)
static

Instanciate a GeographicBoundingBox.

If east < west, then the bounding box crosses the anti-meridian.

Parameters
westWestern-most coordinate of the limit of the dataset extent (in degrees).
southSouthern-most coordinate of the limit of the dataset extent (in degrees).
eastEastern-most coordinate of the limit of the dataset extent (in degrees).
northNorthern-most coordinate of the limit of the dataset extent (in degrees).
Returns
a new GeographicBoundingBox.
double osgeo::proj::metadata::GeographicBoundingBox::eastBoundLongitude ( )

Returns the eastern-most coordinate of the limit of the dataset extent.

The unit is degrees.

If eastBoundLongitude < westBoundLongitude(), then the bounding box crosses the anti-meridian.

bool osgeo::proj::metadata::GeographicBoundingBox::isEquivalentTo ( const util::IComparable other,
util::IComparable::Criterion  criterion = util::IComparable::Criterion::STRICT 
) const
overridevirtual

Returns whether an object is equivalent to another one.

Parameters
otherother object to compare to
criterioncomparaison criterion.
Returns
true if objects are equivalent.

Implements osgeo::proj::metadata::GeographicExtent.

double osgeo::proj::metadata::GeographicBoundingBox::northBoundLatitude ( )

Returns the northern-most coordinate of the limit of the dataset extent.

The unit is degrees.

double osgeo::proj::metadata::GeographicBoundingBox::southBoundLatitude ( )

Returns the southern-most coordinate of the limit of the dataset extent.

The unit is degrees.

double osgeo::proj::metadata::GeographicBoundingBox::westBoundLongitude ( )

Returns the western-most coordinate of the limit of the dataset extent.

The unit is degrees.

If eastBoundLongitude < westBoundLongitude(), then the bounding box crosses the anti-meridian.


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