DNDSR 0.1.0.dev1+gcd065ad
Distributed Numeric Data Structure for CFV
Loading...
Searching...
No Matches
DNDS::Config Namespace Reference

Namespace for config field tag kwargs. More...

Classes

struct  EnumValuesTag
 Explicit enum allowed-values tag. More...
 
struct  InfoTag
 Auxiliary info tag (emitted as "x-<key>" in schema). More...
 
struct  RangeTag
 Numeric range constraint. Enforced at parse time in readFromJson and emitted in schema. More...
 

Functions

RangeTag range (double min)
 Create a minimum-only range constraint.
 
RangeTag range (double min, double max)
 Create a min+max range constraint.
 
InfoTag info (std::string key, std::string value)
 Create an auxiliary info tag.
 
EnumValuesTag enum_values (std::vector< std::string > vals)
 Create an enum allowed-values tag.
 

Detailed Description

Namespace for config field tag kwargs.

Tags are lightweight value objects passed as extra arguments to DNDS_FIELD(...). They attach optional metadata (constraints, auxiliary info, enum values) to a field at registration time.

Function Documentation

◆ enum_values()

EnumValuesTag DNDS::Config::enum_values ( std::vector< std::string >  vals)
inline

Create an enum allowed-values tag.

Definition at line 229 of file ConfigParam.hpp.

Here is the caller graph for this function:

◆ info()

InfoTag DNDS::Config::info ( std::string  key,
std::string  value 
)
inline

Create an auxiliary info tag.

Definition at line 223 of file ConfigParam.hpp.

◆ range() [1/2]

RangeTag DNDS::Config::range ( double  min)
inline

Create a minimum-only range constraint.

Definition at line 217 of file ConfigParam.hpp.

Here is the caller graph for this function:

◆ range() [2/2]

RangeTag DNDS::Config::range ( double  min,
double  max 
)
inline

Create a min+max range constraint.

Definition at line 220 of file ConfigParam.hpp.