ML Reference
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ml::PersistenceStreamException Class Reference

This class represents the exceptions that can be thrown while reading from or writing to the persistence stream. More...

#include <mlAbstractPersistenceStream.h>

Inheritance diagram for ml::PersistenceStreamException:
ml::PersistenceStreamFormatException ml::PersistenceStreamIOException ml::PersistenceStreamInternalError

Public Types

enum  ErrorType { IOError , FormatError , InternalError }
 Subtypes of this exception. More...
 

Public Member Functions

virtual ~PersistenceStreamException ()
 
ErrorType getErrorType () const
 Returns exception subtype.
 
virtual std::string getMessage () const
 Returns error message.
 

Protected Member Functions

 PersistenceStreamException (ErrorType type, const std::string &msg)
 This is set to protected, because you should not create instances of the base class.
 

Protected Attributes

ErrorType _type
 
std::string _msg
 

Detailed Description

This class represents the exceptions that can be thrown while reading from or writing to the persistence stream.

Definition at line 389 of file mlAbstractPersistenceStream.h.

Member Enumeration Documentation

◆ ErrorType

enum ml::PersistenceStreamException::ErrorType

Subtypes of this exception.

Enumerator
IOError 
FormatError 
InternalError 

Definition at line 393 of file mlAbstractPersistenceStream.h.

Constructor & Destructor Documentation

◆ ~PersistenceStreamException()

virtual ml::PersistenceStreamException::~PersistenceStreamException ( )
inlinevirtual

Definition at line 399 of file mlAbstractPersistenceStream.h.

◆ PersistenceStreamException()

ml::PersistenceStreamException::PersistenceStreamException ( ErrorType type,
const std::string & msg )
inlineprotected

This is set to protected, because you should not create instances of the base class.

Definition at line 409 of file mlAbstractPersistenceStream.h.

Member Function Documentation

◆ getErrorType()

ErrorType ml::PersistenceStreamException::getErrorType ( ) const
inline

Returns exception subtype.

Definition at line 402 of file mlAbstractPersistenceStream.h.

◆ getMessage()

virtual std::string ml::PersistenceStreamException::getMessage ( ) const
inlinevirtual

Returns error message.

Definition at line 405 of file mlAbstractPersistenceStream.h.

Member Data Documentation

◆ _msg

std::string ml::PersistenceStreamException::_msg
protected

Definition at line 412 of file mlAbstractPersistenceStream.h.

◆ _type

ErrorType ml::PersistenceStreamException::_type
protected

Definition at line 411 of file mlAbstractPersistenceStream.h.

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