cmdArgException.h

Go to the documentation of this file.

/****************************************************************************** 
 * 
 *  file:  ArgException.h
 * 
 *  Copyright (c) 2003, Michael E. Smoot .
 *  All rights reverved.
 * 
 *  See the file COPYING in the top directory of this distribution for
 *  more information.
 *  
 *  THE SOFTWARE IS PROVIDED _AS IS_, WITHOUT WARRANTY OF ANY KIND, EXPRESS 
 *  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
 *  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 *  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
 *  DEALINGS IN THE SOFTWARE.  
 *  
 *****************************************************************************/ 


#ifndef DtCmdLine_ARG_EXCEPTION_H
#define DtCmdLine_ARG_EXCEPTION_H
 

#include <string>
#include <exception>

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

namespace DtCmdLine {

   class ArgException : public std::exception
   {
   public:

      ArgException( const std::string& text = "undefined exception", 
                    const std::string& id = "undefined",
                    const std::string& td = "Generic ArgException")
         : std::exception(), 
         _errorText(text), 
         _argId( id ), 
         _typeDescription(td)
      { } 

      virtual ~ArgException() throw() 
      { }

      std::string error() const 
      { return ( _errorText ); }

      std::string argId() const  
      { 
         if ( _argId == "undefined" )
            return " ";
         else
            return ( "Argument: " + _argId ); 
      }

      const char* what() const throw() 
      {
         std::string ex = _argId + " -- " + _errorText;
         return ex.c_str();
      }

      std::string typeDescription() const
      {
         return _typeDescription; 
      }


   private:

      std::string _errorText;

      std::string _argId;

      std::string _typeDescription;

   };

   class ArgParseException : public ArgException
   { 
   public:
      ArgParseException( const std::string& text = "undefined exception", 
                         const std::string& id = "undefined" )
         : ArgException( text, 
                         id, 
                         std::string( "Exception found while parsing " ) + 
                         std::string( "the value the Arg has been passed." ))
      { }
   };

   class CmdLineParseException : public ArgException
   {
   public:
      CmdLineParseException( const std::string& text = "undefined exception", 
                             const std::string& id = "undefined" )
         : ArgException( text, 
                         id,
                         std::string( "Exception found when the values ") +
                         std::string( "on the command line do not meet ") +
                         std::string( "the requirements of the defined ") +
                         std::string( "Args." ))
         { }
   };

   class SpecificationException : public ArgException
   {
   public:
      SpecificationException( const std::string& text = "undefined exception",
                              const std::string& id = "undefined" )
         : ArgException( text, 
                         id,
                         std::string("Exception found when an Arg object ")+
                         std::string("is improperly defined by the ") +
                         std::string("developer." )) 
         { }

   };

} 

#ifdef DtUSE_UTILITIES_NAMESPACE
}     
#endif

#endif