eprosima::fastcdr::exception::BadOptionalAccessException Class Reference

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.

#include <BadOptionalAccessException.hpp>

Inheritance diagram for eprosima::fastcdr::exception::BadOptionalAccessException:

Public Member Functions
Cdr_DllAPI	BadOptionalAccessException (const char *const &message) noexcept
	Default constructor.
Cdr_DllAPI	BadOptionalAccessException (const BadOptionalAccessException &ex) noexcept
	Default copy constructor.
Cdr_DllAPI	BadOptionalAccessException (BadOptionalAccessException &&ex) noexcept
	Default move constructor.
Cdr_DllAPI BadOptionalAccessException &	operator= (const BadOptionalAccessException &ex) noexcept
	Assigment operation.
BadOptionalAccessException &	operator= (BadOptionalAccessException &&ex) noexcept
	Assigment operation.
virtual Cdr_DllAPI	~BadOptionalAccessException () noexcept
	Default destructor.
Cdr_DllAPI void	raise () const override
	This function throws the object as exception.
virtual Cdr_DllAPI const char *	what () const noexcept override
	This function returns the error message.
T	what (T... args)

Static Public Attributes
static Cdr_DllAPI const char *const	BAD_OPTIONAL_ACCESS_MESSAGE_DEFAULT
	Default message used in the library.

Private Attributes
const char *	m_message

Constructor & Destructor Documentation

BadOptionalAccessException() [1/3]

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

noexcept

Default constructor.

Parameters

message

An 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

ex	BadOptionalAccessException that will be copied.

Definition at line 28 of file BadOptionalAccessException.cpp.

BadOptionalAccessException() [3/3]

BadOptionalAccessException::BadOptionalAccessException ( BadOptionalAccessException &&  ex )

noexcept

Default move constructor.

Parameters

ex	BadOptionalAccessException 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

ex	BadOptionalAccessException 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

ex	BadOptionalAccessException 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.

what()

const char * Exception::what ( ) const

overridevirtualnoexceptinherited

This function returns the error message.

Returns

The error message.

Definition at line 55 of file Exception.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.

m_message

const char* eprosima::fastcdr::exception::Exception::m_message

privateinherited

Definition at line 90 of file Exception.h.

---

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

• BadOptionalAccessException.hpp
• BadOptionalAccessException.cpp