Futilities/human/lib/caOptsBase: Difference between revisions

From Woozle Writes Code
< Futilities‎ | human‎ | lib
Jump to navigation Jump to search
(Created page with "{{fmt/title|Human Futilities: <code>caOptsBase</code> class}} ==About== This class-family handles parsing of command-line options. Descendant classes will describe (in natural...")
 
No edit summary
 
Line 2: Line 2:
==About==
==About==
This class-family handles parsing of command-line options. Descendant classes will describe (in natural language) the operations which have been specified, via the {{l/sub|DescribeSelf}}() method.
This class-family handles parsing of command-line options. Descendant classes will describe (in natural language) the operations which have been specified, via the {{l/sub|DescribeSelf}}() method.
==Arrays==
* '''App Options''' are the options that the application will recognize in a command
** Array Format: [{{arg|code name}} => [array of CLI strings which indicate that option]]
* '''Cmd Options''' are the options actually specified in the current command
** Array Format: [{{arg|key}} => {{arg|{{l/hf/class|cOptMain}} object}}]
*** The {{arg|key}} is set from {{l/hf/class|cOptMain}}->GetKey().

Latest revision as of 14:20, 20 October 2022

Human Futilities: caOptsBase class

About

This class-family handles parsing of command-line options. Descendant classes will describe (in natural language) the operations which have been specified, via the DescribeSelf() method.

Arrays

  • App Options are the options that the application will recognize in a command
    • Array Format: [<code name> => [array of CLI strings which indicate that option]]
  • Cmd Options are the options actually specified in the current command
    • Array Format: [<key> => <cOptMain object>]
      • The <key> is set from cOptMain->GetKey().