HEBI C++ API  2.0.1
hebi::LogFile Class Referencefinal

#include <log_file.hpp>

Public Member Functions

int size () const
 Returns the number of modules in the log file. More...
 
bool getNextFeedback (GroupFeedback &feedback)
 retrieves the next group feedback from the log file, if any exists More...
 
 LogFile ()=delete
 
 ~LogFile ()
 
 HEBI_DISABLE_COPY_MOVE (LogFile)
 

Static Public Member Functions

static std::shared_ptr< LogFileopen (std::string file)
 Opens an existing log file. More...
 

Friends

class Group
 

Constructor & Destructor Documentation

◆ LogFile()

hebi::LogFile::LogFile ( )
delete

◆ ~LogFile()

hebi::LogFile::~LogFile ( )

Member Function Documentation

◆ open()

std::shared_ptr< LogFile > hebi::LogFile::open ( std::string  file)
static

Opens an existing log file.

Parameters
fileThe absolute or relative path to an existing log file
Returns
a shared pointer to the opened file on success, otherwise a null pointer (i.e. invalid log file or nonexistent file)

◆ size()

int hebi::LogFile::size ( ) const

Returns the number of modules in the log file.

◆ getNextFeedback()

bool hebi::LogFile::getNextFeedback ( GroupFeedback feedback)

retrieves the next group feedback from the log file, if any exists

Warning: other data in the provided 'Feedback' object is erased!

Parameters
feedbackOn success, the group feedback read from the group are written into this structure.
Returns
true if feedback was returned, otherwise false on failure

◆ HEBI_DISABLE_COPY_MOVE()

hebi::LogFile::HEBI_DISABLE_COPY_MOVE ( LogFile  )

Friends And Related Function Documentation

◆ Group

friend class Group
friend

The documentation for this class was generated from the following files: