Public Member Functions | Static Public Attributes | List of all members
eprosima::fastcdr::exception::BadOptionalAccessException Class Reference

This class is thrown as an exception when accessing the value of a null optional. More...

#include <BadOptionalAccessException.hpp>

Inheritance diagram for eprosima::fastcdr::exception::BadOptionalAccessException:
Inheritance graph
[legend]

Public Member Functions

Cdr_DllAPI BadOptionalAccessException (BadOptionalAccessException &&ex) noexcept
 Default move constructor. More...
 
Cdr_DllAPI BadOptionalAccessException (const BadOptionalAccessException &ex) noexcept
 Default copy constructor. More...
 
Cdr_DllAPI BadOptionalAccessException (const char *const &message) noexcept
 Default constructor. More...
 
BadOptionalAccessExceptionoperator= (BadOptionalAccessException &&ex) noexcept
 Assigment operation. More...
 
Cdr_DllAPI BadOptionalAccessExceptionoperator= (const BadOptionalAccessException &ex) noexcept
 Assigment operation. More...
 
Cdr_DllAPI void raise () const override
 This function throws the object as exception. More...
 
virtual Cdr_DllAPI ~BadOptionalAccessException () noexcept
 Default destructor. More...
 
- Public Member Functions inherited from eprosima::fastcdr::exception::Exception
virtual const Cdr_DllAPI char * what () const noexcept override
 This function returns the error message. More...
 
virtual Cdr_DllAPI ~Exception () noexcept
 Default destructor. More...
 

Static Public Attributes

static const Cdr_DllAPI char *const BAD_OPTIONAL_ACCESS_MESSAGE_DEFAULT
 Default message used in the library. More...
 

Additional Inherited Members

- Protected Member Functions inherited from eprosima::fastcdr::exception::Exception
Cdr_DllAPI Exception (const char *const &message) noexcept
 Default constructor. More...
 
Cdr_DllAPI Exception (const Exception &ex) noexcept
 Default copy constructor. More...
 
Cdr_DllAPI Exception (Exception &&ex) noexcept
 Default move constructor. More...
 
Cdr_DllAPI Exceptionoperator= (const Exception &ex) noexcept
 Assigment operation. More...
 
Cdr_DllAPI Exceptionoperator= (Exception &&ex) noexcept
 Assigment operation. More...
 

Detailed Description

This class is thrown as an exception when accessing the value of a null optional.

Definition at line 27 of file BadOptionalAccessException.hpp.

Constructor & Destructor Documentation

◆ BadOptionalAccessException() [1/3]

BadOptionalAccessException::BadOptionalAccessException ( const char *const &  message)
noexcept

Default constructor.

Parameters
messageAn error message. This message pointer is copied.

Definition at line 22 of file BadOptionalAccessException.cpp.

◆ BadOptionalAccessException() [2/3]

BadOptionalAccessException::BadOptionalAccessException ( const BadOptionalAccessException ex)
noexcept

Default copy constructor.

Parameters
exBadOptionalAccessException that will be copied.

Definition at line 28 of file BadOptionalAccessException.cpp.

◆ BadOptionalAccessException() [3/3]

BadOptionalAccessException::BadOptionalAccessException ( BadOptionalAccessException &&  ex)
noexcept

Default move constructor.

Parameters
exBadOptionalAccessException that will be moved.

Definition at line 34 of file BadOptionalAccessException.cpp.

◆ ~BadOptionalAccessException()

BadOptionalAccessException::~BadOptionalAccessException ( )
virtualnoexcept

Default destructor.

Definition at line 64 of file BadOptionalAccessException.cpp.

Member Function Documentation

◆ operator=() [1/2]

BadOptionalAccessException & BadOptionalAccessException::operator= ( BadOptionalAccessException &&  ex)
noexcept

Assigment operation.

Parameters
exBadOptionalAccessException that will be moved.

Definition at line 52 of file BadOptionalAccessException.cpp.

◆ operator=() [2/2]

BadOptionalAccessException & BadOptionalAccessException::operator= ( const BadOptionalAccessException ex)
noexcept

Assigment operation.

Parameters
exBadOptionalAccessException that will be copied.

Definition at line 40 of file BadOptionalAccessException.cpp.

◆ raise()

void BadOptionalAccessException::raise ( ) const
overridevirtual

This function throws the object as exception.

Implements eprosima::fastcdr::exception::Exception.

Definition at line 68 of file BadOptionalAccessException.cpp.

Member Data Documentation

◆ BAD_OPTIONAL_ACCESS_MESSAGE_DEFAULT

const char *const BadOptionalAccessException::BAD_OPTIONAL_ACCESS_MESSAGE_DEFAULT
static
Initial value:
=
"Bad optional access: value not set"

Default message used in the library.

Definition at line 78 of file BadOptionalAccessException.hpp.


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


plotjuggler
Author(s): Davide Faconti
autogenerated on Mon Nov 11 2024 03:23:52