rtctk::componentFramework::BufferTooSmall Class Reference

The BufferTooSmall is thrown when an API call fails because the provided buffer is not big enough to hold the data. More...

#include <rtctk/componentFramework/exceptions.hpp>

Inheritance diagram for rtctk::componentFramework::BufferTooSmall:

Public Member Functions
	BufferTooSmall (const std::size_t actual, const std::size_t expected)
	Construct exception object.
	BufferTooSmall (const std::size_t actual, const std::size_t expected, const std::string &reason)
	Construct exception object.
std::size_t	GetActualBufferSize () const
std::size_t	GetExpectedBufferSize () const
Public Member Functions inherited from rtctk::componentFramework::RtctkException
	RtctkException () noexcept
	RtctkException (const std::string &msg)
	RtctkException (const RtctkException &other) noexcept
	~RtctkException () override=default

Protected Attributes
std::size_t	m_actual
std::size_t	m_expected

Detailed Description

The BufferTooSmall is thrown when an API call fails because the provided buffer is not big enough to hold the data.

Constructor & Destructor Documentation

BufferTooSmall() [1/2]

rtctk::componentFramework::BufferTooSmall::BufferTooSmall ( const std::size_t actual, const std::size_t expected )

explicit

Construct exception object.

Parameters

[in]	actual	The actual size of the buffer.
[in]	expected	The minimum required size of the buffer.

BufferTooSmall() [2/2]

rtctk::componentFramework::BufferTooSmall::BufferTooSmall ( const std::size_t actual, const std::size_t expected, const std::string & reason )

explicit

Construct exception object.

Parameters

[in]	actual	The actual size of the buffer.
[in]	expected	The minimum required size of the buffer.
[in]	reason	Additional explanatory message or helpful hint.

Member Function Documentation

GetActualBufferSize()

std::size_t rtctk::componentFramework::BufferTooSmall::GetActualBufferSize ( ) const

inline

GetExpectedBufferSize()

std::size_t rtctk::componentFramework::BufferTooSmall::GetExpectedBufferSize ( ) const

inline

Member Data Documentation

m_actual

std::size_t rtctk::componentFramework::BufferTooSmall::m_actual

protected

m_expected

std::size_t rtctk::componentFramework::BufferTooSmall::m_expected

protected

---

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

• componentFramework/services/common/src/include/rtctk/componentFramework/exceptions.hpp
• componentFramework/services/common/src/exceptions.cpp