Package Documentation¶
Geos API Package.
Classes:
Name | Description |
---|---|
GeosAPI |
Represents Signal's Geos API. |
GeosAPI
¶
Represents Signal's Geos API.
Source code in signal_ocean/geos/geos_api.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
|
__init__(connection=None)
¶
Initializes GeosAPI.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
connection |
Optional[Connection]
|
API connection configuration. If not provided, the default connection method is used. |
None
|
Source code in signal_ocean/geos/geos_api.py
19 20 21 22 23 24 25 26 |
|
get_areas(areaId=None)
¶
Retrieves all available areas.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
areaId |
Optional[int]
|
area identifier to filter and return only a specific area. |
None
|
Returns:
Type | Description |
---|---|
Tuple[Area, ...]
|
A tuple of all available areas. |
Source code in signal_ocean/geos/geos_api.py
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
|
get_countries(countryId=None)
¶
Retrieves all available countries.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
countryId |
Optional[int]
|
country identifier to filter and return only a specific country. |
None
|
Returns:
Type | Description |
---|---|
Tuple[Country, ...]
|
A tuple of all available countries. |
Source code in signal_ocean/geos/geos_api.py
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
|
get_geoAssets(geoAssetId=None)
¶
Retrieves all available geo assets.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
geoAssetId |
Optional[int]
|
geo asset identifier to filter and return only a specific geo asset. |
None
|
Returns:
Type | Description |
---|---|
Tuple[GeoAsset, ...]
|
A tuple of all available geo asset. |
Source code in signal_ocean/geos/geos_api.py
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
|
get_ports(portId=None)
¶
Retrieves all available ports.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
portId |
Optional[int]
|
port identifier to filter and return only a specific port. |
None
|
Returns:
Type | Description |
---|---|
Tuple[Port, ...]
|
A tuple of all available ports. |
Source code in signal_ocean/geos/geos_api.py
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
|