Skip to content

Commit

Permalink
- decoding KongsbergAllRuntimeParameters: filter_identifier2
Browse files Browse the repository at this point in the history
  - decoding KongsbergAllRuntimeParameters: yaw_and_pitch_stabilization
  - decoding KongsbergAllRuntimeParameters: beam_spacing
  • Loading branch information
peter-urban committed Nov 28, 2024
1 parent 026683e commit 1db77e1
Show file tree
Hide file tree
Showing 3 changed files with 419 additions and 43 deletions.
36 changes: 36 additions & 0 deletions src/pymodule/py_kongsbergall/py_datagrams/c_runtimeparameters.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,24 @@ void init_c_runtimeparameters(pybind11::module& m)
&RuntimeParameters::get_filter_identifier_as_interference_filter,
DOC_RuntimeParameters(get_filter_identifier_as_interference_filter))

// filter_identifier2
.def("get_filter_identifier2_as_penetration_filter",
&RuntimeParameters::get_filter_identifier2_as_penetration_filter,
DOC_RuntimeParameters(get_filter_identifier2_as_penetration_filter))
.def("get_filter_identifier2_as_detect_mode",
&RuntimeParameters::get_filter_identifier2_as_detect_mode,
DOC_RuntimeParameters(get_filter_identifier2_as_detect_mode))
.def("get_filter_identifier2_as_phase_ramp",
&RuntimeParameters::get_filter_identifier2_as_phase_ramp,
DOC_RuntimeParameters(get_filter_identifier2_as_phase_ramp),
py::arg("unhandled_message") = std::nullopt)
.def("get_filter_identifier2_as_special_tvg",
&RuntimeParameters::get_filter_identifier2_as_special_tvg,
DOC_RuntimeParameters(get_filter_identifier2_as_special_tvg))
.def("get_filter_identifier2_as_special_amp_detect",
&RuntimeParameters::get_filter_identifier2_as_special_amp_detect,
DOC_RuntimeParameters(get_filter_identifier2_as_special_amp_detect))

// _source_of_sound_speed_at_transducer
.def("get_source_of_sound_speed_at_transducer_as_string",
&RuntimeParameters::get_source_of_sound_speed_at_transducer_as_string,
Expand All @@ -277,6 +295,24 @@ void init_c_runtimeparameters(pybind11::module& m)
&RuntimeParameters::get_3d_scanning_enabled,
DOC_RuntimeParameters(get_3d_scanning_enabled))

// beam_spacing
.def("get_beam_spacing_as_string",
&RuntimeParameters::get_beam_spacing_as_string,
DOC_RuntimeParameters(get_beam_spacing_as_string),
py::arg("unhandled_message") = std::nullopt)

// yaw and pitch stabilization
.def("get_yaw_and_pitch_stabilization_mode_as_yaw_stabilization",
&RuntimeParameters::get_yaw_and_pitch_stabilization_mode_as_yaw_stabilization,
DOC_RuntimeParameters(get_yaw_and_pitch_stabilization_mode_as_yaw_stabilization))
.def("get_yaw_and_pitch_stabilization_mode_as_heading_filter",
&RuntimeParameters::get_yaw_and_pitch_stabilization_mode_as_heading_filter,
DOC_RuntimeParameters(get_yaw_and_pitch_stabilization_mode_as_heading_filter),
py::arg("unhandled_message") = std::nullopt)
.def("get_yaw_and_pitch_stabilization_mode_as_pitch_stibilization",
&RuntimeParameters::get_yaw_and_pitch_stabilization_mode_as_pitch_stibilization,
DOC_RuntimeParameters(get_yaw_and_pitch_stabilization_mode_as_pitch_stibilization))

// --- mode2 ---

// --- checksum access ---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//sourcehash: 0aaecbe141a93b6eb0ad10ad932f90e1a68553ce94995a78a883702a57f017ec
//sourcehash: e4faf4141e475d257cf254c796e92f885bd61000b9c7af44f9e77f65665a9569

/*
This file contains docstrings for use in the Python bindings.
Expand Down Expand Up @@ -83,6 +83,21 @@ R"doc(Get the absorption coefficient in db per meter

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_get_beam_spacing = R"doc()doc";

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_get_beam_spacing_as_string =
R"doc(Retrieves beamspacing mode encoded in the beamspacing variable
The decoding is EM model specific. Currently only outputs sensefull
values for EM2040 and EM2040C. See datagram format specification for
details.
Parameter ``unhandled_message``:
If provided, this message is used as the return value if the mode
is not handled for the specific system. Otherwise: 'None' is
returned
Returns:
A string representing beamspacing as encoded by 'beamspacing')doc";

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_get_bsp_status = R"doc()doc";

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_get_checksum = R"doc()doc";
Expand All @@ -100,6 +115,50 @@ static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagr

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_get_filter_identifier2 = R"doc()doc";

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_get_filter_identifier2_as_detect_mode =
R"doc(Retrieves detect mode encoded in the filter_identifier2 variable
Returns:
A string representing the detect mode as encoded by
'filter_identifier2')doc";

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_get_filter_identifier2_as_penetration_filter =
R"doc(Retrieves penetration filter setup encoded in the filter_identifier2
variable
Returns:
A string representing the penetration filter setup as encoded by
'filter_identifier2')doc";

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_get_filter_identifier2_as_phase_ramp =
R"doc(Retrieves phase ramp encoded in the filter_identifier2 variable
Parameter ``unhandled_message``:
If provided, this message is used as the return value if the value
is not handled by the function. Otherwise: 'None' is returned
Returns:
A string representing the phase ramp encoded by
'filter_identifier2')doc";

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_get_filter_identifier2_as_special_amp_detect =
R"doc(Retrieves the Special amp detect mode encoded in the
filter_identifier2 variable
EM3002 soft sediment detection = special amp detect
Returns:
A string representing the Special amp detect mode (Normal/Special)
as encoded by 'filter_identifier2')doc";

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_get_filter_identifier2_as_special_tvg =
R"doc(Retrieves the Special TVG mode encoded in the filter_identifier2
variable
Returns:
A string representing the Special TVG mode (Normal/Special) as
encoded by 'filter_identifier2')doc";

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_get_filter_identifier_as_aeration_filter =
R"doc(Retrieves the Aearation filter status encoded in the filter_identifier
variable
Expand All @@ -121,8 +180,8 @@ R"doc(Retrieves Range gates size encoded in the mode variable
Parameter ``unhandled_message``:
If provided, this message is used as the return value if the range
gates size is not handled for the specific system. Otherwise:
Range gates size not implemented' is returned
gates size is not handled by the function. Otherwise: 'None' is
returned
Returns:
A string representing Range gates size as encoded by 'mode')doc";
Expand Down Expand Up @@ -330,6 +389,34 @@ static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagr

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_get_yaw_and_pitch_stabilization_mode = R"doc()doc";

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_get_yaw_and_pitch_stabilization_mode_as_heading_filter =
R"doc(Retrieves heading filter mode encoded in the
yaw_and_pitch_stabilization_mode variable
Parameter ``unhandled_message``:
If provided, this message is used as the return value if the mode
is not handled by the function. Otherwise: 'None' is returned
Returns:
A string representing heading filter mode as encoded by
'yaw_and_pitch_stabilization_mode')doc";

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_get_yaw_and_pitch_stabilization_mode_as_pitch_stibilization =
R"doc(Retrieves pitch stabilization mode (on/off) encoded in the
yaw_and_pitch_stabilization_mode variable
Returns:
A string representing pitch stabilization mode as encoded by
'yaw_and_pitch_stabilization_mode')doc";

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_get_yaw_and_pitch_stabilization_mode_as_yaw_stabilization =
R"doc(Retrieves yaw and pitch stabilization mode encoded in the
yaw_and_pitch_stabilization_mode variable
Returns:
A string representing yaw_and_pitch_stabilization_mode as encoded
by 'yaw_and_pitch_stabilization_mode')doc";

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_hash_content_only = R"doc()doc";

static const char *__doc_themachinethatgoesping_echosounders_kongsbergall_datagrams_RuntimeParameters_maximum_depth = R"doc(< in meter)doc";
Expand Down
Loading

0 comments on commit 1db77e1

Please sign in to comment.