Convenience structure to hold the key=value/type/usage/help-string information. More...

Public Attributes
const char *const	help
	Help string. More...

const char *const	key
	keyword (name used on commad line) More...

const char *const	type
	Name of the type of the value. More...

const char *const	usageValue
	Usage value shown on the usage line. More...

const char *const	val
	default value for keyword More...

Detailed Description

Convenience structure to hold the key=value/type/usage/help-string information.

Note: This structure also is implicitly used by scripts/keys which compiles @key comment lines into C++ code. See scripts/keys.cc

Definition at line 62 of file Program.h.

Member Data Documentation

const char* const carma::util::KeyTabEntry::help

Help string.

Used to provide detailed information on options

Definition at line 85 of file Program.h.

const char* const carma::util::KeyTabEntry::key

keyword (name used on commad line)

Definition at line 64 of file Program.h.

const char* const carma::util::KeyTabEntry::type

Name of the type of the value.

Should be "bool", "double", "int", or "string". "b", "d", "i" or "s" are also accepted for those who hate typing;)

Definition at line 75 of file Program.h.

const char* const carma::util::KeyTabEntry::usageValue

Usage value shown on the usage line.

Magic value "@autogen" has special meaning here.

Definition at line 80 of file Program.h.

const char* const carma::util::KeyTabEntry::val

default value for keyword

Magic values "@mandatory" and "@noDefault" have special meaning here.

Definition at line 69 of file Program.h.

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