FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoException Class Reference

#include <Exception.h>

Inherits FdoIDisposable.

Inherited by FdoClientServiceException, FdoCommandException, FdoConnectionException, FdoExpressionException, FdoFilterException, FdoSchemaException, FdoSpatialContextMismatchException, and FdoXmlException.

Inheritance diagram for FdoException:

[legend]
List of all members.

Detailed Description

FdoException is a root class for the exception type thrown from classes. It derives from a language level exception class that is environment specific.

Definition at line 40 of file Exception.h.


Public Member Functions

virtual FDO_API_COMMON FdoException * GetCause ()
 Gets a reference to the exception that caused this exception.
virtual FDO_API_COMMON FdoString * GetExceptionMessage ()
 Gets the message associated with this exception. If no message is associated with this exception but it has a cause, then this method returns the message specified for the cause exception. If no message and no cause are associated with this exception then a null reference is returned.
virtual FDO_API_COMMON FdoException * GetRootCause ()
 Gets a reference to the exception that is the root cause of this exception.
virtual FDO_API_COMMON void SetCause (FdoException *cause)
 Sets the cause exception.
virtual FDO_API_COMMON FdoString * ToString ()
 Gets the message associated with this exception. If no message is associated with this exception but it has a cause, then this method returns the message specified for the cause exception. If no message and no cause are associated with this exception then a null reference is returned.

Static Public Member Functions

FDO_API_COMMON FdoException * Create (FdoString *message, FdoException *cause)
 Returns an instance of a FdoException using the specified arguments.
FDO_API_COMMON FdoException * Create (FdoString *message)
 Returns an instance of a FdoException using the specified arguments.
FDO_API_COMMON FdoException * Create ()
 Returns a default instance of a FdoException.
FDO_API_COMMON FdoString * NLSGetMessage (FdoInt32 msgNum, char *defMsg, char *catalog, va_list arguments)
 Gets the exception message. For internal use by FdoException class in getting a localized message.
FDO_API_COMMON FdoString * NLSGetMessage (FdoInt32 msgNum, char *defMsg,...)
 Gets the exception message. For internal use by template classes in getting a localized message.
FDO_API_COMMON FdoString * NLSGetMessage (FdoInt32 msgNum, char *defMsg, char *file, int line, char *catalog, va_list arguments)
 Gets the exception message. For internal use by FdoException class in getting a localized message.
FDO_API_COMMON FdoString * NLSGetMessage (FdoInt32 msgNum, char *defMsg, char *file, int line,...)
 Gets the exception message. For internal use by template classes in getting a localized message.

Protected Member Functions

virtual void Dispose ()
 DOXYGEN-IGNORE
FDO_API_COMMON FdoException (FdoString *message, FdoException *cause)
 Constructs an instance of a FdoException using the specified arguments.
FDO_API_COMMON FdoException (FdoString *message)
 Constructs an instance of a FdoException using the specified arguments.
FDO_API_COMMON FdoException ()
 Constructs a default instance of a FdoException.
virtual FDO_API_COMMON ~FdoException ()
 Default destructor for FdoException class.

Protected Attributes

FdoException * m_cause
wchar_t * m_message
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

FDO_API_COMMON FdoException::FdoException (   )  [protected]
 

Constructs a default instance of a FdoException.

FDO_API_COMMON FdoException::FdoException (  FdoString *  message  )  [protected]
 

Constructs an instance of a FdoException using the specified arguments.

FDO_API_COMMON FdoException::FdoException (  FdoString *  message,
FdoException *  cause
)  [protected]
 

Constructs an instance of a FdoException using the specified arguments.

virtual FDO_API_COMMON FdoException::~FdoException (   )  [protected, virtual]
 

Default destructor for FdoException class.

Member Function Documentation

FDO_API_COMMON FdoException* FdoException::Create (  FdoString *  message,
FdoException *  cause
)  [static]
 

Returns an instance of a FdoException using the specified arguments.

Parameters:
message Input the error message
cause Input the cause of the error
Returns:
Returns the FdoException object

Reimplemented in FdoXmlException, FdoCommandException, FdoSpatialContextMismatchException, FdoConnectionException, FdoExpressionException, FdoFilterException, FdoAutogenerationException, and FdoSchemaException.

FDO_API_COMMON FdoException* FdoException::Create (  FdoString *  message  )  [static]
 

Returns an instance of a FdoException using the specified arguments.

Parameters:
message Input the error message
Returns:
Returns the FdoException object

Reimplemented in FdoXmlException, FdoCommandException, FdoSpatialContextMismatchException, FdoConnectionException, FdoExpressionException, FdoFilterException, FdoAutogenerationException, and FdoSchemaException.

FDO_API_COMMON FdoException* FdoException::Create (   )  [static]
 

Returns a default instance of a FdoException.

Returns:
Returns the FdoException object

Reimplemented in FdoXmlException, FdoClientServiceException, FdoCommandException, FdoSpatialContextMismatchException, FdoConnectionException, FdoExpressionException, FdoFilterException, FdoAutogenerationException, and FdoSchemaException.

Referenced by FdoRingCollection::Create(), FdoPolygonCollection::Create(), FdoPointCollection::Create(), FdoLineStringCollection::Create(), FdoLinearRingCollection::Create(), FdoGeometryCollection::Create(), FdoDirectPositionCollection::Create(), FdoCurveStringCollection::Create(), FdoCurveSegmentCollection::Create(), FdoCurvePolygonCollection::Create(), FdoPtr< FdoIoTextReader >::FdoPtr(), FdoIoObjectStreamReader< FdoByte >::GetIndex(), FdoCollection< ElementMap, FdoException >::GetItem(), FdoArray< T >::GetValue(), FdoPtr< FdoIoTextReader >::operator *(), FdoPtr< FdoIoTextReader >::operator->(), FdoIoObjectStreamReader< FdoByte >::ReadNext(), FdoIDisposable::Release(), FdoArray< FdoByte >::Release(), and FdoArray< T >::SetValue().

virtual void FdoException::Dispose (   )  [protected, virtual]
 

DOXYGEN-IGNORE

Implements FdoIDisposable.

Reimplemented in FdoXmlException, FdoClientServiceException, FdoCommandException, FdoSpatialContextMismatchException, FdoConnectionException, FdoExpressionException, FdoFilterException, FdoAutogenerationException, and FdoSchemaException.

virtual FDO_API_COMMON FdoException* FdoException::GetCause (   )  [virtual]
 

Gets a reference to the exception that caused this exception.

Returns:
Returns the cause of the error

virtual FDO_API_COMMON FdoString* FdoException::GetExceptionMessage (   )  [virtual]
 

Gets the message associated with this exception. If no message is associated with this exception but it has a cause, then this method returns the message specified for the cause exception. If no message and no cause are associated with this exception then a null reference is returned.

Returns:
Returns the error message

virtual FDO_API_COMMON FdoException* FdoException::GetRootCause (   )  [virtual]
 

Gets a reference to the exception that is the root cause of this exception.

Returns:
Returns the root cause for the error

FDO_API_COMMON FdoString* FdoException::NLSGetMessage (  FdoInt32  msgNum,
char *  defMsg,
char *  catalog,
va_list  arguments
)  [static]
 

Gets the exception message. For internal use by FdoException class in getting a localized message.

Parameters:
msgNum Input the error message number
defMsg Input a text error message to use if the message number is not found
catalog Input the NLS message catalog name.
arguments Input the variable argument parameters from previous call.
Returns:
Returns the localized message text

FDO_API_COMMON FdoString* FdoException::NLSGetMessage (  FdoInt32  msgNum,
char *  defMsg,
  ...
)  [static]
 

Gets the exception message. For internal use by template classes in getting a localized message.

Remarks:
In addition to the listed parameters, a flexible number of additional variables, as required, can be used as input to format the exception message.
Parameters:
msgNum Input the error message number
defMsg Input a text error message to use if the message number is not found
Returns:
Returns the localized message text

FDO_API_COMMON FdoString* FdoException::NLSGetMessage (  FdoInt32  msgNum,
char *  defMsg,
char *  file,
int  line,
char *  catalog,
va_list  arguments
)  [static]
 

Gets the exception message. For internal use by FdoException class in getting a localized message.

Parameters:
msgNum Input the error message number
defMsg Input a text error message to use if the message number is not found
file Input file name where exception occurred
line Input the line number where exception occurred
catalog Input the NLS message catalog name.
arguments Input the variable argument parameters from previous call.
Returns:
Returns the localized message text

FDO_API_COMMON FdoString* FdoException::NLSGetMessage (  FdoInt32  msgNum,
char *  defMsg,
char *  file,
int  line,
  ...
)  [static]
 

Gets the exception message. For internal use by template classes in getting a localized message.

Remarks:
In addition to the listed parameters, a flexible number of additional variables, as required, can be used as input to format the exception message.
Parameters:
msgNum Input the error message number
defMsg Input a text error message to use if the message number is not found
file Input file name where exception occurred
line Input the line number where exception occurred
Returns:
Returns the localized message text

virtual FDO_API_COMMON void FdoException::SetCause (  FdoException *  cause  )  [virtual]
 

Sets the cause exception.

Parameters:
cause Input the cause of the error
Returns:
Returns nothing

virtual FDO_API_COMMON FdoString* FdoException::ToString (   )  [virtual]
 

Gets the message associated with this exception. If no message is associated with this exception but it has a cause, then this method returns the message specified for the cause exception. If no message and no cause are associated with this exception then a null reference is returned.

Returns:
Returns the error message

Reimplemented in FdoClientServiceException.

Member Data Documentation

FdoException* FdoException::m_cause [protected]
 

Definition at line 223 of file Exception.h.

wchar_t* FdoException::m_message [protected]
 

DOXYGEN-IGNORE

Definition at line 222 of file Exception.h.

The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.