ALib C++ Library
Library Version: 2510 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
filescamp.inl
Go to the documentation of this file.
1//==================================================================================================
2/// \file
3/// This header-file is part of module \alib_files of the \aliblong.
4///
5/// \emoji :copyright: 2013-2025 A-Worx GmbH, Germany.
6/// Published under \ref mainpage_license "Boost Software License".
7//==================================================================================================
8ALIB_EXPORT namespace alib {
9
10//==================================================================================================
11/// This is the reference documentation of module \alib_files_nl of the \aliblong.<br>
12/// @see
13/// A user manual with tutorial-style sample code is found in the
14/// \ref alib_mod_files "Programmer's Manual" of this module.
15//==================================================================================================
16namespace files {
17
18//==================================================================================================
19/// This is a strict singleton class representing module \alib_files.
20///
21/// The only instance is found with the namespace variable \ref alib::files.
22//==================================================================================================
23class FilesCamp : public camp::Camp
24{
25 public:
26 /// Constructor.<br>
27 /// While this is public, it must not be invoked as this is a strict singleton type.
28 /// (See notes in \ref alib_camp_camp).
30 FilesCamp();
31
32 protected:
33 /// Initializes this camp.
35 virtual void Bootstrap() override;
36
37 /// Terminates this camp. (Nothing to do.)
38 virtual void Shutdown( ShutdownPhases ) override {}
39
40}; // class FilesCamp
41
42} // namespace alib[::files]
43
44/// The singleton instance of \alibcamp class \alib{files;FilesCamp}.
45extern ALIB_DLL files::FilesCamp FILES;
46
47} // namespace [alib]
virtual void Shutdown(ShutdownPhases) override
Terminates this camp. (Nothing to do.)
Definition filescamp.inl:38
virtual ALIB_DLL void Bootstrap() override
Initializes this camp.
Definition filescamp.cpp:61
#define ALIB_DLL
Definition alib.inl:496
#define ALIB_EXPORT
Definition alib.inl:488
ShutdownPhases
Termination levels usable with Bootstrapping ALib Camps.
Definition camp.inl:42
files::FilesCamp FILES
The singleton instance of ALib Camp class FilesCamp.
Definition filescamp.cpp:47