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

# Class Intersection3Tuple

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

3-Tuple `(point, outside1, outside2)` of an intersection `point` and `outside1`, the position of the `point`, `-1` if before the start, `+1` if after the end and `0` if on or between the start and end point of the first line. Similarly, `outside2` is `-2`, `+2` or `0` to indicate the position of `point` on the second line or path. If a path was specified with an initial bearing instead of an end point, `outside1` and/or `outside2` will be `0` if the intersection `point` is on the start point or `+1` respectively `+2` if the intersection `point` is after the start point, in the direction of the bearing.

Instance Methods
Inherited from `named._NamedTuple`: `__delattr__`, `__getattr__`, `__getitem__`, `__repr__`, `__setattr__`, `__str__`, `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_`, `attrs`, `classof`, `copy`, `rename`, `toStr2` Inherited from `object`: `__format__`, `__init__`, `__reduce__`, `__reduce_ex__`, `__sizeof__`, `__subclasshook__`

Static Methods
Inherited from `named._NamedTuple`: `__new__`

Class Variables
| _Names_ = ``(``'``point``'``,` `'``outside1``'``,` `'``outside2``'``)`` Tuple specifying the `name` of each `Named-Tuple` item.
| _Units_ = `_Pass, Int, Int` 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__`

Class Variable Details

  ### _Names_ Tuple specifying the `name` of each `Named-Tuple` item. Note: Specify at least 2 item names. Value:
      ('point', 'outside1', 'outside2')

  ### _Units_ Tuple defining the `units` of the value of each `Named-Tuple` item. Note: The `len(_Units_)` must match `len(_Names_)`. Value:
      _Pass, Int, Int