61 lines
1.6 KiB
Groff
61 lines
1.6 KiB
Groff
|
.TH "serif::discretization::blocks::FieldDescriptor" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::discretization::blocks::FieldDescriptor \- Runtime descriptor for a field, containing its name\&. Two FieldDescriptors are equal if they have identical names\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
\fR#include <runtime\&.hpp>\fP
|
||
|
|
.SS "Public Attributes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "std::string_view \fBname\fP"
|
||
|
|
.br
|
||
|
|
.RI "The name of the field, used for runtime identification\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Friends"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "constexpr bool \fBoperator==\fP (const \fBFieldDescriptor\fP &, const \fBFieldDescriptor\fP &) noexcept=default"
|
||
|
|
.br
|
||
|
|
.RI "Compare two FieldDescriptors for equality based on their names\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
Runtime descriptor for a field, containing its name\&. Two FieldDescriptors are equal if they have identical names\&.
|
||
|
|
.SH "Friends And Related Symbol Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "bool operator== (const \fBFieldDescriptor\fP & , const \fBFieldDescriptor\fP & )\fR [friend]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Compare two FieldDescriptors for equality based on their names\&.
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fIlhs\fP The left-hand side \fBFieldDescriptor\fP\&.
|
||
|
|
.br
|
||
|
|
\fIrhs\fP The right-hand side \fBFieldDescriptor\fP\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
True if the names of both FieldDescriptors are equal, false otherwise\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SH "Member Data Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "std::string_view serif::discretization::blocks::FieldDescriptor::name"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
The name of the field, used for runtime identification\&.
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|