OpenCPN Partial API docs
Loading...
Searching...
No Matches
DataLogger Class Reference

Internal helper class. More...

#include <data_monitor.h>

Public Types

enum class  Format { kVdr , kDefault , kCsv }
 

Public Member Functions

 DataLogger (wxWindow *parent, const fs::path &path)
 
 DataLogger (wxWindow *parent)
 
void SetLogging (bool logging)
 
void SetLogfile (const fs::path &path)
 
fs::path GetLogfile () const
 
void Add (const Logline &ll)
 
void SetFormat (Format format)
 
fs::path NullLogfile ()
 
std::string GetFileDlgTypes ()
 
fs::path GetDefaultLogfile ()
 

Public Attributes

EventVar OnNewLogfile
 Notified with new path on filename change.
 

Detailed Description

Internal helper class.

Definition at line 41 of file data_monitor.h.

Member Enumeration Documentation

◆ Format

enum class DataLogger::Format
strong

Definition at line 43 of file data_monitor.h.

Constructor & Destructor Documentation

◆ DataLogger() [1/2]

DataLogger::DataLogger ( wxWindow *  parent,
const fs::path &  path 
)

Definition at line 781 of file data_monitor.cpp.

◆ DataLogger() [2/2]

DataLogger::DataLogger ( wxWindow *  parent)

Definition at line 789 of file data_monitor.cpp.

Member Function Documentation

◆ Add()

void DataLogger::Add ( const Logline ll)

Definition at line 829 of file data_monitor.cpp.

◆ GetDefaultLogfile()

fs::path DataLogger::GetDefaultLogfile ( )

Definition at line 814 of file data_monitor.cpp.

◆ GetFileDlgTypes()

std::string DataLogger::GetFileDlgTypes ( )

Definition at line 822 of file data_monitor.cpp.

◆ GetLogfile()

fs::path DataLogger::GetLogfile ( ) const
inline

Definition at line 53 of file data_monitor.h.

◆ NullLogfile()

fs::path DataLogger::NullLogfile ( )

Definition at line 807 of file data_monitor.cpp.

◆ SetFormat()

void DataLogger::SetFormat ( DataLogger::Format  format)

Definition at line 805 of file data_monitor.cpp.

◆ SetLogfile()

void DataLogger::SetLogfile ( const fs::path &  path)

Definition at line 793 of file data_monitor.cpp.

◆ SetLogging()

void DataLogger::SetLogging ( bool  logging)

Definition at line 791 of file data_monitor.cpp.

Member Data Documentation

◆ OnNewLogfile

EventVar DataLogger::OnNewLogfile

Notified with new path on filename change.

Definition at line 66 of file data_monitor.h.


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