aGrUM 3.3.2
a C++ library for (probabilistic) graphical models
gum::Configuration::Meta Struct Reference

metadata attached to a key by a ### line More...

#include <configuration.h>

Collaboration diagram for gum::Configuration::Meta:
[legend]

Classes

struct  Domain
 domain of validity of an int or float key, written after the type in the ### line: float]0,1[, int[1,], int[0,100]. A bracket turned toward the bound includes it, turned away excludes it ; an omitted bound is unbounded. More...

Public Member Functions

std::string joinedValues () const

Public Attributes

Kind kind {Kind::STR}
Domain domain
 domain of validity (kind == INT or FLOAT)
std::vector< std::string > values
 allowed values (kind == ENUM)
std::string doc
 one-line documentation
std::string targetSection
 replacement key (kind == DEPRECATED)
std::string targetKey
 replacement key (kind == DEPRECATED)

Detailed Description

metadata attached to a key by a ### line

Definition at line 111 of file configuration.h.

Member Function Documentation

◆ joinedValues()

std::string gum::Configuration::Meta::joinedValues ( ) const
Returns
the allowed values joined by '|' (kind == ENUM), empty otherwise.

Definition at line 288 of file configuration.cpp.

288 {
289 std::string res;
290 for (const auto& v: values) {
291 if (!res.empty()) res += '|';
292 res += v;
293 }
294 return res;
295 }
std::vector< std::string > values
allowed values (kind == ENUM)

References values.

Referenced by gum::Configuration::_validate_().

Here is the caller graph for this function:

Member Data Documentation

◆ doc

std::string gum::Configuration::Meta::doc

one-line documentation

Definition at line 132 of file configuration.h.

Referenced by gum::Configuration::_parse_().

◆ domain

Domain gum::Configuration::Meta::domain

domain of validity (kind == INT or FLOAT)

Definition at line 130 of file configuration.h.

Referenced by gum::Configuration::_validate_().

◆ kind

Kind gum::Configuration::Meta::kind {Kind::STR}

Definition at line 129 of file configuration.h.

Referenced by gum::Configuration::_validate_().

◆ targetKey

std::string gum::Configuration::Meta::targetKey

replacement key (kind == DEPRECATED)

Definition at line 134 of file configuration.h.

◆ targetSection

std::string gum::Configuration::Meta::targetSection

replacement key (kind == DEPRECATED)

Definition at line 133 of file configuration.h.

◆ values

std::vector< std::string > gum::Configuration::Meta::values

allowed values (kind == ENUM)

Definition at line 131 of file configuration.h.

Referenced by gum::Configuration::_validate_(), and joinedValues().


The documentation for this struct was generated from the following files: