OpenTop C++ class: CommandLineException

Overview

Namespace

Class

Glossary

Index

OpenTop Portal

OpenTop 1.5

PREV EXCEPTION NEXT EXCEPTION

FRAMES NO FRAMES

Cross-Platform C++

SUMMARY: CONSTRUCTOR | METHOD

DETAIL: CONSTRUCTOR | METHOD

ot::auxil
class CommandLineException

#include "ot/auxil/CommandLineException.h"

Thrown by the CommandLineParser during the parsing of a command line. Typically an object of this class wil be thrown to indicate that an illegal or ill-specified command line option has been provided.

Constructor/Destructor Summary
`CommandLineException(const String& option, const String& message)`

Method Summary
`virtual String`	`getExceptionType() const` Returns the class name as a String.
`virtual String`	`getOption() const` Returns the option which caused this exception to be thrown.

Methods inherited from class ot::Exception

getDescription(), getLocalizedDescription(), getMessage(), setMessage(const String&), toString()

Constructor/Destructor Detail

CommandLineException

 CommandLineException(const String& option,
                      const String& message)

Method Detail

getExceptionType

virtual String getExceptionType() const

Returns the class name as a String. This method should be overridden in all derived classes to return the name of the derived class.

See also:: getDescription()

getOption

virtual String getOption() const

Returns the option which caused this exception to be thrown.

Returns:: the option as it appeared on the command line.