API: Introduce experimental namespace to mark new api as not yet stable. #1307
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -58,7 +58,7 @@ bool EcalPlay::LoadMeasurement(const std::string& path) | |||
| { | |||
| EcalPlayLogger::Instance()->info("Loading measurement..."); | |||
|
|
|||
| std::shared_ptr<eCAL::measurement::base::Reader> measurement(std::make_shared<eCAL::measurement::hdf5::Reader>()); | |||
| std::shared_ptr<eCAL::experimental::measurement::base::Reader> measurement(std::make_shared<eCAL::experimental::measurement::hdf5::Reader>()); | |||
There was a problem hiding this comment.
warning: variable 'measurement' of type 'std::shared_ptreCAL::experimental::measurement::base::Reader' can be declared 'const' [misc-const-correctness]
Suggested change
| std::shared_ptr<eCAL::experimental::measurement::base::Reader> measurement(std::make_shared<eCAL::experimental::measurement::hdf5::Reader>()); | |
| std::shared_ptr<eCAL::experimental::measurement::base::Reader> const measurement(std::make_shared<eCAL::experimental::measurement::hdf5::Reader>()); |
| @@ -134,7 +134,7 @@ namespace eCAL | |||
| bool operator!=(const IChannel& rhs) const { return !(operator==(rhs)); } | |||
|
|
|||
| //virtual Entry<T> operator[](unsigned long long timestamp); | |||
| virtual Frame<T> operator[](const base::EntryInfo& entry) | |||
| virtual Frame<T> operator[](const experimental::measurement::base::EntryInfo& entry) | |||
| { | |||
| auto binary_entry = binary_channel[entry]; | |||
| eCAL::message::Deserialize(binary_entry.message, message); | |||
There was a problem hiding this comment.
warning: 'message' is not a class, namespace, or enumeration [clang-diagnostic-error]
eCAL::message::Deserialize(binary_entry.message, message);
^Additional context
contrib/measurement/base/include/ecal/measurement/imeasurement.h:213: 'message' declared here
mutable T message;
^| @@ -72,7 +72,7 @@ namespace eCAL | |||
| class OChannel | |||
| { | |||
| public: | |||
| OChannel(std::shared_ptr<base::Writer> meas_, std::string name_) | |||
| OChannel(std::shared_ptr<experimental::measurement::base::Writer> meas_, std::string name_) | |||
There was a problem hiding this comment.
warning: the parameter 'name_' is copied for each invocation but only used as a const reference; consider making it a const reference [performance-unnecessary-value-param]
Suggested change
| OChannel(std::shared_ptr<experimental::measurement::base::Writer> meas_, std::string name_) | |
| OChannel(std::shared_ptr<experimental::measurement::base::Writer> meas_, const std::string& name_) |
| /** | ||
| * @brief Destructor | ||
| **/ | ||
| virtual ~Reader(); |
There was a problem hiding this comment.
warning: prefer using 'override' or (rarely) 'final' instead of 'virtual' [cppcoreguidelines-explicit-virtual-functions]
Suggested change
| virtual ~Reader(); | |
| ~Reader() override; |
| /** | ||
| * @brief Destructor | ||
| **/ | ||
| virtual ~Writer(); |
There was a problem hiding this comment.
warning: prefer using 'override' or (rarely) 'final' instead of 'virtual' [cppcoreguidelines-explicit-virtual-functions]
Suggested change
| virtual ~Writer(); | |
| ~Writer() override; |
| @@ -279,7 +279,7 @@ static PyObject* Meas_GetEntriesInfo(Meas *self, PyObject *args) | |||
| if (!PyArg_ParseTuple(args, "s", &channel_name)) | |||
| return nullptr; | |||
|
|
|||
| eCAL::measurement::base::EntryInfoSet entries; | |||
| eCAL::experimental::measurement::base::EntryInfoSet entries; | |||
There was a problem hiding this comment.
warning: variable 'entries' is not initialized [cppcoreguidelines-init-variables]
Suggested change
| eCAL::experimental::measurement::base::EntryInfoSet entries; | |
| eCAL::experimental::measurement::base::EntryInfoSet entries = 0; |
| @@ -327,7 +327,7 @@ static PyObject* Meas_GetEntriesInfoRange(Meas *self, PyObject *args) | |||
| if (!PyArg_ParseTuple(args, "sLL", &channel_name, &begin, &end)) | |||
| return nullptr; | |||
|
|
|||
| eCAL::measurement::base::EntryInfoSet entries; | |||
| eCAL::experimental::measurement::base::EntryInfoSet entries; | |||
There was a problem hiding this comment.
warning: variable 'entries' is not initialized [cppcoreguidelines-init-variables]
Suggested change
| eCAL::experimental::measurement::base::EntryInfoSet entries; | |
| eCAL::experimental::measurement::base::EntryInfoSet entries = 0; |
FlorianReimold
approved these changes
Jan 17, 2024
KerstinKeller
added a commit
that referenced
this pull request
Jan 18, 2024
* Doc: Downgraded sphinx related packages in requirements.txt (#1302) * The most recent release of various sphinx related packages need Sphinx 5 or up, but our old sphinx-book-theme 0.3.3 requires Sphinx 4 For a proper solution see #1303 * CMake: Fixed Findqwt.cmake (#1306) * [Python/clang] Add missing core functions (#1300) Adds the missing core functions from ecal_core.h (GetVersion, IsInitialized, SetUnitName) to ecal_clang and the python wrapper. * Measurement API: Introduce experimental namespace to mark new api as not yet stable. (#1307) --------- Co-authored-by: Florian Reimold <[email protected]> Co-authored-by: DownerCase <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Introduce experimental namespace for measurement to mark new API as not yet stable.
Cherry-pick to