Assignments Assignments

Public Member Functions | Public Attributes | List of all members
Util::CmdLineReadable Class Reference

`#include <cmdLineParser.h>`

Inheritance diagram for Util::CmdLineReadable:

## Public Member Functions
| CmdLineReadable (const std::string &name)
virtual | ~CmdLineReadable (void)
virtual int | read (char **argv, int argc)

## Public Attributes
bool | set
std::string | name

## Detailed Description

This class represents a named argument that can be read from the command line

## Constructor & Destructor Documentation

## ◆ CmdLineReadable()

Util::CmdLineReadable::CmdLineReadable | ( | const std::string & | name | ) |
| inline

Constructor with the name of the argument

## ◆ ~CmdLineReadable()

Util::CmdLineReadable::~CmdLineReadable | ( | void |  | ) |
| inline virtual

Destructor

## Member Function Documentation

## ◆ read()

int Util::CmdLineReadable::read | ( | char ** | argv,
|  | int | argc )
| inline virtual

Try to set the argument from the list of command line arguments. Returns thenumber of arguments ingested.

Reimplemented in Util::CmdLineParameter< Type >, Util::CmdLineParameterArray< Type, Dim >, and Util::CmdLineParameters< Type >.

## Member Data Documentation

## ◆ name

std::string Util::CmdLineReadable::name

The argument's name

## ◆ set

bool Util::CmdLineReadable::set

Has the argument been set

The documentation for this class was generated from the following files:

- Assignments/Util/cmdLineParser.h
- Assignments/Util/cmdLineParser.inl