Ice 3.7 C++11 API Reference
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Ice::FileException Class Reference

This exception indicates file errors. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::FileException:
Inheritance graph
[legend]
Collaboration diagram for Ice::FileException:
Collaboration graph
[legend]

Public Member Functions

 FileException (const char *file, int line)
 The file and line number are required for all local exceptions. More...
 
 FileException (const char *file, int line, int error, const ::std::string &path)
 One-shot constructor to initialize all data members. More...
 
 FileException (const FileException &)=default
 
virtual void ice_print (::std::ostream &stream) const override
 Prints this exception to the given stream. More...
 
std::tuple< const int &, const ::std::string & > ice_tuple () const
 Obtains a tuple containing all of the exception's data members. More...
 
virtual ~FileException ()
 
- Public Member Functions inherited from Ice::LocalExceptionHelper< FileException, SyscallException >
virtual std::string ice_id () const override
 
- Public Member Functions inherited from IceUtil::ExceptionHelper< FileException, SyscallException >
std::unique_ptr< FileException > ice_clone () const
 
virtual void ice_throw () const override
 Throws this exception. More...
 
- Public Member Functions inherited from IceUtil::SyscallException
int error () const
 Provides the error number returned by the system call. More...
 
virtual std::string ice_id () const
 Returns the type ID of this exception. More...
 
virtual void ice_print (std::ostream &) const
 Outputs a description of this exception to a stream. More...
 
 SyscallException (const char *, int, int)
 
virtual ~SyscallException () throw ()
 
- Public Member Functions inherited from IceUtil::ExceptionHelper< SyscallException >
std::unique_ptr< SyscallExceptionice_clone () const
 
- Public Member Functions inherited from IceUtil::Exception
 Exception ()
 Constructs the exception. More...
 
 Exception (const char *file, int line)
 Constructs the exception. More...
 
std::unique_ptr< Exceptionice_clone () const
 Returns a shallow polymorphic copy of this exception. More...
 
const char * ice_file () const
 Returns the name of the file where this exception was constructed. More...
 
int ice_line () const
 Returns the line number where this exception was constructed. More...
 
std::string ice_stackTrace () const
 Returns the stack trace at the point this exception was constructed. More...
 
virtual void ice_throw () const =0
 Throws this exception. More...
 
virtual const char * what () const throw ()
 Returns a description of this exception. More...
 
virtual ~Exception ()=0 throw ()
 

Static Public Member Functions

static const ::std::string & ice_staticId ()
 Obtains the Slice type ID of this exception. More...
 

Public Attributes

::std::string path
 The path of the file responsible for the error. More...
 

Detailed Description

This exception indicates file errors.

Constructor & Destructor Documentation

◆ ~FileException()

virtual Ice::FileException::~FileException ( )
virtual

◆ FileException() [1/3]

Ice::FileException::FileException ( const FileException )
default

◆ FileException() [2/3]

Ice::FileException::FileException ( const char *  file,
int  line 
)
inline

The file and line number are required for all local exceptions.

Parameters
fileThe file name in which the exception was raised, typically __FILE__.
lineThe line number at which the exception was raised, typically __LINE__.

◆ FileException() [3/3]

Ice::FileException::FileException ( const char *  file,
int  line,
int  error,
const ::std::string &  path 
)
inline

One-shot constructor to initialize all data members.

The file and line number are required for all local exceptions.

Parameters
fileThe file name in which the exception was raised, typically __FILE__.
lineThe line number at which the exception was raised, typically __LINE__.
errorThe error number describing the system exception.
pathThe path of the file responsible for the error.

Member Function Documentation

◆ ice_print()

virtual void Ice::FileException::ice_print ( ::std::ostream &  stream) const
overridevirtual

Prints this exception to the given stream.

Parameters
streamThe target stream.

◆ ice_staticId()

static const ::std::string& Ice::FileException::ice_staticId ( )
static

Obtains the Slice type ID of this exception.

Returns
The fully-scoped type ID.

◆ ice_tuple()

std::tuple<const int&, const ::std::string&> Ice::FileException::ice_tuple ( ) const
inline

Obtains a tuple containing all of the exception's data members.

Returns
The data members in a tuple.

Member Data Documentation

◆ path

::std::string Ice::FileException::path

The path of the file responsible for the error.


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