tk::ctr::KeywordInfo struct

Keyword information bundle.

Reference
- Public variables
- Pack/Unpack: Serialize KeywordInfo object for Charm++

This bundle contains the information that is used to display on-screen help on all command-line arguments and control file keywords for an exectuable. This struct is stored in a container that associates keywords (used by a grammar and parser) to this struct. The container, an runtime, std::map, is filled by the CmdLine and InputDeck objects' constructors by one or more brigand::for_each which loops through the set of all keywords used in a grammar. The maps are stored in the CmdLine and InputDeck objects (which are tagged tuples) and thus can be migrated through the network, thus the Charm++ parck/unpack routines are defined.

Public variables

std::string shortDescription: Short description.
std::string longDescription: Long description.
std::optional<std::string> alias: Keyword alias.
std::optional<std::string> expt: Expected type description.
std::optional<std::string> lower: Lower bound as string.
std::optional<std::string> upper: Upper bound as string.
std::optional<std::string> choices: Expected choices description.

Pack/Unpack: Serialize KeywordInfo object for Charm++

void pup(PUP::er& p): Pack/Unpack serialize member function.
void operator|(PUP::er& p, KeywordInfo& info): Pack/Unpack serialize operator|.

Function documentation

void tk::ctr::KeywordInfo::pup(PUP::er& p)

Pack/Unpack serialize member function.

Parameters
p in/out	Charm++'s PUP::er serializer object reference

void tk::ctr::KeywordInfo::operator|(PUP::er& p, KeywordInfo& info)

Pack/Unpack serialize operator|.

Parameters
p in/out	Charm++'s PUP::er serializer object reference
info in/out	KeywordInfo object reference