Time-of-Flight Library(ToF) 3.3.0
chronoptics::tof::CrashReport Class Reference

Class containing log information about the crash that occurred. More...

#include <log.hpp>

+ Inheritance diagram for chronoptics::tof::CrashReport:

Public Member Functions

 CrashReport (tof_crash_report_t ptr=nullptr)
 Construct from pointer. More...
 
 CrashReport (StringView serial, StringView description)
 Generate crash report on a camera. More...
 
const char * get_description () const
 Get the description. More...
 
void set_description (StringView description)
 Set the description. More...
 
const char * get_report () const
 Get the complete report. More...
 
void save (StringView file_name) const
 Save report to disk. More...
 

Detailed Description

Class containing log information about the crash that occurred.

Definition at line 21 of file log.hpp.

Constructor & Destructor Documentation

◆ CrashReport() [1/2]

chronoptics::tof::CrashReport::CrashReport ( tof_crash_report_t  ptr = nullptr)
inline

Construct from pointer.

Definition at line 24 of file log.hpp.

◆ CrashReport() [2/2]

chronoptics::tof::CrashReport::CrashReport ( StringView  serial,
StringView  description 
)
inline

Generate crash report on a camera.

Parameters
serialCamera to generate the crash report on
descriptionDescription of what happened

Definition at line 32 of file log.hpp.

Member Function Documentation

◆ get_description()

const char * chronoptics::tof::CrashReport::get_description ( ) const
inline

Get the description.

Returns
Description

Definition at line 39 of file log.hpp.

◆ get_report()

const char * chronoptics::tof::CrashReport::get_report ( ) const
inline

Get the complete report.

Returns
String of the entire report

Definition at line 53 of file log.hpp.

◆ save()

void chronoptics::tof::CrashReport::save ( StringView  file_name) const
inline

Save report to disk.

Parameters
file_nameFile to save the report to

Definition at line 60 of file log.hpp.

◆ set_description()

void chronoptics::tof::CrashReport::set_description ( StringView  description)
inline

Set the description.

Parameters
descriptionDescription

Definition at line 46 of file log.hpp.