69 lines
4.5 KiB
Groff
69 lines
4.5 KiB
Groff
|
.TH "serif::model::SpecificationDefinition< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::model::SpecificationDefinition< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations > \- Declare a prescription once; numerical providers and normalization consume this metadata\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
\fR#include <specification\&.hpp>\fP
|
||
|
|
.SS "Public Types"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBSpecificationType\fP = Owner"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBScalarDescription\fP = Scalar"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBDependsOn\fP = ReadFields"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBAffects\fP = ChangedEquations"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Static Public Attributes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "static constexpr std::string_view \fBname\fP {Name\&.data(), Name\&.size()}"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "static constexpr \fBSpecificationRole\fP \fBrole\fP = Role"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "static constexpr \fBGeneratedStateKind\fP \fBgenerated_state_kind\fP = Kind"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "template<typename Owner, \fButils::types::FixedString\fP Name, \fBSpecificationRole\fP Role, \fBGeneratedStateKind\fP Kind = GeneratedStateKind::none, typename Scalar = void, typename ReadFields = Reads<>, typename ChangedEquations = Changes<>>
|
||
|
|
.br
|
||
|
|
struct serif::model::SpecificationDefinition< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >"Declare a prescription once; numerical providers and normalization consume this metadata\&.
|
||
|
|
.SH "Member Typedef Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<typename Owner, \fButils::types::FixedString\fP Name, \fBSpecificationRole\fP Role, \fBGeneratedStateKind\fP Kind = GeneratedStateKind::none, typename Scalar = void, typename ReadFields = Reads<>, typename ChangedEquations = Changes<>> using \fBserif::model::SpecificationDefinition\fP< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >::Affects = ChangedEquations"
|
||
|
|
|
||
|
|
.SS "template<typename Owner, \fButils::types::FixedString\fP Name, \fBSpecificationRole\fP Role, \fBGeneratedStateKind\fP Kind = GeneratedStateKind::none, typename Scalar = void, typename ReadFields = Reads<>, typename ChangedEquations = Changes<>> using \fBserif::model::SpecificationDefinition\fP< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >::DependsOn = ReadFields"
|
||
|
|
|
||
|
|
.SS "template<typename Owner, \fButils::types::FixedString\fP Name, \fBSpecificationRole\fP Role, \fBGeneratedStateKind\fP Kind = GeneratedStateKind::none, typename Scalar = void, typename ReadFields = Reads<>, typename ChangedEquations = Changes<>> using \fBserif::model::SpecificationDefinition\fP< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >::ScalarDescription = Scalar"
|
||
|
|
|
||
|
|
.SS "template<typename Owner, \fButils::types::FixedString\fP Name, \fBSpecificationRole\fP Role, \fBGeneratedStateKind\fP Kind = GeneratedStateKind::none, typename Scalar = void, typename ReadFields = Reads<>, typename ChangedEquations = Changes<>> using \fBserif::model::SpecificationDefinition\fP< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >::SpecificationType = Owner"
|
||
|
|
|
||
|
|
.SH "Member Data Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<typename Owner, \fButils::types::FixedString\fP Name, \fBSpecificationRole\fP Role, \fBGeneratedStateKind\fP Kind = GeneratedStateKind::none, typename Scalar = void, typename ReadFields = Reads<>, typename ChangedEquations = Changes<>> \fBGeneratedStateKind\fP \fBserif::model::SpecificationDefinition\fP< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >::generated_state_kind = Kind\fR [static]\fP, \fR [constexpr]\fP"
|
||
|
|
|
||
|
|
.SS "template<typename Owner, \fButils::types::FixedString\fP Name, \fBSpecificationRole\fP Role, \fBGeneratedStateKind\fP Kind = GeneratedStateKind::none, typename Scalar = void, typename ReadFields = Reads<>, typename ChangedEquations = Changes<>> std::string_view \fBserif::model::SpecificationDefinition\fP< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >::name {Name\&.data(), Name\&.size()}\fR [static]\fP, \fR [constexpr]\fP"
|
||
|
|
|
||
|
|
.SS "template<typename Owner, \fButils::types::FixedString\fP Name, \fBSpecificationRole\fP Role, \fBGeneratedStateKind\fP Kind = GeneratedStateKind::none, typename Scalar = void, typename ReadFields = Reads<>, typename ChangedEquations = Changes<>> \fBSpecificationRole\fP \fBserif::model::SpecificationDefinition\fP< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >::role = Role\fR [static]\fP, \fR [constexpr]\fP"
|
||
|
|
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|