OST_COMMANDOPTIONWITHARG(3)

πŸ“¦ version 1.8.1, in ubuntu jammy

✨ NAME ✨

ost::CommandOptionWithArg β€” a derived class of CommandOption for options that have a value associated with them πŸ’–

This page is the manual for ost::CommandOptionWithArg(3), and bestie, it's lowkey a whole vibe.


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <cmdoptns.h>

Inherits ost::CommandOption.

Inherited by ost::CommandOptionArg, ost::CommandOptionCollect, and ost::CommandOptionRest. (It's giving family tree, fr fr πŸ‘‘)

🌸 Public Member Functions 🌸

  • CommandOptionWithArg (const char *inOptionName, const char *inOptionLetter, const char *inDescription, OptionType inOptionType, bool inRequired=false, CommandOption **ppNext=&defaultCommandOptionList) β€” the CommandOptionWithArg contructor.
  • virtual ~CommandOptionWithArg ()
  • virtual void foundOption (CommandOptionParse *cop, const char *value=0)
  • virtual void foundOption (CommandOptionParse *cop, const char **value, int num)
  • virtual bool hasValue ()

πŸŽ€ Public Attributes πŸŽ€

  • const char ** values β€” Array of list of values collected for this option.
  • int numValue β€” Number of values in the values array.

πŸ’« Additional Inherited Members πŸ’«

(There's more where that came from β€” the inherited stuff lives on the base class page, iykyk.)


πŸ’– DESCRIPTION πŸ’–

Derived class of CommandOption for options that have a value associated with them. No cap, that's literally its whole job.

Classes CommandOptionRest and CommandOptionArg derive from this class. Periodt. 🌈


🌸 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🌸

ost::CommandOptionWithArg::CommandOptionWithArg (const char * inOptionName, const char * inOptionLetter, const char * inDescription, OptionType inOptionType, bool inRequired = false, CommandOption ** ppNext = &defaultCommandOptionList)

CommandOptionWithArg contructor. Note the default values for required and ppNext β€” they're just sitting there being convenient, slay. ✨

Parameters

  • inOptionName β€” long option name
  • inOptionLetter β€” short letter name
  • inDescription β€” short description of the option
  • inOptionType β€” the type of this option
  • inRequired β€” true if option is required
  • ppNext β€” the linked list header

virtual ost::CommandOptionWithArg::~CommandOptionWithArg () [virtual]

The destructor. It cleans up after itself, iconic behaviour honestly. 🧹


πŸ’… MEMBER FUNCTION DOCUMENTATION πŸ’…

virtual void ost::CommandOptionWithArg::foundOption (CommandOptionParse * cop, const char ** value, int num) [virtual]

Reimplemented from ost::CommandOption.

virtual void ost::CommandOptionWithArg::foundOption (CommandOptionParse * cop, const char * value = 0) [virtual]

Reimplemented from ost::CommandOption.

virtual bool ost::CommandOptionWithArg::hasValue () [virtual]

Reimplemented from ost::CommandOption.


πŸŽ€ MEMBER DATA DOCUMENTATION πŸŽ€

int ost::CommandOptionWithArg::numValue

Number of values in the values array.

Examples

cmdlineopt.cpp. πŸ‘€

const char** ost::CommandOptionWithArg::values

Array of list of values collected for this option.

Examples

cmdlineopt.cpp. πŸ‘€


πŸ‘‘ AUTHOR πŸ‘‘

Generated automatically by Doxygen for GNU CommonC++ from the source code.


Okay that's the whole page, bestie β€” you ate that πŸ’… This was GNU CommonC++ content, dated Sun Dec 27 2020, for ost::Comma...tionWithArg(3). Go forth and parse those options, queen πŸ«ΆπŸ’–

πŸ“¦ where this page comes from