cmtk::CommandLine::Key Class Reference

Command line key: short and long option. More...

#include <cmtkCommandLine.h>

Collaboration diagram for cmtk::CommandLine::Key:

List of all members.

Public Member Functions
	Key (const std::string &keyString)
	Long option constructor.
	Key (const char keyChar, const std::string &keyString)
	Short and long option constructor.
Public Attributes
char	m_KeyChar
	Short option key.
std::string	m_KeyString
	Long option key.

---

Detailed Description

Command line key: short and long option.

A key is the character (short options) or string (long options) that is associated with a given action. When the key appears on the command line, the action is executed.

The following are examples of Key initializers:

 Key( 'v', "verbose" );
 Key( "number-of-iterations" );
 Key( 'q' );

Definition at line 248 of file cmtkCommandLine.h.

---

Constructor & Destructor Documentation

cmtk::CommandLine::Key::Key

(

const std::string &

keyString )

[inline, explicit]

Long option constructor.

Definition at line 252 of file cmtkCommandLine.h.

cmtk::CommandLine::Key::Key	(	const char	keyChar,
		const std::string &	keyString
	)		[inline, explicit]

Short and long option constructor.

Definition at line 255 of file cmtkCommandLine.h.

---

Member Data Documentation

char cmtk::CommandLine::Key::m_KeyChar

Short option key.

Definition at line 258 of file cmtkCommandLine.h.

std::string cmtk::CommandLine::Key::m_KeyString

Long option key.

Definition at line 261 of file cmtkCommandLine.h.

---

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

• libs/System/cmtkCommandLine.h