Package pygeodesy :: Package deprecated :: Class ClipCS3Tuple
[frames] | no frames]

Class ClipCS3Tuple

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

3-Tuple (start, end, index). DEPRECATED, see function clipCS3.

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
a new object with type S, a subtype of T
__new__(cls, start, end, ndex, name='')
New _NamedTuple initialized with positional arguments.
Class Variables
  _Names_ = ('start', 'end', 'index')
Tuple specifying the name of each Named-Tuple item.
  _Units_ = _Pass, _Pass, Number_
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, start, end, ndex, name='')
Static Method

 

New _NamedTuple initialized with positional arguments.

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:
('start', 'end', 'index')

_Units_

Tuple defining the units of the value of each Named-Tuple item.

Note: The len(_Units_) must match len(_Names_).

Value:
_Pass, _Pass, Number_