Package pygeodesy :: Module geodsolve :: Class _GeodesicSolveBase |
[frames] | no frames]

# Class _GeodesicSolveBase

                 object --+
                          |
               named._Named --+
                              |
               named._NamedBase --+
                                  |
    geodesicx.gxbases._GeodesicBase --+
                                      |
                                     _GeodesicSolveBase

Known Subclasses:
  - GeodesicLineSolve
  - , GeodesicSolve

(NTERNAL) Base class for GeodesicSolve and GeodesicLineSolve.

Instance Methods
invoke(self, *options, **stdin) Invoke the `GeodSolve` executable and return the result. |
toStr(self, prec=6, sep=', ', **unused) Return this `GeodesicSolve` as string. |
Inherited from `named._NamedBase`: `__repr__`, `__str__`, `others`, `toRepr` Inherited from `named._Named`: `_DOT_`, `__imatmul__`, `__matmul__`, `__rmatmul__`, `attrs`, `classof`, `copy`, `dup`, `rename`, `toStr2` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__init__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Class Variables
Inherited from `geodesicx.gxbases._GeodesicBase`: `ALL`, `AREA`, `AZIMUTH`, `DISTANCE`, `DISTANCE_IN`, `EMPTY`, `GEODESICSCALE`, `LATITUDE`, `LONGITUDE`, `LONG_UNROLL`, `REDUCEDLENGTH`, `STANDARD`

Properties
| a Get the equatorial radius, semi-axis (`meter`).
| ellipsoid Get the ellipsoid (`Ellipsoid`).
| Exact Get the `GeodesicExact` usage (`bool`).
| f Get the ellipsoid's flattening (`float`), (a - b) / a, `0` for spherical, negative for prolate.
| GeodSolve Get the GeodSolve executable (`filename`).
| invokation Get the most recent `GeodSolve` invokation number (`int`).
| prec Get the precision, number of decimal digits (`int`).
| reverse2 Get the `azi2` direction (`bool`).
| status Get the most recent `GeodSolve` 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"`.
Inherited from `geodesicx.gxbases._GeodesicBase`: `debug` Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2`, `named3`, `named4` Inherited from `object`: `__class__`

Method Details

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

### toStr (self, prec=6, sep=', ', **unused) |
Return this `GeodesicSolve` as string. Arguments: `prec` - The `float` precision, number of decimal digits (0..9). Trailing zero decimals are stripped for `prec` values of 1 and above, but kept for negative `prec` values. `sep` - Optional separator to join (`str`). Returns: GeodesicSolve items (`str`). Overrides: named._Named.toStr

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 `GeodesicExact` usage (`bool`). Get method: Exact(self) - Get the `GeodesicExact` usage (`bool`). Set method: Exact(self, Exact) - Set the `GeodesicExact` usage (`bool`). Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### 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.

### GeodSolve Get the GeodSolve executable (`filename`). Get method: GeodSolve(self) - Get the GeodSolve executable (`filename`). Set method: GeodSolve(self, path) - Set the GeodSolve executable (`filename`). Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### invokation Get the most recent `GeodSolve` invokation number (`int`). Get method: invokation(self) - Get the most recent `GeodSolve` 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`. 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`). Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### status Get the most recent `GeodSolve` return code (`int`, `str`) or `None`. Get method: status(self) - Get the most recent `GeodSolve` 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`). 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. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

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