Package pygeodesy :: Module gars :: Class Garef

Class Garef

      object --+            
               |            
      basestring --+        
                   |        
                 str --+    
                       |    
      object --+       |    
               |       |    
    named._Named --+   |    
                   |   |    
unitsBase._NamedUnit --+    
                       |    
           unitsBase.Str --+
                           |
                          Garef

Garef class, a named str.

Instance Methods

toLatLon(self, LatLon=None, **LatLon_kwds)
Return (the center of) this garef cell as an instance of the supplied LatLon class.

Inherited from unitsBase.Str: __call__, __repr__, __str__, join_, toRepr, toStr

Inherited from str: __add__, __contains__, __eq__, __format__, __ge__, __getattribute__, __getitem__, __getnewargs__, __getslice__, __gt__, __hash__, __le__, __len__, __lt__, __mod__, __mul__, __ne__, __rmod__, __rmul__, __sizeof__, capitalize, center, count, decode, encode, endswith, expandtabs, find, format, index, isalnum, isalpha, isdigit, islower, isspace, istitle, isupper, join, ljust, lower, lstrip, partition, replace, rfind, rindex, rjust, rpartition, rsplit, rstrip, split, splitlines, startswith, strip, swapcase, title, translate, upper, zfill

Inherited from named._Named: __imatmul__, __matmul__, __rmatmul__, attrs, classof, copy, dup, methodname, rename, toStr2

Inherited from object: __delattr__, __init__, __reduce__, __reduce_ex__, __setattr__, __subclasshook__

Static Methods

a new object with type S, a subtype of T

__new__(cls, cll, precision=1, name='')
New Garef from an other Garef instance or garef str or from a LatLon instance or lat-/longitude str.

Properties
	decoded3 Get this garef's attributes (LatLonPrec3Tuple).
	latlon Get this garef's (center) lat- and longitude (LatLon2Tuple).
	precision Get this garef's precision (`int`).
Inherited from `unitsBase._NamedUnit`: `std_repr`, `units` Inherited from `named._Named`: `classname`, `classnaming`, `iteration`, `name`, `named`, `named2`, `named3`, `named4`, `sizeof` Inherited from `object`: `__class__`

Method Details

new (cls, cll, precision=1, name='')
Static Method

New Garef from an other Garef instance or garef str or from a LatLon instance or lat-/longitude str.

Arguments:

cll - Cell or location (Garef or str, LatLon or str).
precision - Optional, the desired garef resolution and length (int 0..2), see function gars.encode for more details.
name - Optional name (str).

Returns: a new object with type S, a subtype of T

New Garef.

Raises:

RangeError - Invalid cll lat- or longitude.
TypeError - Invalid cll.
GARSError - INValid or non-alphanumeric cll.

Overrides: object.__new__

toLatLon (self, LatLon=None, **LatLon_kwds)

Return (the center of) this garef cell as an instance of the supplied LatLon class.

Arguments:

LatLon - Class to use (LatLon or None).
LatLon_kwds - Optional, additional LatLon keyword arguments.

Returns:

This garef location as LatLon or if LatLon is None as LatLonPrec3Tuple.

Property Details

decoded3

Get this garef's attributes (LatLonPrec3Tuple).

Get method:: decoded3(self) - Get this garef's attributes (LatLonPrec3Tuple).
Set method:: _fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:: _fdel(inst) - Zap the cached/memoized property value.

latlon

Get this garef's (center) lat- and longitude (LatLon2Tuple).

Get method:: latlon(self) - Get this garef's (center) lat- and longitude (LatLon2Tuple).
Set method:: _fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:: _fdel(inst) - Zap the cached/memoized property value.

precision

Get this garef's precision (int).

Get method:: precision(self) - Get this garef's precision (int).
Set method:: _fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:: _fdel(inst) - Zap the cached/memoized property value.