hebi::LogFile Class Reference

#include <log_file.hpp>

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

Static Public Member Functions
static std::shared_ptr< LogFile >	open (std::string file)
	Opens an existing log file. More...

Private Member Functions
	LogFile (HebiLogFilePtr internal, int number_of_modules)

Private Attributes
HebiLogFilePtr	internal_
const int	number_of_modules_

Friends
class	Group

Detailed Description

Definition at line 11 of file log_file.hpp.

Constructor & Destructor Documentation

hebi::LogFile::LogFile ( HebiLogFilePtr  internal, int  number_of_modules  )

private

Definition at line 5 of file log_file.cpp.

hebi::LogFile::LogFile ( )

delete

hebi::LogFile::~LogFile

(

)

Definition at line 23 of file log_file.cpp.

Member Function Documentation

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

feedback

On success, the group feedback read from the group are written into this structure.

Returns

true if feedback was returned, otherwise false on failure

Definition at line 19 of file log_file.cpp.

hebi::LogFile::HEBI_DISABLE_COPY_MOVE

(

LogFile

)

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

static

Opens an existing log file.

Parameters

file	The 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)

Definition at line 8 of file log_file.cpp.

int hebi::LogFile::size

(

)

const

Returns the number of modules in the log file.

Definition at line 17 of file log_file.cpp.

Friends And Related Function Documentation

friend class Group

friend

Definition at line 12 of file log_file.hpp.

Member Data Documentation

HebiLogFilePtr hebi::LogFile::internal_

private

Definition at line 15 of file log_file.hpp.

const int hebi::LogFile::number_of_modules_

private

Definition at line 16 of file log_file.hpp.

---

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

• log_file.hpp
• log_file.cpp