Package pygeodesy :: Module namedTuples :: Class UtmUpsLatLon5Tuple |
[frames] | no frames]

# Class UtmUpsLatLon5Tuple

       object --+
                |
            tuple --+
                    |
       object --+   |
                |   |
     named._Named --+
                    |
    named._NamedTuple --+
                        |
                       UtmUpsLatLon5Tuple

5-Tuple `(zone, band, hemipole, lat, lon)` as `int`, `str`, `str`, `degrees90` and `degrees180`, where `zone` is `1..60` for UTM or `0` for UPS, `band` is `""` or the longitudinal UTM band `'C'|'D'|..|'W'|'X'` or polar UPS band `'A'|'B'|'Y'|'Z'` and `hemipole` `'N'|'S'` is the UTM hemisphere or the UPS pole.

Instance Methods
Inherited from `named._NamedTuple`: `__delattr__`, `__getattr__`, `__getitem__`, `__repr__`, `__setattr__`, `__str__`, `dup`, `items`, `iteritems`, `iterunits`, `toRepr`, `toStr`, `toUnits`, `units` Inherited from `tuple`: `__add__`, `__contains__`, `__eq__`, `__ge__`, `__getattribute__`, `__getnewargs__`, `__getslice__`, `__gt__`, `__hash__`, `__iter__`, `__le__`, `__len__`, `__lt__`, `__mul__`, `__ne__`, `__rmul__`, `count`, `index` Inherited from `named._Named`: `_DOT_`, `__imatmul__`, `__matmul__`, `__rmatmul__`, `attrs`, `classof`, `copy`, `rename`, `toStr2` Inherited from `object`: `__format__`, `__init__`, `__reduce__`, `__reduce_ex__`, `__sizeof__`, `__subclasshook__`

Static Methods
a new object with type S, a subtype of T |
__new__(cls, z, B, h, lat, lon, Error=None, name='') New _NamedTuple initialized with `positional` arguments. |

Class Variables
| _Names_ = ``(``'``zone``'``,` `'``band``'``,` `'``hemipole``'``,` `'``lat``'``,` `'``lon``'``)`` Tuple specifying the `name` of each `Named-Tuple` item.
| _Units_ = ``(`<class 'pygeodesy.units.Number_'>`,` <class 'pygeodes`...`` Tuple defining the `units` of the value of each `Named-Tuple` item.

Properties
Inherited from `named._NamedTuple`: `iteration` Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2`, `named3`, `named4` Inherited from `object`: `__class__`

Method Details

### __new__ (cls, z, B, h, lat, lon, Error=None, name='') Static Method |
New _NamedTuple initialized with `positional` arguments. Arguments: `arg` - Tuple items (`tuple`, `list`, ...) or first tuple item of several more in other positional arguments. `args` - Tuple items (`any`), all positional arguments. `name_only` - Only `name='name'` is used, all other keyword arguments are silently ignored. Returns: a new object with type S, a subtype of T Raises: `LenError` - Unequal number of positional arguments and number of item `_Names_` or `_Units_`. `TypeError` - The `_Names_` or `_Units_` attribute is not a `tuple` of at least 2 items. `ValueError` - Item name is not a `str` or valid `identifier` or starts with `underscore`. Overrides: object.__new__ (inherited documentation)

Class Variable Details

  ### _Names_ Tuple specifying the `name` of each `Named-Tuple` item. Note: Specify at least 2 item names. Value:
      ('zone', 'band', 'hemipole', 'lat', 'lon')

  ### _Units_ Tuple defining the `units` of the value of each `Named-Tuple` item. Note: The `len(_Units_)` must match `len(_Names_)`. Value:
      (<class 'pygeodesy.units.Number_'>,
       <class 'pygeodesy.units.Band'>,
       <class 'pygeodesy.units.Str'>,
       <class 'pygeodesy.units.Lat'>,
       <class 'pygeodesy.units.Lon'>)