lib/mdflib/docs/manual/html/mdffactory_8h_source.html
| MDF Lib 2.2
Interface against MDF 3/4 files |
Loading...
Searching...
No Matches
mdffactory.h
Go to the documentation of this file.
1/*
2 * Copyright 2022 Ingemar Hedvall
3 * SPDX-License-Identifier: MIT
4 */
8#pragma once
9#include <functional>
10#include <cstdint>
11#include <string>
12#include <memory>
13
14namespace mdf {
16enum class MdfWriterType : int {
17Mdf3Basic = 0,
18Mdf4Basic = 1,
19MdfBusLogger = 2,
20MdfConverter = 3,
21};
22
24enum class MdfFileType : int {
25Mdf3FileType = 0,
26Mdf4FileType = 1
27};
28
30enum class MdfLogSeverity : uint8_t {
31kTrace = 0,
32kDebug,
33kInfo,
34kNotice,
35kWarning,
36kError,
37kCritical,
38kAlert,
40};
41
43using MdfLogFunction2 = std::function<void(MdfLogSeverity severity,
44const std::string& function, const std::string& text)>;
45
46class MdfWriter;
47class MdfFile;
48
50class MdfFactory {
51 public:
53static std::unique_ptr<MdfWriter> CreateMdfWriter(MdfWriterType type);
55static std::unique_ptr<MdfFile> CreateMdfFile(MdfFileType type);
56
58static MdfWriter* CreateMdfWriterEx(MdfWriterType type);
60static MdfFile* CreateMdfFileEx(MdfFileType type);
61
63static void SetLogFunction2(const MdfLogFunction2& func);
64};
65
66} // namespace mdf
MDF factory class.
Definition mdffactory.h:50
mdf::MdfFactory::SetLogFunction2
static void SetLogFunction2(const MdfLogFunction2 &func)
Sets the log function.
mdf::MdfFactory::CreateMdfWriterEx
static MdfWriter * CreateMdfWriterEx(MdfWriterType type)
Creates an MDF writer object.
mdf::MdfFactory::CreateMdfWriter
static std::unique_ptr< MdfWriter > CreateMdfWriter(MdfWriterType type)
Creates an MDF writer object.
mdf::MdfFactory::CreateMdfFileEx
static MdfFile * CreateMdfFileEx(MdfFileType type)
Create an MDF reader object.
mdf::MdfFactory::CreateMdfFile
static std::unique_ptr< MdfFile > CreateMdfFile(MdfFileType type)
Create an MDF reader object.
Implements an user interface against a MDF file.
Definition mdffile.h:37
Interface against an MDF writer object.
Definition mdfwriter.h:104
Main namespace for the MDF library.
Definition canmessage.h:17
MdfFileType
MDF file type.
Definition mdffactory.h:24
mdf::MdfFileType::Mdf4FileType
@ Mdf4FileType
MDF version 4 file.
mdf::MdfFileType::Mdf3FileType
@ Mdf3FileType
MDF version 3 file.
std::function< void(MdfLogSeverity severity, const std::string &function, const std::string &text)> MdfLogFunction2
MDF logging function definition.
Definition mdffactory.h:43
MdfLogSeverity
Defines the log severity level.
Definition mdffactory.h:30
@ kInfo
Informational message.
mdf::MdfLogSeverity::kEmergency
@ kEmergency
Fatal error message.
mdf::MdfLogSeverity::kCritical
@ kCritical
Critical message (device error)
@ kNotice
Notice message. Notify the user.
@ kDebug
Debug message.
@ kAlert
Alert or alarm message.
@ kError
Error message.
@ kWarning
Warning message.
@ kTrace
Trace or listen message.
MdfWriterType
MDF writer types.
Definition mdffactory.h:16
mdf::MdfWriterType::MdfConverter
@ MdfConverter
MDF writer for MDF 4 conversion applications.
@ Mdf3Basic
Basic MDF version 3 writer.
@ Mdf4Basic
Basic MDF version 4 writer.
mdf::MdfWriterType::MdfBusLogger
@ MdfBusLogger
Specialized bus logger writer.