tk::ctr::HelpKw struct

Help bundle on a single keyword.

Contents

This is used for delivering help on a single keyword. This struct also differentiates between command-line arguments and control file keywords.

Public variables

HelpFactory::key_type keyword
Keyword string.
HelpFactory::mapped_type info
Keyword information.
bool cmd
True if command-line keyword.

Pack/Unpack: Serialize HelpKw object for Charm++

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

Function documentation

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

Pack/Unpack serialize member function.

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

void tk::ctr::HelpKw::operator|(PUP::er& p, HelpKw& h)

Pack/Unpack serialize operator|.

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