log_file.hpp
Go to the documentation of this file.
1 #pragma once
2 
3 #include "hebi.h"
4 
5 #include <memory>
6 
7 #include "group_feedback.hpp"
8 
9 namespace hebi {
10 
11 class LogFile final {
12  friend class Group;
13 
14 private:
16  const int number_of_modules_;
17 
18  LogFile(HebiLogFilePtr internal, int number_of_modules);
19 
20 public:
28  static std::shared_ptr<LogFile> open(std::string file);
29 
33  int size() const;
34 
44  bool getNextFeedback(GroupFeedback& feedback);
45 
46  LogFile() = delete;
47  ~LogFile();
48 
50 };
51 
52 } // namespace hebi
hebi::LogFile
Definition: log_file.hpp:11
hebi::LogFile::~LogFile
~LogFile()
Definition: log_file.cpp:23
hebi::LogFile::size
int size() const
Returns the number of modules in the log file.
Definition: log_file.cpp:17
hebi::GroupFeedback
A list of Feedback objects that can be received from a Group of modules; the size() must match the nu...
Definition: group_feedback.hpp:16
hebi::LogFile::open
static std::shared_ptr< LogFile > open(std::string file)
Opens an existing log file.
Definition: log_file.cpp:8
hebi::LogFile::internal_
HebiLogFilePtr internal_
Definition: log_file.hpp:15
group_feedback.hpp
hebi::LogFile::getNextFeedback
bool getNextFeedback(GroupFeedback &feedback)
retrieves the next group feedback from the log file, if any exists
Definition: log_file.cpp:19
HebiLogFilePtr
struct HebiLogFile_ * HebiLogFilePtr
The C-style's API representation of a log file.
Definition: hebi.h:514
hebi
Definition: arm.cpp:5
hebi::LogFile::HEBI_DISABLE_COPY_MOVE
HEBI_DISABLE_COPY_MOVE(LogFile)
hebi::LogFile::number_of_modules_
const int number_of_modules_
Definition: log_file.hpp:16
hebi.h
hebi::LogFile::LogFile
LogFile()=delete
hebi::Group
Represents a group of physical HEBI modules, and allows Command, Feedback, and Info objects to be sen...
Definition: group.hpp:29


hebi_cpp_api_ros
Author(s): Chris Bollinger , Matthew Tesch
autogenerated on Fri Aug 2 2024 08:35:18