Package pygeodesy :: Module solveBase :: Class _SolveLineSolveBase |
[frames] | no frames]

# Class _SolveLineSolveBase

      object --+
               |
    named._Named --+
                   |
    named._NamedBase --+
                       |
        karney._CapsBase --+
                           |
                          _SolveLineSolveBase

Known Subclasses:
  - _SolveBase
  - , _LineSolveBase

(NTERNAL) Base class for `_Solve` and `_LineSolve`.

Instance Methods
invoke(self, *options, **stdin) Invoke the `Solve` executable and return the result. |
Inherited from `karney._CapsBase`: `caps_` Inherited from `named._NamedBase`: `__repr__`, `__str__`, `others`, `toRepr`, `toStr` Inherited from `named._Named`: `__imatmul__`, `__matmul__`, `__rmatmul__`, `attrs`, `classof`, `copy`, `dup`, `methodname`, `rename`, `toStr2` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__init__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Class Variables
Inherited from `karney._CapsBase`: `ALL`, `AREA`, `AZIMUTH`, `DISTANCE`, `DISTANCE_IN`, `EMPTY`, `GEODESICSCALE`, `LATITUDE`, `LINE_OFF`, `LONGITUDE`, `LONG_UNROLL`, `REDUCEDLENGTH`, `STANDARD`

Properties
| a Get the equatorial radius, semi-axis (`meter`).
| ellipsoid Get the ellipsoid (`Ellipsoid`).
| Exact Get the Solve's `exact` setting (`bool`).
| f Get the ellipsoid's flattening (`float`), (a - b) / a, `0` for spherical, negative for prolate.
| invokation Get the most recent `Solve` invokation number (`int`).
| prec Get the precision, number of (decimal) digits (`int`).
| reverse2 Get the `azi2` direction (`bool`).
| status Get the most recent `Solve` return code (`int`, `str`) or `None`.
| unroll Get the `lon2` unroll'ing (`bool`).
| verbose Get the `verbose` option (`bool`).
| version Get the result of `"GeodSolve --version"` or `"RhumbSolve --version"`.
Inherited from `karney._CapsBase`: `caps`, `debug` Inherited from `named._Named`: `classname`, `classnaming`, `iteration`, `name`, `named`, `named2`, `named3`, `named4` Inherited from `object`: `__class__`

Method Details

### invoke (self, *options, **stdin) |
Invoke the `Solve` executable and return the result. Arguments: `options` - No, one or several `Solve` command line options (`str`s). `stdin` - Optional input to pass to `Solve.stdin` (`str`). Returns: The `Solve.stdout` and `.stderr` output (`str`). Raises: `GeodesicError` - On any error, including a non-zero return code from `GeodSolve`. `RhumbError` - On any error, including a non-zero return code from `RhumbSolve`. Note: The `Solve` return code is in property status.

Property Details

### a Get the equatorial radius, semi-axis (`meter`). Get method: a(self) - Get the equatorial radius, semi-axis (`meter`). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### ellipsoid Get the ellipsoid (`Ellipsoid`). Get method: ellipsoid(self) - Get the ellipsoid (`Ellipsoid`). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### Exact Get the Solve's `exact` setting (`bool`). Get method: Exact(self) - Get the Solve's `exact` setting (`bool`). Set method: Exact(self, Exact) - Set the Solve's `exact` setting (`bool`), if `True` use exact version.

### f Get the ellipsoid's flattening (`float`), (a - b) / a, `0` for spherical, negative for prolate. Get method: f(self) - Get the ellipsoid's flattening (`float`), (a - b) / a, `0` for spherical, negative for prolate. Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### invokation Get the most recent `Solve` invokation number (`int`). Get method: invokation(self) - Get the most recent `Solve` invokation number (`int`). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### prec Get the precision, number of (decimal) digits (`int`). Get method: prec(self) - Get the precision, number of (decimal) digits (`int`). Set method: prec(self, prec) - Set the precision for `angles` in `degrees`, like `lat`, `lon`, `azimuth` and `arc` in number of decimal digits (`int`, `0`.. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### reverse2 Get the `azi2` direction (`bool`). Get method: reverse2(self) - Get the `azi2` direction (`bool`). Set method: reverse2(self, reverse2) - Set the direction for `azi2` (`bool`), if `True` reverse `azi2`. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### status Get the most recent `Solve` return code (`int`, `str`) or `None`. Get method: status(self) - Get the most recent `Solve` return code (`int`, `str`) or `None`. Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### unroll Get the `lon2` unroll'ing (`bool`). Get method: unroll(self) - Get the `lon2` unroll'ing (`bool`). Set method: unroll(self, unroll) - Set unroll'ing for `lon2` (`bool`), if `True` unroll `lon2`, otherwise don't. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### verbose Get the `verbose` option (`bool`). Get method: verbose(self) - Get the `verbose` option (`bool`). Set method: verbose(self, verbose) - Set the `verbose` option (`bool`), `True` prints a message around each `RhumbSolve` invokation.

### version Get the result of `"GeodSolve --version"` or `"RhumbSolve --version"`. Get method: version(self) - Get the result of `"GeodSolve --version"` or `"RhumbSolve --version"`. Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.