Apama  10.2.0.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
com::apama::EngineException Class Reference

An EngineException is thrown by methods in this library if any problems are encountered. More...

#include <engine_client_cpp.hpp>

Inheritance diagram for com::apama::EngineException:

Public Member Functions

 EngineException (const char *message)
 Construct an EngineException from a message. More...
 
 EngineException (const EngineException &ce)
 Copy constructor for EngineException. More...
 
EngineExceptionoperator= (const EngineException &ce)
 Copy assignment operator. More...
 
virtual ~EngineException () throw ()
 Destructor. More...
 
virtual const char * what () const throw ()
 Retrieve the message enclosed within the exception. More...
 
virtual const char *const * getWarnings () const
 Retrieve the set of warnings associated with the exception. More...
 

Detailed Description

An EngineException is thrown by methods in this library if any problems are encountered.

Constructor & Destructor Documentation

com::apama::EngineException::EngineException ( const char *  message)

Construct an EngineException from a message.

com::apama::EngineException::EngineException ( const EngineException ce)

Copy constructor for EngineException.

virtual com::apama::EngineException::~EngineException ( )
throw (
)
virtual

Destructor.

Member Function Documentation

virtual const char* const* com::apama::EngineException::getWarnings ( ) const
inlinevirtual

Retrieve the set of warnings associated with the exception.

Returns
A pointer to a NULL terminated list of warnings, possibly NULL if there are none. This list is owned by the exception object. It should not be deleted.
EngineException& com::apama::EngineException::operator= ( const EngineException ce)
inline

Copy assignment operator.

virtual const char* com::apama::EngineException::what ( ) const
throw (
)
inlinevirtual

Retrieve the message enclosed within the exception.

Returns
C style string with details of the error that caused the operation to fail.

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