Class CommandLineArgumentParser

Testing/itkCommandLineArgumentParser.h:77–283

 */

class CommandLineArgumentParser : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(CommandLineArgumentParser);

  /** Standard class typedefs. */
  using Self = CommandLineArgumentParser;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  enum ReturnValue
  {
    PASSED,
    FAILED,
    HELPREQUESTED
  };

  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  /** Run-time type information (and related methods). */
  itkOverrideGetNameOfClassMacro(CommandLineArgumentParser);

  /** Set the command line arguments in a vector of strings. */
  void
  SetCommandLineArguments(int argc, char ** argv);

  /** Ensure that all required arguments have been passed. */
  ReturnValue
  CheckForRequiredArguments() const;

  /** Map to store the arguments and their indices. */
  using IndexType = std::size_t;
  using ArgumentMapType = std::map<std::string, IndexType>;
  using EntryType = ArgumentMapType::value_type;

  /** Copy argv in a map. */
  void
  CreateArgumentMap();

  /** Print all arguments. */
  void
  PrintAllArguments() const;

  /** Checks if an argument is given. */
  bool
  ArgumentExists(const std::string & key) const;

  /** Checks if exactly one of the specified arguments is given. */
  bool
  ExactlyOneExists(const std::vector<std::string> & keys) const;

  /** Mark an argument as required. */
  void
  MarkArgumentAsRequired(const std::string & argument, const std::string & helpText = "");

  /** Mark exactly one of the specified arguments as required. */