Classes | Macros | Functions
Exception Classes

Detailed Description

These classes are the exceptions that can be thrown in the library code. Use these in your catch() blocks and you'll be able to get more information than what std::exception provides. Use GNSSTK_THROW() and GNSSTK_RETHROW() to throw or rethrow these exceptions to automatically add line and file information to your exceptions.

Classes

class  gnsstk::Exception
 

Macros

#define GNSSTK_RETHROW(exc)   { exc.addLocation(FILE_LOCATION); throw; }
 
#define GNSSTK_THROW(exc)   { exc.addLocation(FILE_LOCATION); throw exc; }
 
#define NEW_EXCEPTION_CLASS(child, parent)
 

Functions

 gnsstk::NEW_EXCEPTION_CLASS (AccessError, Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (AssertionFailure, Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (ConfigurationException, Exception)
 
 gnsstk::BinUtils::NEW_EXCEPTION_CLASS (CRCException, Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (FileMissingException, Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (FileSpecException, gnsstk::Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (GeometryException, gnsstk::Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (IndexOutOfBoundsException, Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (InvalidArgumentException, Exception)
 
 gnsstk::IonoModel::NEW_EXCEPTION_CLASS (InvalidIonoModel, gnsstk::Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (InvalidParameter, Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (InvalidRequest, Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (InvalidTropModel, gnsstk::Exception)
 
 gnsstk::IonoModelStore::NEW_EXCEPTION_CLASS (NoIonoModelFound, gnsstk::Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (NullPointerException, Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (ObjectNotFound, AccessError)
 
 gnsstk::NEW_EXCEPTION_CLASS (OutOfMemory, Exception)
 
 gnsstk::StringUtils::NEW_EXCEPTION_CLASS (StringException, Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (SVNotPresentException, gnsstk::InvalidRequest)
 
 gnsstk::NEW_EXCEPTION_CLASS (SystemPipeException, Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (SystemQueueException, Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (SystemSemaphoreException, Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (UnimplementedException, Exception)
 
 gnsstk::NEW_EXCEPTION_CLASS (VectorException, gnsstk::Exception)
 

Macro Definition Documentation

◆ GNSSTK_RETHROW

#define GNSSTK_RETHROW (   exc)    { exc.addLocation(FILE_LOCATION); throw; }

A macro for adding location when rethrowing an gnsstk::Exception

Definition at line 369 of file Exception.hpp.

◆ GNSSTK_THROW

#define GNSSTK_THROW (   exc)    { exc.addLocation(FILE_LOCATION); throw exc; }

A macro for adding location when throwing an gnsstk::Exception

Definition at line 366 of file Exception.hpp.

◆ NEW_EXCEPTION_CLASS

#define NEW_EXCEPTION_CLASS (   child,
  parent 
)

A macro for quickly defining a new exception class that inherits from an gnsstk::Exception derived class. Use this to make specific exceptions, such as the ones defined in this header file. Make sure that all exceptions have "\@ingroup exceptiongroup" in their comment block so doxygen knows what to do with them.

Definition at line 388 of file Exception.hpp.

Function Documentation

◆ NEW_EXCEPTION_CLASS() [1/24]

gnsstk::NEW_EXCEPTION_CLASS ( AccessError  ,
Exception   
)

Thrown if a function makes a request of the OS that can't be satisfied.

◆ NEW_EXCEPTION_CLASS() [2/24]

gnsstk::NEW_EXCEPTION_CLASS ( AssertionFailure  ,
Exception   
)

Thrown when a required condition in a function is not met.

◆ NEW_EXCEPTION_CLASS() [3/24]

gnsstk::NEW_EXCEPTION_CLASS ( ConfigurationException  ,
Exception   
)

Application's configuration is invalid

◆ NEW_EXCEPTION_CLASS() [4/24]

gnsstk::BinUtils::NEW_EXCEPTION_CLASS ( CRCException  ,
Exception   
)

This is thrown when there is an error processing a CRC

◆ NEW_EXCEPTION_CLASS() [5/24]

gnsstk::NEW_EXCEPTION_CLASS ( FileMissingException  ,
Exception   
)

Attempted to open a file that doesn't exist

◆ NEW_EXCEPTION_CLASS() [6/24]

gnsstk::NEW_EXCEPTION_CLASS ( FileSpecException  ,
gnsstk::Exception   
)

This exception is thrown when there is a problem with handling file specifications.

◆ NEW_EXCEPTION_CLASS() [7/24]

gnsstk::NEW_EXCEPTION_CLASS ( GeometryException  ,
gnsstk::Exception   
)
Todo:
determine if this file should be moved into GNSSCore

Thrown when a gnsstk::Triple operation can't be completed.

◆ NEW_EXCEPTION_CLASS() [8/24]

gnsstk::NEW_EXCEPTION_CLASS ( IndexOutOfBoundsException  ,
Exception   
)

Attempts to access an "array" or other element that doesn't exist

◆ NEW_EXCEPTION_CLASS() [9/24]

gnsstk::NEW_EXCEPTION_CLASS ( InvalidArgumentException  ,
Exception   
)

A function was passed an invalid argument

◆ NEW_EXCEPTION_CLASS() [10/24]

gnsstk::IonoModel::NEW_EXCEPTION_CLASS ( InvalidIonoModel  ,
gnsstk::Exception   
)

Exception, thrown when attempting to use a model for which not all the necessary parameters have been specified.

◆ NEW_EXCEPTION_CLASS() [11/24]

gnsstk::NEW_EXCEPTION_CLASS ( InvalidParameter  ,
Exception   
)

Thrown when a function is given a parameter value that it invalid

◆ NEW_EXCEPTION_CLASS() [12/24]

gnsstk::NEW_EXCEPTION_CLASS ( InvalidRequest  ,
Exception   
)

Thrown if a function can not satisfy a request

◆ NEW_EXCEPTION_CLASS() [13/24]

gnsstk::NEW_EXCEPTION_CLASS ( InvalidTropModel  ,
gnsstk::Exception   
)

Thrown when attempting to use a model for which all necessary parameters have not been specified.

◆ NEW_EXCEPTION_CLASS() [14/24]

gnsstk::IonoModelStore::NEW_EXCEPTION_CLASS ( NoIonoModelFound  ,
gnsstk::Exception   
)

Thrown when attempting to get a model that isn't stored.

◆ NEW_EXCEPTION_CLASS() [15/24]

gnsstk::NEW_EXCEPTION_CLASS ( NullPointerException  ,
Exception   
)

Attempted to access a null pointer

◆ NEW_EXCEPTION_CLASS() [16/24]

gnsstk::NEW_EXCEPTION_CLASS ( ObjectNotFound  ,
AccessError   
)

Operation failed because it was unable to locate the requested obj

◆ NEW_EXCEPTION_CLASS() [17/24]

gnsstk::NEW_EXCEPTION_CLASS ( OutOfMemory  ,
Exception   
)

Unable to allocate memory

◆ NEW_EXCEPTION_CLASS() [18/24]

gnsstk::StringUtils::NEW_EXCEPTION_CLASS ( StringException  ,
Exception   
)

This is thrown instread of a std::exception when a gnsstk::StringUtils function fails.

◆ NEW_EXCEPTION_CLASS() [19/24]

gnsstk::NEW_EXCEPTION_CLASS ( SVNotPresentException  ,
gnsstk::InvalidRequest   
)

Exception - requested almanac page that wasn't present.

◆ NEW_EXCEPTION_CLASS() [20/24]

gnsstk::NEW_EXCEPTION_CLASS ( SystemPipeException  ,
Exception   
)

A problem using a system pipe

◆ NEW_EXCEPTION_CLASS() [21/24]

gnsstk::NEW_EXCEPTION_CLASS ( SystemQueueException  ,
Exception   
)

A problem using a system queue

◆ NEW_EXCEPTION_CLASS() [22/24]

gnsstk::NEW_EXCEPTION_CLASS ( SystemSemaphoreException  ,
Exception   
)

A problem using a system semaphore

◆ NEW_EXCEPTION_CLASS() [23/24]

gnsstk::NEW_EXCEPTION_CLASS ( UnimplementedException  ,
Exception   
)

Attempted to access a unimplemented function

◆ NEW_EXCEPTION_CLASS() [24/24]

gnsstk::NEW_EXCEPTION_CLASS ( VectorException  ,
gnsstk::Exception   
)

An exception thrown when there's a problem with a vector



gnsstk
Author(s):
autogenerated on Wed Oct 25 2023 02:40:43