iRoCS Toolbox  1.1.0
Public Member Functions | Protected Attributes
CmdLineError Class Reference

The CmdLineError class is the parent class of all exceptions used in libCmdLine. More...

#include <CmdLineError.hh>

Inheritance diagram for CmdLineError:
Collaboration diagram for CmdLineError:

Public Member Functions

 CmdLineError ()
 Constructor. More...
 
 CmdLineError (const CmdLineError &copy)
 Copy constructor. More...
 
virtual ~CmdLineError ()
 Destructor. More...
 
template<typename T >
CmdLineErroroperator<< (const T &data)
 Add something to the error message. More...
 
const std::string str () const
 Return error message. More...
 

Protected Attributes

std::string pMessage
 

Detailed Description

The CmdLineError class is the parent class of all exceptions used in libCmdLine.

The CmdLineError class is the parent class of all exceptions used in libCmdLine. It has functions to access the error message.

Definition at line 70 of file CmdLineError.hh.

Constructor & Destructor Documentation

◆ CmdLineError() [1/2]

CmdLineError::CmdLineError ( )

Constructor.

◆ CmdLineError() [2/2]

CmdLineError::CmdLineError ( const CmdLineError copy)

Copy constructor.

Parameters
copyCmdLineError to copy

◆ ~CmdLineError()

virtual CmdLineError::~CmdLineError ( )
virtual

Destructor.

Member Function Documentation

◆ operator<<()

template<typename T >
CmdLineError& CmdLineError::operator<< ( const T &  data)
inline

Add something to the error message.

Parameters
data
Returns
modified CmdLineError

Definition at line 106 of file CmdLineError.hh.

◆ str()

const std::string CmdLineError::str ( ) const
inline

Return error message.

Returns
error message

Definition at line 122 of file CmdLineError.hh.

Field Documentation

◆ pMessage

std::string CmdLineError::pMessage
protected

Definition at line 128 of file CmdLineError.hh.

Referenced by operator<<(), and str().


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