Component balcl_occurrenceinfo [Package balcl]

Provide a type describing requirement and default value of option. More...

Namespaces
namespace	balcl

---

Detailed Description

Outline

• Purpose
• Classes
• Description
  • Attributes
  • Usage

Purpose:

Provide a type describing requirement and default value of option.

Classes:

balcl::OccurrenceInfo

specify option necessity and other attributes

See also:

Component balcl_commandline

Description:

This component provides a single complex-constrained (value-semantic) attribute class, balcl::OccurrenceInfo, that describes whether a command-line argument must be supplied by the user or whether that option is truly optional. If a command-line option is optional, it may have the additional attribute of being "hidden" -- i.e., omitted by the printUsage method of balcl::CommandLine (see {balcl_commandline}). Additionally, default values can be provided for non-required options.

For further details see balcl_commandline|Occurrence Information Field and balcl_commandline|Example: Occurrence Information Field.

Attributes:

  Attribute      Type               Default Constraints
  -------------- ------------------ ------- -------------------------------
  isHiddenFlag   bool               false   isHiddenFlag && !isRequiredFlag

  isRequiredFlag bool               false   none

  defaultValue   balcl::OptionValue e_VOID  e_VOID != type() &&
                                               (e_BOOL != type()
                                                false  == isNull()
                                                false  == isRequiredFlag)

Usage:

The intended use of this component is illustrated in balcl_commandline|Usage.