Emily Boudreaux
6b57738330
Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
59 lines
1.9 KiB
Groff
59 lines
1.9 KiB
Groff
.TH "serif::dimensions::runtime::ThermodynamicQuantityID" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::dimensions::runtime::ThermodynamicQuantityID \- Runtime resolvable ID for a thermodynamic quantity\&. Used in conjunction with concepts to resolve compile time thermodynamic types to runtime values\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <runtime\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "constexpr \fBThermodynamicQuantityID\fP (const std::string_view \fBname\fP) noexcept"
|
|
.br
|
|
.ti -1c
|
|
.RI "constexpr std::string_view \fBname\fP () const noexcept"
|
|
.br
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::string_view \fBm_name\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Friends"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "constexpr bool \fBoperator==\fP (const \fBThermodynamicQuantityID\fP &, const \fBThermodynamicQuantityID\fP &) noexcept=default"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Runtime resolvable ID for a thermodynamic quantity\&. Used in conjunction with concepts to resolve compile time thermodynamic types to runtime values\&.
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "serif::dimensions::runtime::ThermodynamicQuantityID::ThermodynamicQuantityID (const std::string_view name)\fR [inline]\fP, \fR [explicit]\fP, \fR [constexpr]\fP, \fR [noexcept]\fP"
|
|
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "std::string_view serif::dimensions::runtime::ThermodynamicQuantityID::name () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [constexpr]\fP, \fR [noexcept]\fP"
|
|
|
|
.SH "Friends And Related Symbol Documentation"
|
|
.PP
|
|
.SS "bool operator== (const \fBThermodynamicQuantityID\fP & , const \fBThermodynamicQuantityID\fP & )\fR [friend]\fP"
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "std::string_view serif::dimensions::runtime::ThermodynamicQuantityID::m_name\fR [private]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|