diff --git a/Doxyfile b/Doxyfile
index 0dd57ca..eb85550 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -42,7 +42,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.
-PROJECT_NAME = "New 4DSSE Code"
+PROJECT_NAME = SERiF
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
@@ -54,7 +54,7 @@ PROJECT_NUMBER = 0.0.1a
# for a project that appears at the top of each page and should give viewers a
# quick idea about the purpose of the project. Keep the description short.
-PROJECT_BRIEF =
+PROJECT_BRIEF = 3+1D Stellar Structure and Evolution
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
@@ -349,7 +349,7 @@ OPTIMIZE_OUTPUT_SLICE = NO
#
# Note see also the list of default file extension mappings.
-EXTENSION_MAPPING = py=C++
+EXTENSION_MAPPING = md=markdown
# If the MARKDOWN_SUPPORT tag is enabled then Doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
@@ -406,7 +406,7 @@ AUTOLINK_IGNORE_WORDS =
# collaboration diagrams that involve STL classes more complete and accurate.
# The default value is: NO.
-BUILTIN_STL_SUPPORT = NO
+BUILTIN_STL_SUPPORT = YES
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
@@ -540,13 +540,13 @@ EXTRACT_ALL = YES
# be included in the documentation.
# The default value is: NO.
-EXTRACT_PRIVATE = NO
+EXTRACT_PRIVATE = YES
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
# methods of a class will be included in the documentation.
# The default value is: NO.
-EXTRACT_PRIV_VIRTUAL = NO
+EXTRACT_PRIV_VIRTUAL = YES
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
@@ -558,7 +558,7 @@ EXTRACT_PACKAGE = NO
# included in the documentation.
# The default value is: NO.
-EXTRACT_STATIC = NO
+EXTRACT_STATIC = YES
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
@@ -991,7 +991,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
-INPUT = src tests utils/opatio
+INPUT = src tests docs/static/mainpage.md
# This tag can be used to specify the character encoding of the source files
# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1207,7 +1207,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the Doxygen output.
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = docs/static/mainpage.md
# If the IMPLICIT_DIR_DOCS tag is set to YES, any README.md file found in sub-
# directories of the project's root, is used as the documentation for that sub-
@@ -1238,7 +1238,7 @@ FORTRAN_COMMENT_AFTER = 72
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.
-SOURCE_BROWSER = NO
+SOURCE_BROWSER = YES
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
# multi-line macros, enums or list initialized variables directly into the
@@ -1398,7 +1398,7 @@ HTML_FOOTER =
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_STYLESHEET =
+HTML_STYLESHEET =
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
@@ -1416,7 +1416,10 @@ HTML_STYLESHEET =
# documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_EXTRA_STYLESHEET =
+HTML_EXTRA_STYLESHEET = docs/static/doxygen-awesome-css/doxygen-awesome.css \
+ docs/static/doxygen-awesome-css/doxygen-awesome-sidebar-only.css
+
+
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
@@ -1439,7 +1442,7 @@ HTML_EXTRA_FILES =
# The default value is: AUTO_LIGHT.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_COLORSTYLE = AUTO_LIGHT
+HTML_COLORSTYLE = LIGHT
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# will adjust the colors in the style sheet and background images according to
@@ -1750,7 +1753,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
-DISABLE_INDEX = YES
+DISABLE_INDEX = NO
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. If the tag
diff --git a/docs/html/_d_object_8cpp.html b/docs/html/_d_object_8cpp.html
index b32a475..9cb7e04 100644
--- a/docs/html/_d_object_8cpp.html
+++ b/docs/html/_d_object_8cpp.html
@@ -5,7 +5,7 @@
-
New 4DSSE Code: src/dobj/private/DObject.cpp File Reference
+SERiF: src/dobj/private/DObject.cpp File Reference
@@ -18,12 +18,9 @@
-
+
+
@@ -32,21 +29,10 @@
- New 4DSSE Code
0.0.1a
+
SERiF 0.0.1a
+
3+1D Stellar Structure and Evolution
-
-
@@ -63,6 +49,17 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
+
+
+
+
@@ -102,6 +99,8 @@ $(function(){initNavTree('_d_object_8cpp.html',''); initResizable(true); });
@@ -111,10 +110,56 @@ $(function(){initNavTree('_d_object_8cpp.html',''); initResizable(true); });
#include "DObject.h "
#include <iostream>
#include <stdexcept>
-
+
+
Go to the source code of this file.
+
+
+std::ostream & operator<< (std::ostream &os, const DObject &obj)
+ Provides a human-readable summary of the DObject .
+
+
+
Implementation of the DObject class.
Provides the implementation for a universal data container with plugin support.
-
+
+Definition in file DObject.cpp .
+
+
+◆ operator<<()
+
+
+
+
+
+ std::ostream & operator<<
+ (
+ std::ostream & os ,
+
+
+
+
+ const DObject & obj )
+
+
+
+
+
Provides a human-readable summary of the DObject .
+
Useful for quick inspection or logging during debugging sessions.
+
Parameters
+
+ os The output stream to write to.
+ obj The DObject to summarize.
+
+
+
+
Returns A reference to the output stream.
+
+
Definition at line 126 of file DObject.cpp .
+
+
+
+
diff --git a/docs/html/_d_object_8h.html b/docs/html/_d_object_8h.html
index 36eae0d..9db3ce8 100644
--- a/docs/html/_d_object_8h.html
+++ b/docs/html/_d_object_8h.html
@@ -5,7 +5,7 @@
-
New 4DSSE Code: src/dobj/public/DObject.h File Reference
+
SERiF: src/dobj/public/DObject.h File Reference
@@ -18,12 +18,9 @@
-
+
+
@@ -32,21 +29,10 @@
- New 4DSSE Code
0.0.1a
+
SERiF 0.0.1a
+
3+1D Stellar Structure and Evolution
-
-
@@ -63,6 +49,17 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
+
+
+
+
@@ -110,8 +107,7 @@ $(function(){initNavTree('_d_object_8h.html',''); initResizable(true); });
Defines the DObject class, a universal data container for the project.
More...
-
#include "Metadata.h "
-
#include <variant>
+
#include <variant>
#include <memory>
#include <vector>
#include <string>
@@ -130,6 +126,8 @@ Classes
Defines the DObject class, a universal data container for the project.
The DObject class encapsulates arbitrary data and its associated metadata, providing a consistent interface for public-facing functions. It includes support for dynamically registered plugins.
+
+
Definition in file DObject.h .
diff --git a/docs/html/_d_object_8h_source.html b/docs/html/_d_object_8h_source.html
index 03ce62e..5afb5d9 100644
--- a/docs/html/_d_object_8h_source.html
+++ b/docs/html/_d_object_8h_source.html
@@ -5,7 +5,7 @@
-
New 4DSSE Code: src/dobj/public/DObject.h Source File
+
SERiF: src/dobj/public/DObject.h Source File
@@ -18,12 +18,9 @@
-
+
+
@@ -32,21 +29,10 @@
- New 4DSSE Code
0.0.1a
+
SERiF 0.0.1a
+
3+1D Stellar Structure and Evolution
-
-
@@ -63,6 +49,17 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
+
+
+
+
@@ -105,79 +102,135 @@ $(function(){initNavTree('_d_object_8h_source.html',''); initResizable(true); })
-
Go to the documentation of this file.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
38 int, float, double, std::string, std::monostate,
-
39 std::vector<int>, std::vector<float>, std::vector<double>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
161 friend std::ostream& operator<<(std::ostream& os, const
DObject & obj);
-
-
-
-
-
166 bool debugEnabled_ = false;
-
167 std::map<std::
string ,
Plugin > plugins_;
-
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
98 bool,
short int, int,
long int, float, double,
+
99 long double, std::string, std::monostate, std::vector<int>,
+
100 std::vector<float>, std::vector<double>, std::vector<std::string>,
+
101 std::vector<std::vector<int>>, std::vector<std::vector<float>>,
+
102 std::vector<std::vector<double>>,
+
103 std::vector<std::vector<std::vector<int>>>,
+
104 std::vector<std::vector<std::vector<float>>>,
+
105 std::vector<std::vector<std::vector<double>>>
+
+
+
+
+
+
110 {0,
"bool" }, {1,
"short int" }, {2,
"int" }, {3,
"long int" }, {4,
"float" },
+
111 {5,
"double" }, {6,
"long double" }, {7,
"string" }, {8,
"std::monostate" },
+
112 {9,
"vector<int>" }, {10,
"vector<float>" }, {11,
"vector<double>" },
+
113 {12,
"vector<string>" }, {13,
"vector<vector<int>" },
+
114 {14,
"vector<vector<float>" }, {15,
"vector<vector<double>" },
+
115 {16,
"vector<vector<vector<int>>" }, {17,
"vector<vector<vector<float>>" },
+
116 {18,
"vector<vector<vector<double>>" }
+
-
-
-
-
DObject()
Default constructor.
Definition DObject.cpp:13
-
void runAllPlugins()
Executes all registered plugins in the registry.
Definition DObject.cpp:99
-
const Metadata & getMetadata() const noexcept
Retrieves the metadata associated with the DObject.
Definition DObject.cpp:41
-
void registerPlugin(const std::string &id, Plugin plugin)
Registers a plugin with the DObject.
Definition DObject.cpp:69
-
void setMetadata(const Metadata &metadata)
Updates the metadata for the DObject.
Definition DObject.cpp:48
-
const DataType & getData() const noexcept
Retrieves the data stored in the DObject.
Definition DObject.cpp:26
-
void setDebugging(bool enableDebug)
Enables or disables debugging and tracing for the DObject.
Definition DObject.cpp:55
-
void runPlugin(const std::string &id)
Executes a plugin by its identifier.
Definition DObject.cpp:88
-
void unregisterPlugin(const std::string &id)
Unregisters a plugin by its identifier.
Definition DObject.cpp:79
-
void setData(const DataType &data)
Sets the data for the DObject.
Definition DObject.cpp:33
-
std::variant< int, float, double, std::string, std::monostate, std::vector< int >, std::vector< float >, std::vector< double > > DataType
Supported data types for the DObject.
Definition DObject.h:37
-
bool isDebuggingEnabled() const noexcept
Checks if debugging is enabled for the DObject.
Definition DObject.cpp:62
-
std::function< void(DObject &)> Plugin
Placeholder type for plugins.
Definition DObject.h:47
-
+
+
+
+
+
+
+
+
+
+
+
155 template <typename T>
+
+
+
157 if (std::holds_alternative<T>(
data_ )) {
+
158 return std::get<T>(
data_ );
+
+
160 throw std::bad_variant_access();
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
248 friend std::ostream& operator<<(std::ostream& os, const
DObject & obj);
+
+
+
+
+
+
+
+
+
+
+
A universal data container class.
+
DObject()
Default constructor.
+
void runAllPlugins()
Executes all registered plugins in the registry.
+
void registerPlugin(const std::string &id, Plugin plugin)
Registers a plugin with the DObject.
+
std::map< int, std::string > dataTypeMap
+
int setErrorCode(int code) noexcept
+
const DataType & getData() const noexcept
Retrieves the data stored in the DObject.
+
std::variant< bool, short int, int, long int, float, double, long double, std::string, std::monostate, std::vector< int >, std::vector< float >, std::vector< double >, std::vector< std::string >, std::vector< std::vector< int > >, std::vector< std::vector< float > >, std::vector< std::vector< double > >, std::vector< std::vector< std::vector< int > > >, std::vector< std::vector< std::vector< float > > >, std::vector< std::vector< std::vector< double > > > > DataType
Supported data types for the DObject.
+
void setDebugging(bool enableDebug)
Enables or disables debugging and tracing for the DObject.
+
void runPlugin(const std::string &id)
Executes a plugin by its identifier.
+
void unregisterPlugin(const std::string &id)
Unregisters a plugin by its identifier.
+
void setData(const DataType &data)
Sets the data for the DObject.
+
T getDataAs() const
Retrieves the data stored in the DObject as a typed object so that std::get<T>() is not needed.
+
bool debugEnabled_
Indicates whether debugging is enabled.
+
DataType data_
The main data stored in the DObject.
+
int errorCode_
Error code tracked by the DObject.
+
bool isDebuggingEnabled() const noexcept
Checks if debugging is enabled for the DObject.
+
std::map< std::string, Plugin > plugins_
Registry for dynamically registered plugins.
+
std::function< void(DObject &)> Plugin
Placeholder type for plugins.
+
int getErrorCode() const noexcept
Get the error code tracked by the DObject.
diff --git a/docs/html/_lockable_d_object_8h.html b/docs/html/_lockable_d_object_8h.html
index aecee3e..d344e1f 100644
--- a/docs/html/_lockable_d_object_8h.html
+++ b/docs/html/_lockable_d_object_8h.html
@@ -5,7 +5,7 @@
-
New 4DSSE Code: src/dobj/public/LockableDObject.h File Reference
+
SERiF: src/dobj/public/LockableDObject.h File Reference
@@ -18,12 +18,9 @@
-
+
+
@@ -32,21 +29,10 @@
- New 4DSSE Code
0.0.1a
+
SERiF 0.0.1a
+
3+1D Stellar Structure and Evolution
-
-
@@ -63,6 +49,17 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
+
+
+
+
@@ -124,6 +121,8 @@ Classes
A lightweight wrapper for DObject that adds locking capabilities.
This class allows safe concurrent access to a DObject by providing locking and unlocking methods.
+
+
Definition in file LockableDObject.h .
diff --git a/docs/html/_lockable_d_object_8h_source.html b/docs/html/_lockable_d_object_8h_source.html
index 797a12c..98412dc 100644
--- a/docs/html/_lockable_d_object_8h_source.html
+++ b/docs/html/_lockable_d_object_8h_source.html
@@ -5,7 +5,7 @@
-
New 4DSSE Code: src/dobj/public/LockableDObject.h Source File
+
SERiF: src/dobj/public/LockableDObject.h Source File
@@ -18,12 +18,9 @@
-
+
+
@@ -32,21 +29,10 @@
- New 4DSSE Code
0.0.1a
+
SERiF 0.0.1a
+
3+1D Stellar Structure and Evolution
-
-
@@ -63,6 +49,17 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
+
+
+
+
@@ -105,36 +102,58 @@ $(function(){initNavTree('_lockable_d_object_8h_source.html',''); initResizable(
-
Go to the documentation of this file. 1 #ifndef LOCKABLE_DOBJECT_H
-
2 #define LOCKABLE_DOBJECT_H
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
21 #ifndef LOCKABLE_DOBJECT_H
+
22 #define LOCKABLE_DOBJECT_H
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
Defines the DObject class, a universal data container for the project.
-
A universal data container class.
Definition DObject.h:29
-
void unlock()
Unlocks the mutex after thread-safe access.
Definition LockableDObject.cpp:20
-
DObject & get()
Access the underlying DObject.
Definition LockableDObject.cpp:6
-
void lock()
Locks the mutex to ensure thread-safe access.
Definition LockableDObject.cpp:13
+
A universal data container class.
+
void unlock()
Unlocks the mutex after thread-safe access.
+
DObject object_
The underlying DObject instance.
+
std::mutex mutex_
Mutex for thread-safe access.
+
DObject & get()
Access the underlying DObject.
+
void lock()
Locks the mutex to ensure thread-safe access.
LockableDObject()=default
Default constructor.
diff --git a/docs/html/_metadata_8cpp.html b/docs/html/_metadata_8cpp.html
index f75b54f..4177241 100644
--- a/docs/html/_metadata_8cpp.html
+++ b/docs/html/_metadata_8cpp.html
@@ -5,7 +5,7 @@
-
New 4DSSE Code: src/dobj/private/Metadata.cpp File Reference
+
SERiF: src/dobj/private/Metadata.cpp File Reference
@@ -18,12 +18,9 @@
-
+
+
@@ -32,21 +29,10 @@
- New 4DSSE Code
0.0.1a
+
SERiF 0.0.1a
+
3+1D Stellar Structure and Evolution
-
-
@@ -63,6 +49,17 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
+
+
+
+
@@ -111,7 +108,9 @@ $(function(){initNavTree('_metadata_8cpp.html',''); initResizable(true); });
Implementation of the Metadata class used in the dobj module.
More...
+
+Go to the source code of this file.
+
std::ostream & operator<< (std::ostream &os, const Metadata &metadata)
@@ -121,6 +120,8 @@ Functions
Implementation of the Metadata class used in the dobj module.
Provides methods to manage metadata for data objects, including size, type, dimensions, and debugging flags.
+
+
Definition in file Metadata.cpp .
◆ operator<<()
@@ -152,6 +153,8 @@ Functions
Returns A reference to the output stream.
+Definition at line 146 of file Metadata.cpp .
+
diff --git a/docs/html/_metadata_8h.html b/docs/html/_metadata_8h.html
index a98dbc9..e89aae5 100644
--- a/docs/html/_metadata_8h.html
+++ b/docs/html/_metadata_8h.html
@@ -5,7 +5,7 @@
-New 4DSSE Code: src/dobj/public/Metadata.h File Reference
+SERiF: src/dobj/public/Metadata.h File Reference
@@ -18,12 +18,9 @@
-
+
+
@@ -32,21 +29,10 @@
- New 4DSSE Code
0.0.1a
+
SERiF 0.0.1a
+
3+1D Stellar Structure and Evolution
-
-
@@ -63,6 +49,17 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
+
+
+
+
@@ -123,11 +120,35 @@ Classes
class Metadata
Represents metadata information for data objects in the dobj module. More...
+
Public interface for the Metadata class used in the dobj module.
The Metadata class provides descriptive information about the data encapsulated within a dobj, including size, type, dimensions, and debugging flags.
-
+
+
Definition in file Metadata.h .
+
+
+
◆ EXPORT_SYMBOL
+
+
+
+
+
+ #define EXPORT_SYMBOL
+
+
+
+
+
diff --git a/docs/html/_metadata_8h.js b/docs/html/_metadata_8h.js
index 17f5c1f..4b71f7c 100644
--- a/docs/html/_metadata_8h.js
+++ b/docs/html/_metadata_8h.js
@@ -1,4 +1,5 @@
var _metadata_8h =
[
- [ "Metadata", "class_metadata.html", "class_metadata" ]
+ [ "Metadata", "class_metadata.html", "class_metadata" ],
+ [ "EXPORT_SYMBOL", "_metadata_8h.html#ab57c319c35ea0fbacf781f2ecb3a4339", null ]
];
\ No newline at end of file
diff --git a/docs/html/_metadata_8h_source.html b/docs/html/_metadata_8h_source.html
index c9c6ee4..cb6bf35 100644
--- a/docs/html/_metadata_8h_source.html
+++ b/docs/html/_metadata_8h_source.html
@@ -5,7 +5,7 @@
-
New 4DSSE Code: src/dobj/public/Metadata.h Source File
+
SERiF: src/dobj/public/Metadata.h Source File
@@ -18,12 +18,9 @@
-
+
+
@@ -32,21 +29,10 @@
- New 4DSSE Code
0.0.1a
+
SERiF 0.0.1a
+
3+1D Stellar Structure and Evolution
-
-
@@ -63,6 +49,17 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
+
+
+
+
@@ -105,64 +102,89 @@ $(function(){initNavTree('_metadata_8h_source.html',''); initResizable(true); })
-
Go to the documentation of this file.
-
-
-
4 #if defined(__APPLE__) || defined(__linux__)
-
5 #define EXPORT_SYMBOL __attribute__((visibility("default")))
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
46 Metadata (std::size_t byteSize, std::string dataType, std::vector<std::size_t> dimensions,
bool debugFlag =
false );
-
-
52 [[nodiscard]] std::size_t
getByteSize () const noexcept;
-
-
-
-
64 [[nodiscard]] const std::
string &
getDataType () const noexcept;
-
-
-
-
76 [[nodiscard]] const std::vector<std::
size_t >&
getDimensions () const noexcept;
-
-
82 void setDimensions (const std::vector<std::
size_t >& dimensions);
-
-
-
-
-
-
103 friend std::ostream& operator<<(std::ostream& os, const
Metadata & metadata);
-
-
-
106 std::
size_t byteSize_ = 0;
-
107 std::
string dataType_;
-
108 std::vector<std::
size_t > dimensions_;
-
109 bool debugFlag_ = false;
-
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
24 #if defined(__APPLE__) || defined(__linux__)
+
25 #define EXPORT_SYMBOL __attribute__((visibility("default")))
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
66 Metadata (std::size_t byteSize, std::string dataType, std::vector<std::size_t> dimensions,
bool debugFlag =
false );
+
+
72 [[nodiscard]] std::size_t
getByteSize () const noexcept;
+
+
+
+
84 [[nodiscard]] const std::
string &
getDataType () const noexcept;
+
+
+
+
96 [[nodiscard]] const std::vector<std::
size_t >&
getDimensions () const noexcept;
+
+
102 void setDimensions (const std::vector<std::
size_t >& dimensions);
+
+
+
+
+
+
123 friend std::ostream& operator<<(std::ostream& os, const
Metadata & metadata);
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
diff --git a/docs/html/annotated.html b/docs/html/annotated.html
index 29e3b61..814cf35 100644
--- a/docs/html/annotated.html
+++ b/docs/html/annotated.html
@@ -1,65 +1,65 @@
-
+
-
-
+
+
-
New 4DSSE Code: Class List
+
SERiF: Class List
+
-
+
+
-
+
+
-
-
- New 4DSSE Code
-
0.0.1a
+
+
+ SERiF 0.0.1a
+ 3+1D Stellar Structure and Evolution
-
-
-
+
+
+
+
+
+
@@ -72,8 +72,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
@@ -86,40 +86,76 @@ $(document).ready(function(){initNavTree('annotated.html',''); initResizable();
-
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
Here are the classes, structs, unions and interfaces with brief descriptions:
-
- C BilinearIntegratorWrapper A wrapper class for bilinear integrator
- C CompositeNonlinearIntegrator A class for composite nonlinear integrator
- C Config Singleton class to manage configuration settings loaded from a YAML file
- C configTest Test suite for the Config class
- C configTestPrivateAccessor
- C Constant Structure to hold a constant's details
- C Constants Class to manage a collection of constants
- C constTest Test suite for the const class
- C DObject A universal data container class
- C DObjectTest Test suite for the DObject class
- C Header Structure to hold the header information of an OPAT file
- C LockableDObject Wrapper for DObject with thread-safe access
- C LockableDObjectTest Test suite for the LockableDObject class
- C MeshIO Class for handling mesh input/output operations
- C meshIOTest
- C Metadata Represents metadata information for data objects in the dobj module
- C MetadataTest Test suite for the Metadata class
- C NonlinearPowerIntegrator A class for nonlinear power integrator
- C OpatIO Class to manage the input/output operations for OPAT files
- C opatIOTest Test suite for the const class
- C OPATTable Structure to hold the data of an OPAT table
- C TableIndex Structure to hold the index information of a table in an OPAT file
+[detail level 1 2 ]
@@ -127,7 +163,7 @@ $(document).ready(function(){initNavTree('annotated.html',''); initResizable();
diff --git a/docs/html/annotated_dup.js b/docs/html/annotated_dup.js
index e869f63..8f62633 100644
--- a/docs/html/annotated_dup.js
+++ b/docs/html/annotated_dup.js
@@ -1,25 +1,62 @@
var annotated_dup =
[
- [ "BilinearIntegratorWrapper", "classBilinearIntegratorWrapper.html", "classBilinearIntegratorWrapper" ],
- [ "CompositeNonlinearIntegrator", "classCompositeNonlinearIntegrator.html", "classCompositeNonlinearIntegrator" ],
- [ "Config", "classConfig.html", null ],
- [ "configTest", "classconfigTest.html", null ],
- [ "configTestPrivateAccessor", "classconfigTestPrivateAccessor.html", null ],
- [ "Constant", "structConstant.html", "structConstant" ],
- [ "Constants", "classConstants.html", "classConstants" ],
- [ "constTest", "classconstTest.html", "classconstTest" ],
- [ "DObject", "classDObject.html", "classDObject" ],
- [ "DObjectTest", "classDObjectTest.html", "classDObjectTest" ],
- [ "Header", "structHeader.html", "structHeader" ],
- [ "LockableDObject", "classLockableDObject.html", "classLockableDObject" ],
- [ "LockableDObjectTest", "classLockableDObjectTest.html", "classLockableDObjectTest" ],
- [ "MeshIO", "classMeshIO.html", "classMeshIO" ],
- [ "meshIOTest", "classmeshIOTest.html", null ],
- [ "Metadata", "classMetadata.html", "classMetadata" ],
- [ "MetadataTest", "classMetadataTest.html", "classMetadataTest" ],
- [ "NonlinearPowerIntegrator", "classNonlinearPowerIntegrator.html", "classNonlinearPowerIntegrator" ],
- [ "OpatIO", "classOpatIO.html", "classOpatIO" ],
- [ "opatIOTest", "classopatIOTest.html", null ],
- [ "OPATTable", "structOPATTable.html", "structOPATTable" ],
- [ "TableIndex", "structTableIndex.html", "structTableIndex" ]
+ [ "composition", "namespacecomposition.html", [
+ [ "Composition", "classcomposition_1_1_composition.html", "classcomposition_1_1_composition" ],
+ [ "CompositionEntry", "structcomposition_1_1_composition_entry.html", "structcomposition_1_1_composition_entry" ],
+ [ "GlobalComposition", "structcomposition_1_1_global_composition.html", "structcomposition_1_1_global_composition" ]
+ ] ],
+ [ "helmholtz", "namespacehelmholtz.html", [
+ [ "EOS", "structhelmholtz_1_1_e_o_s.html", "structhelmholtz_1_1_e_o_s" ],
+ [ "EOSInput", "structhelmholtz_1_1_e_o_s_input.html", "structhelmholtz_1_1_e_o_s_input" ],
+ [ "HELMTable", "structhelmholtz_1_1_h_e_l_m_table.html", "structhelmholtz_1_1_h_e_l_m_table" ]
+ ] ],
+ [ "nnApprox8", "namespacenn_approx8.html", [
+ [ "Approx8Network", "classnn_approx8_1_1_approx8_network.html", "classnn_approx8_1_1_approx8_network" ],
+ [ "Jacobian", "structnn_approx8_1_1_jacobian.html", "structnn_approx8_1_1_jacobian" ],
+ [ "Net", "structnn_approx8_1_1_net.html", "structnn_approx8_1_1_net" ],
+ [ "ODE", "structnn_approx8_1_1_o_d_e.html", "structnn_approx8_1_1_o_d_e" ]
+ ] ],
+ [ "nuclearNetwork", "namespacenuclear_network.html", [
+ [ "NetIn", "structnuclear_network_1_1_net_in.html", "structnuclear_network_1_1_net_in" ],
+ [ "NetOut", "structnuclear_network_1_1_net_out.html", "structnuclear_network_1_1_net_out" ],
+ [ "Network", "classnuclear_network_1_1_network.html", "classnuclear_network_1_1_network" ]
+ ] ],
+ [ "polycoeff", "namespacepolycoeff.html", [
+ [ "dThetaInterpCoeff", "structpolycoeff_1_1d_theta_interp_coeff.html", "structpolycoeff_1_1d_theta_interp_coeff" ],
+ [ "x1InterpCoeff", "structpolycoeff_1_1x1_interp_coeff.html", "structpolycoeff_1_1x1_interp_coeff" ]
+ ] ],
+ [ "polyMFEMUtils", "namespacepoly_m_f_e_m_utils.html", [
+ [ "NonlinearPowerIntegrator", "classpoly_m_f_e_m_utils_1_1_nonlinear_power_integrator.html", "classpoly_m_f_e_m_utils_1_1_nonlinear_power_integrator" ]
+ ] ],
+ [ "Probe", "namespace_probe.html", [
+ [ "LogManager", "class_probe_1_1_log_manager.html", "class_probe_1_1_log_manager" ]
+ ] ],
+ [ "approx8Test", "classapprox8_test.html", null ],
+ [ "compositionTest", "classcomposition_test.html", null ],
+ [ "Config", "class_config.html", null ],
+ [ "configTest", "classconfig_test.html", null ],
+ [ "configTestPrivateAccessor", "classconfig_test_private_accessor.html", "classconfig_test_private_accessor" ],
+ [ "Constant", "struct_constant.html", "struct_constant" ],
+ [ "Constants", "class_constants.html", "class_constants" ],
+ [ "constTest", "classconst_test.html", "classconst_test" ],
+ [ "DObject", "class_d_object.html", "class_d_object" ],
+ [ "DObjectTest", "class_d_object_test.html", "class_d_object_test" ],
+ [ "EosIO", "class_eos_i_o.html", "class_eos_i_o" ],
+ [ "eosTest", "classeos_test.html", null ],
+ [ "formBundle", "structform_bundle.html", "structform_bundle" ],
+ [ "GMRESInverter", "class_g_m_r_e_s_inverter.html", "class_g_m_r_e_s_inverter" ],
+ [ "LockableDObject", "class_lockable_d_object.html", "class_lockable_d_object" ],
+ [ "LockableDObjectTest", "class_lockable_d_object_test.html", "class_lockable_d_object_test" ],
+ [ "MeshIO", "class_mesh_i_o.html", "class_mesh_i_o" ],
+ [ "meshIOTest", "classmesh_i_o_test.html", null ],
+ [ "Metadata", "class_metadata.html", "class_metadata" ],
+ [ "MetadataTest", "class_metadata_test.html", "class_metadata_test" ],
+ [ "PolySolver", "class_poly_solver.html", "class_poly_solver" ],
+ [ "polyTest", "classpoly_test.html", null ],
+ [ "PolytropeOperator", "class_polytrope_operator.html", "class_polytrope_operator" ],
+ [ "probeTest", "classprobe_test.html", null ],
+ [ "ResourceManager", "class_resource_manager.html", "class_resource_manager" ],
+ [ "resourceManagerTest", "classresource_manager_test.html", null ],
+ [ "SchurCompliment", "class_schur_compliment.html", "class_schur_compliment" ],
+ [ "solverBundle", "structsolver_bundle.html", "structsolver_bundle" ]
];
\ No newline at end of file
diff --git a/docs/html/class_d_object-members.html b/docs/html/class_d_object-members.html
index 394927c..360614c 100644
--- a/docs/html/class_d_object-members.html
+++ b/docs/html/class_d_object-members.html
@@ -5,7 +5,7 @@
-New 4DSSE Code: Member List
+SERiF: Member List
@@ -18,12 +18,9 @@
-
+
+
@@ -32,21 +29,10 @@
- New 4DSSE Code
0.0.1a
+
SERiF 0.0.1a
+
3+1D Stellar Structure and Evolution
-
-
@@ -63,6 +49,17 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
+
+
+
+
@@ -108,20 +105,26 @@ $(function(){initNavTree('class_d_object.html',''); initResizable(true); });
This is the complete list of members for DObject , including all inherited members.
diff --git a/docs/html/class_d_object.html b/docs/html/class_d_object.html
index 8ef515c..6d22427 100644
--- a/docs/html/class_d_object.html
+++ b/docs/html/class_d_object.html
@@ -5,7 +5,7 @@
-
New 4DSSE Code: DObject Class Reference
+
SERiF: DObject Class Reference
@@ -18,12 +18,9 @@
-
+
+
@@ -32,21 +29,10 @@
- New 4DSSE Code
0.0.1a
+
SERiF 0.0.1a
+
3+1D Stellar Structure and Evolution
-
-
@@ -63,6 +49,17 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
+
+
+
+
@@ -105,6 +102,8 @@ $(function(){initNavTree('class_d_object.html',''); initResizable(true); });
@@ -118,9 +117,9 @@ $(function(){initNavTree('class_d_object.html',''); initResizable(true); });
std::ostream & operator<< (std::ostream &os, const DObject &obj)
@@ -172,27 +194,67 @@ Friends
A universal data container class.
-
The DObject class is designed to store arbitrary data alongside descriptive metadata. It supports plugin registration to allow extensible functionality.
+
The DObject class is designed to store arbitrary data alongside descriptive metadata. It supports plugin registration to allow extensible functionality.
+
The general purpose of this is to simplify memory managment, function interfaces, and interoperability with other languages by wrapping all of that up inside of one location (DObject ). There are still a limited number of types that DOBject can represent these include
+bool
+short int
+int
+long int
+float
+double
+long double
+std::string
+std::monostate
+std::vector<int>
+std::vector<float>
+std::vector<double>
+std::vector<std::string>
+std::vector<std::vector<int>>
+std::vector<std::vector<float>>
+std::vector<std::vector<double>>
+std::vector<std::vector<std::vector<int>>>
+std::vector<std::vector<std::vector<float>>>
+std::vector<std::vector<std::vector<double>>
+
+
If more types are needed, they can be added to the DataType variant.
+
In general the usage of this might look like
+
std::vector<int> data = {1, 2, 3, 4, 5};
+
+
std::cout << "Data is " << obj << std::end;
+
someFunction(&obj);
+
DObject()
Default constructor.
+
void setData(const DataType &data)
Sets the data for the DObject.
+
All memory managment should be taken care of as all datatypes accepted by the varient are either primatives or include their own built in memory managment (i.e. this means that wherever possible vectors should be used in place of raw arrays).
+
+
Definition at line 89 of file DObject.h .
-
-
◆ DataType
+
+
◆ DataType
Initial value: std::variant<
-
int, float, double, std::string, std::monostate,
-
std::vector<int>, std::vector<float>, std::vector<double>
+
bool, short int, int, long int, float, double,
+
long double, std::string, std::monostate, std::vector<int>,
+
std::vector<float>, std::vector<double>, std::vector<std::string>,
+
std::vector<std::vector<int>>, std::vector<std::vector<float>>,
+
std::vector<std::vector<double>>,
+
std::vector<std::vector<std::vector<int>>>,
+
std::vector<std::vector<std::vector<float>>>,
+
std::vector<std::vector<std::vector<double>>>
>
Supported data types for the DObject .
This type alias uses std::variant to store different types of data, ensuring type safety and flexibility.
+
Definition at line 97 of file DObject.h .
+
@@ -210,6 +272,8 @@ Friends
Placeholder type for plugins.
In the future, this will be replaced with a concrete interface.
+
Definition at line 125 of file DObject.h .
+
@@ -229,12 +293,14 @@ Friends
Default constructor.
-
Creates an empty DObject with default metadata.
+
Creates an empty DObject .
+
+
Definition at line 33 of file DObject.cpp .
-
-
◆ DObject() [2/2]
+
+
◆ DObject() [2/2]
@@ -242,25 +308,22 @@ Friends
DObject::DObject
(
- const DataType & data ,
-
-
-
+ const DataType & data )
- const Metadata & metadata )
-
Constructor to initialize a DObject with data and metadata.
+
Constructor to initialize a DObject with data.
Parameters
data The data to be stored in the DObject .
- metadata Metadata describing the stored data.
+
Definition at line 40 of file DObject.cpp .
+
@@ -274,7 +337,7 @@ Friends
- const DObject::DataType & DObject::getData
+ const DObject::DataType & DObject::getData
(
)
const
@@ -291,10 +354,44 @@ Friends
Use the appropriate type (matching the stored data) with std::get<T>().
Returns A constant reference to the stored data.
+Definition at line 46 of file DObject.cpp .
+
-
-◆ getMetadata()
+
+◆ getDataAs()
+
+
+
+
+template<typename T>
+
+
+
+
+
+ T DObject::getDataAs
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
+
Retrieves the data stored in the DObject as a typed object so that std::get<T>() is not needed.
+
Returns Data as type T
+
+
Definition at line 156 of file DObject.h .
+
+
+
+
+◆ getErrorCode()
@@ -303,7 +400,7 @@ Friends
- const Metadata & DObject::getMetadata
+ int DObject::getErrorCode
(
)
const
@@ -316,9 +413,10 @@ Friends
-
Retrieves the metadata associated with the DObject .
-
The metadata provides essential information about the stored data, such as its type, size, and dimensions.
-
Returns A constant reference to the metadata.
+
Get the error code tracked by the DObject .
+
Returns The error code
+
+
Definition at line 80 of file DObject.cpp .
@@ -340,7 +438,7 @@ Friends
-nodiscard noexcept
+
noexcept
@@ -348,6 +446,8 @@ Friends
Checks if debugging is enabled for the DObject .
Returns True if debugging is enabled, false otherwise.
+
Definition at line 67 of file DObject.cpp .
+
@@ -379,6 +479,8 @@ Friends
+
Definition at line 87 of file DObject.cpp .
+
@@ -399,6 +501,8 @@ Friends
Executes all registered plugins in the registry.
Iterates through all plugins and invokes them on the current DObject .
+
Definition at line 117 of file DObject.cpp .
+
@@ -425,6 +529,8 @@ Friends
+
Definition at line 106 of file DObject.cpp .
+
@@ -436,7 +542,7 @@ Friends
void DObject::setData
(
- const DataType & data )
+ const DataType & data )
@@ -451,6 +557,8 @@ Friends
+Definition at line 53 of file DObject.cpp .
+
@@ -477,31 +585,37 @@ Friends
+Definition at line 60 of file DObject.cpp .
+
-
-◆ setMetadata()
+
+◆ setErrorCode()
+
+
+
- void DObject::setMetadata
+ int DObject::setErrorCode
(
- const Metadata & metadata )
+ int code )
+
+
+noexcept
+
+
+
@breif Set error code tracked by the DOBject
+
Returns The previous error code
+
@breif Sets an error code and returns the old one
-
Updates the metadata for the DObject .
-
Use this function carefully to ensure consistency between the data and metadata.
-
Parameters
-
- metadata The new metadata to associate with the DObject .
-
-
-
+
Definition at line 74 of file DObject.cpp .
@@ -529,6 +643,8 @@ Friends
+Definition at line 97 of file DObject.cpp .
+
@@ -570,11 +686,143 @@ Friends
Returns A reference to the output stream.
+Definition at line 126 of file DObject.cpp .
+
+
+
+
+
+◆ data_
+
+
+
+◆ dataTypeMap
+
+
+
+
+
+ std::map<int, std::string> DObject::dataTypeMap
+
+
+
+
Initial value: = {
+
{0, "bool" }, {1, "short int" }, {2, "int" }, {3, "long int" }, {4, "float" },
+
{5, "double" }, {6, "long double" }, {7, "string" }, {8, "std::monostate" },
+
{9, "vector<int>" }, {10, "vector<float>" }, {11, "vector<double>" },
+
{12, "vector<string>" }, {13, "vector<vector<int>" },
+
{14, "vector<vector<float>" }, {15, "vector<vector<double>" },
+
{16, "vector<vector<vector<int>>" }, {17, "vector<vector<vector<float>>" },
+
{18, "vector<vector<vector<double>>" }
+
}
+
+
Definition at line 109 of file DObject.h .
+
+
+
+
+◆ debugEnabled_
+
+
+
+
+
+
+
+
+ bool DObject::debugEnabled_ = false
+
+
+
+
+private
+
+
+
+
+
Indicates whether debugging is enabled.
+
+
Definition at line 252 of file DObject.h .
+
+
+
+
+◆ errorCode_
+
+
+
+
+
+
+
+
+ int DObject::errorCode_ = 0
+
+
+
+
+private
+
+
+
+
+
+◆ plugins_
+
+
+
+
+
+
+
+
+ std::map<std::string, Plugin > DObject::plugins_
+
+
+
+
+private
+
+
+
+
+
Registry for dynamically registered plugins.
+
+
Definition at line 254 of file DObject.h .
+
The documentation for this class was generated from the following files:
diff --git a/docs/html/class_d_object.js b/docs/html/class_d_object.js
index d22767d..b512b2a 100644
--- a/docs/html/class_d_object.js
+++ b/docs/html/class_d_object.js
@@ -1,18 +1,24 @@
var class_d_object =
[
- [ "DataType", "class_d_object.html#ad6fc2e29eae70cf94a2d241527857573", null ],
+ [ "DataType", "class_d_object.html#a55b7cdac36a3a518ba6e1ecef0e25dcd", null ],
[ "Plugin", "class_d_object.html#af11334d08ef85c68b3aae7554548e5a7", null ],
[ "DObject", "class_d_object.html#a0ae54853e18265657296bfb5ac3bf9d0", null ],
- [ "DObject", "class_d_object.html#ab0c940fa193a42158c6726bf1a2ef54d", null ],
+ [ "DObject", "class_d_object.html#a598321f3b8524b98df72393c04d7470c", null ],
[ "getData", "class_d_object.html#a4862655c3634d019b0a45b811d6f7235", null ],
- [ "getMetadata", "class_d_object.html#a157b31e881aac6dd40782d3abc561d4e", null ],
+ [ "getDataAs", "class_d_object.html#aca2db093c1c8c6f7893de07544aed619", null ],
+ [ "getErrorCode", "class_d_object.html#afa8926d916081de72478cb8813c25e98", null ],
[ "isDebuggingEnabled", "class_d_object.html#ae47bf220fbe2173cf6933c2380035dbd", null ],
[ "registerPlugin", "class_d_object.html#a15afffdf339150fc872bf63bdd08d581", null ],
[ "runAllPlugins", "class_d_object.html#a1223275dcbbf20334ea11707346acb93", null ],
[ "runPlugin", "class_d_object.html#a99072eb52bb22745f0248f273fbf28fb", null ],
[ "setData", "class_d_object.html#ab1718571434e84e90f1ec463e4786a8a", null ],
[ "setDebugging", "class_d_object.html#a6f0023aee463e71d92442dcf61b6ed47", null ],
- [ "setMetadata", "class_d_object.html#a296b1519249fdc1f6c7b4ab62d5421bc", null ],
+ [ "setErrorCode", "class_d_object.html#a3dce47a519f9da5085c0c5ac1eea4f38", null ],
[ "unregisterPlugin", "class_d_object.html#a99b8688849e11501033a25f61efb8356", null ],
- [ "operator<<", "class_d_object.html#aa54e75574f0302a2ca7252f9f0f0b3f1", null ]
+ [ "operator<<", "class_d_object.html#aa54e75574f0302a2ca7252f9f0f0b3f1", null ],
+ [ "data_", "class_d_object.html#ad7ba02f6d87ce64792149096f3310b21", null ],
+ [ "dataTypeMap", "class_d_object.html#a358d5f015da09ae5f0cbb46f3fd9e401", null ],
+ [ "debugEnabled_", "class_d_object.html#accf5c10d4afc3969607e11b0055312d5", null ],
+ [ "errorCode_", "class_d_object.html#ad8de5890e8dae5fc7e72fabca2520fc3", null ],
+ [ "plugins_", "class_d_object.html#ae9f7e4d2fbabc076961a40185676e208", null ]
];
\ No newline at end of file
diff --git a/docs/html/class_lockable_d_object-members.html b/docs/html/class_lockable_d_object-members.html
index 258beda..b5dfd71 100644
--- a/docs/html/class_lockable_d_object-members.html
+++ b/docs/html/class_lockable_d_object-members.html
@@ -5,7 +5,7 @@
-New 4DSSE Code: Member List
+SERiF: Member List
@@ -18,12 +18,9 @@
-
+
+
@@ -32,21 +29,10 @@
- New 4DSSE Code
0.0.1a
+
SERiF 0.0.1a
+
3+1D Stellar Structure and Evolution
-
-
@@ -63,6 +49,17 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
+
+
+
+
diff --git a/docs/html/class_lockable_d_object.html b/docs/html/class_lockable_d_object.html
index 7d7bd8e..aaae3fb 100644
--- a/docs/html/class_lockable_d_object.html
+++ b/docs/html/class_lockable_d_object.html
@@ -5,7 +5,7 @@
-New 4DSSE Code: LockableDObject Class Reference
+SERiF: LockableDObject Class Reference
@@ -18,12 +18,9 @@
-
+
+
@@ -32,21 +29,10 @@
- New 4DSSE Code
0.0.1a
+
SERiF 0.0.1a
+
3+1D Stellar Structure and Evolution
-
-
@@ -63,6 +49,17 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
+
+
+
+
@@ -104,6 +101,7 @@ $(function(){initNavTree('class_lockable_d_object.html',''); initResizable(true)
@@ -116,25 +114,61 @@ $(function(){initNavTree('class_lockable_d_object.html',''); initResizable(true)
-
- LockableDObject ()=default
- Default constructor.
+ LockableDObject ()=default
+ Default constructor.
DObject & get ()
Access the underlying DObject .
-
-void lock ()
- Locks the mutex to ensure thread-safe access.
+void lock ()
+ Locks the mutex to ensure thread-safe access.
-
-void unlock ()
- Unlocks the mutex after thread-safe access.
+void unlock ()
+ Unlocks the mutex after thread-safe access.
+
Wrapper for DObject with thread-safe access.
-
+
+
Definition at line 39 of file LockableDObject.h .
+
+
+
◆ LockableDObject()
+
+
+
+
+
+
+
+
+ LockableDObject::LockableDObject
+ (
+ )
+
+
+
+
+
+default
+
+
+
+
+
Default constructor.
+
+
+
+
◆ get()
@@ -153,11 +187,108 @@ void
unlock ()Access the underlying
DObject .
Returns A reference to the wrapped DObject .
+
Definition at line 26 of file LockableDObject.cpp .
+
+
+
+
+◆ lock()
+
+
+
+
+
+ void LockableDObject::lock
+ (
+ )
+
+
+
+
+
+
Locks the mutex to ensure thread-safe access.
+
+
Definition at line 33 of file LockableDObject.cpp .
+
+
+
+
+◆ unlock()
+
+
+
+
+
+ void LockableDObject::unlock
+ (
+ )
+
+
+
+
+
+
+
+◆ mutex_
+
+
+
+
+
+
+
+
+ std::mutex LockableDObject::mutex_
+
+
+
+
+private
+
+
+
+
+
+◆ object_
+
+
+
+
+
+
+
+
+ DObject LockableDObject::object_
+
+
+
+
+private
+
+
+
The documentation for this class was generated from the following files:
diff --git a/docs/html/class_lockable_d_object.js b/docs/html/class_lockable_d_object.js
index 9200c33..d537ab7 100644
--- a/docs/html/class_lockable_d_object.js
+++ b/docs/html/class_lockable_d_object.js
@@ -3,5 +3,7 @@ var class_lockable_d_object =
[ "LockableDObject", "class_lockable_d_object.html#ae1a174a2740fa053626fe2820ee0efee", null ],
[ "get", "class_lockable_d_object.html#adcfe201fc728cc1c6fcf638a566ba9a1", null ],
[ "lock", "class_lockable_d_object.html#ade38ca54703913359fc3b4366f6e292a", null ],
- [ "unlock", "class_lockable_d_object.html#a1481ed99dcd837490bf28309aadaedfb", null ]
+ [ "unlock", "class_lockable_d_object.html#a1481ed99dcd837490bf28309aadaedfb", null ],
+ [ "mutex_", "class_lockable_d_object.html#a712cd3ea0c565f7e9089a651ef79b7bd", null ],
+ [ "object_", "class_lockable_d_object.html#a1eb1ca1d9cf979dcb9eead96054b89bb", null ]
];
\ No newline at end of file
diff --git a/docs/html/class_metadata-members.html b/docs/html/class_metadata-members.html
index 9f76ecc..4f64cd0 100644
--- a/docs/html/class_metadata-members.html
+++ b/docs/html/class_metadata-members.html
@@ -5,7 +5,7 @@
-New 4DSSE Code: Member List
+SERiF: Member List
@@ -18,12 +18,9 @@
-
+
+
@@ -32,21 +29,10 @@
- New 4DSSE Code
0.0.1a
+
SERiF 0.0.1a
+
3+1D Stellar Structure and Evolution
-
-
@@ -63,6 +49,17 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
+
+
+
+
@@ -108,6 +105,10 @@ $(function(){initNavTree('class_metadata.html',''); initResizable(true); });
This is the complete list of members for Metadata , including all inherited members.
@@ -63,6 +49,17 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
+
+
+
+
@@ -104,6 +101,7 @@ $(function(){initNavTree('class_metadata.html',''); initResizable(true); });