journalfile.h
Go to the documentation of this file.
1 
2 // Copyright (c) 2003-2021 Xsens Technologies B.V. or subsidiaries worldwide.
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without modification,
6 // are permitted provided that the following conditions are met:
7 //
8 // 1. Redistributions of source code must retain the above copyright notice,
9 // this list of conditions, and the following disclaimer.
10 //
11 // 2. Redistributions in binary form must reproduce the above copyright notice,
12 // this list of conditions, and the following disclaimer in the documentation
13 // and/or other materials provided with the distribution.
14 //
15 // 3. Neither the names of the copyright holders nor the names of their contributors
16 // may be used to endorse or promote products derived from this software without
17 // specific prior written permission.
18 //
19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
20 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
22 // THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
24 // OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 // HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR
26 // TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.THE LAWS OF THE NETHERLANDS
28 // SHALL BE EXCLUSIVELY APPLICABLE AND ANY DISPUTES SHALL BE FINALLY SETTLED UNDER THE RULES
29 // OF ARBITRATION OF THE INTERNATIONAL CHAMBER OF COMMERCE IN THE HAGUE BY ONE OR MORE
30 // ARBITRATORS APPOINTED IN ACCORDANCE WITH SAID RULES.
31 //
32 
33 
34 // Copyright (c) 2003-2021 Xsens Technologies B.V. or subsidiaries worldwide.
35 // All rights reserved.
36 //
37 // Redistribution and use in source and binary forms, with or without modification,
38 // are permitted provided that the following conditions are met:
39 //
40 // 1. Redistributions of source code must retain the above copyright notice,
41 // this list of conditions, and the following disclaimer.
42 //
43 // 2. Redistributions in binary form must reproduce the above copyright notice,
44 // this list of conditions, and the following disclaimer in the documentation
45 // and/or other materials provided with the distribution.
46 //
47 // 3. Neither the names of the copyright holders nor the names of their contributors
48 // may be used to endorse or promote products derived from this software without
49 // specific prior written permission.
50 //
51 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
52 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
53 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
54 // THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55 // SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
56 // OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57 // HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR
58 // TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
59 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.THE LAWS OF THE NETHERLANDS
60 // SHALL BE EXCLUSIVELY APPLICABLE AND ANY DISPUTES SHALL BE FINALLY SETTLED UNDER THE RULES
61 // OF ARBITRATION OF THE INTERNATIONAL CHAMBER OF COMMERCE IN THE HAGUE BY ONE OR MORE
62 // ARBITRATORS APPOINTED IN ACCORDANCE WITH SAID RULES.
63 //
64 
65 #ifndef JOURNALFILE_H
66 #define JOURNALFILE_H
67 
68 #include <string>
69 #include <xstypes/xsstring.h>
70 #include <xstypes/xsfile.h>
71 #include <atomic>
72 
74 {
75 public:
76  JournalFile(const XsString& name, bool purge);
77  ~JournalFile();
78 
79  void flush();
80 
81  int addRef();
82  int refCount() volatile const;
83  int removeRef();
84 
85  XsString filename() const;
86  JournalFile& operator<<(std::string const& msg);
89  {
90  return m_file;
91  }
92 
93 private:
94  volatile std::atomic_int m_refCount;
97 };
98 
99 #endif
JournalFile::m_filename
XsString m_filename
Definition: journalfile.h:95
xsstring.h
msg
msg
xsfile.h
JournalFile::refCount
int refCount() volatile const
Returns the current ref count value.
Definition: journalfile.cpp:133
JournalFile::~JournalFile
~JournalFile()
Destructor, flushes remaining data and closes the file.
Definition: journalfile.cpp:104
JournalFile
A class containing a journal file and some meta-data.
Definition: journalfile.h:73
JournalFile::flush
void flush()
Flush remaining data to disk.
Definition: journalfile.cpp:117
JournalFile::addRef
int addRef()
Increase reference count of JournalFile by 1.
Definition: journalfile.cpp:125
JournalFile::filename
XsString filename() const
Returns the (path +) filename of the open file.
Definition: journalfile.cpp:147
JournalFile::operator<<
JournalFile & operator<<(std::string const &msg)
Appends msg to the end of the current data stream.
Definition: journalfile.cpp:153
JournalFile::m_refCount
volatile std::atomic_int m_refCount
A reference counter that tracks how many Journaller objects use this file.
Definition: journalfile.h:94
JournalFile::JournalFile
JournalFile(const XsString &name, bool purge)
Constructor, requires a filename.
Definition: journalfile.cpp:84
JournalFile::m_file
XsFile m_file
Definition: journalfile.h:96
JournalFile::removeRef
int removeRef()
Decrease reference count of JournalFile by 1.
Definition: journalfile.cpp:141
XsFile
Encapsulates a file, providing a platform independent interface.
Definition: xsfile.h:131
JournalFile::xsFile
XsFile & xsFile()
Return the internal XsFile object, only to be used directly when absolutely necessary.
Definition: journalfile.h:88
XsString
A 0-terminated managed string of characters.


xsens_mti_driver
Author(s):
autogenerated on Sun Sep 3 2023 02:43:20