BFExceptionBase Class Reference

Base class of all BitFlow exception classes. More...

#include <BFException.hpp>

Inheritance diagram for BFExceptionBase:

Classes
struct	PrivateData

Public Member Functions
	BFExceptionBase (void)
	BFExceptionBase (BFExceptionBase const &to_copy)
	BFExceptionBase (BFExceptionBase &&to_take)
virtual	~BFExceptionBase (void)
BFExceptionBase &	operator= (BFExceptionBase const &to_copy)
BFExceptionBase &	operator= (BFExceptionBase &&to_take)
virtual BFU32	getErrorText (PBFCHAR ErrorText, PBFU32 ErrorTextSize) const
virtual std::string	getErrorText (void) const
virtual BFU32	getErrorNumber (void) const
virtual BFU32	showErrorMsg (void) const

Protected Member Functions
	BFExceptionBase (const BFU32 number, std::string const &message)
	BFExceptionBase (const BFU32 number, std::string &&message)

Detailed Description

Base class of all BitFlow exception classes.

Examples:

BiSimplePlusPlus.cpp, CircClassExample.cpp, and CircHoldSimple.cpp.

Constructor & Destructor Documentation

BFExceptionBase::BFExceptionBase

(

void

)

Construct the BFExceptionBase instance with no error.

    : m_pd ( new PrivateData )
{ }

BFExceptionBase::BFExceptionBase

(

BFExceptionBase const &

to_copy

)

Construct a BFExceptionBase instance, copying the number and message from the exception to_copy.

Parameters

[in]

to_copy

- The exception to be copied.

    : m_pd ( new PrivateData(to_copy.m_pd->m_number, to_copy.m_pd->m_message) )
{ }

BFExceptionBase::BFExceptionBase

(

BFExceptionBase &&

to_take

)

Construct a BFExceptionBase instance, taking the data from the exception to_take.

Parameters

[in]

to_take

- The exception to be taken.

    : m_pd (to_take.m_pd)
{
    to_take.m_pd = nullptr;
}

BFExceptionBase::~BFExceptionBase ( void  )

virtual

Clean up this BFExceptionBase instance and its resources.

{
    delete m_pd;
}

BFExceptionBase::BFExceptionBase ( const BFU32  number, std::string const &  message  )

protected

Construct the BFExceptionBase instance with an error number and message.

Parameters

[in]	number	- The error code to for this BFExceptionBase.
[in]	message	- The error message for this BFExceptionBase.

    : m_pd ( new PrivateData(number, message) )
{ }

BFExceptionBase::BFExceptionBase ( const BFU32  number, std::string &&  message  )

protected

Construct the BFExceptionBase instance with an error number and message.

Parameters

[in]	number	- The error code to for this BFExceptionBase.
[in]	message	- The error message for this BFExceptionBase.

    : m_pd ( new PrivateData(number, std::move(message)) )
{ }

Member Function Documentation

BFU32 BFExceptionBase::getErrorNumber ( void  ) const

virtual

Returns the error number of the error that occured.

Referenced by showErrorMsg(), and BiException::showErrorMsg().

{
    return m_pd->m_number;
}

BFU32 BFExceptionBase::getErrorText ( PBFCHAR  errorText, PBFU32  errorBufferSize  ) const

virtual

Returns a string description of the error that occured.

Parameters

[out]	errorText	- The pointer to the users allocated buffer that will store the text error message.
[in,out]	errorBufferSize	- As an input, this parameter is the number of bytes that errorText buffer can hold. As an output, the paramerter is overwritten with the number of bytes written to the errorText buffer when successful or the number of bytes the buffer needs to be to hold the full message if the buffer is too small.

Returns

BI_OK if the method was successful, or on of the following on error:

• BI_ERROR_ERR_NOT_FOUND - If an error code could not be found.
• BI_ERROR_NULL_TEXT_PTR - If errotText is BFNULL.
• BI_ERROR_BUFFER_TOO_SMALL - If the text error message is larger than the user allocated buffer.

References BI_ERROR_BUFFER_TOO_SMALL, BI_ERROR_NULL_TEXT_PTR, and getErrorText().

{
    const std::string message = getErrorText();

    const size_t inputSize = *errorBufferSize;
    const size_t errTxtSize = message.size() + 1;

    *errorBufferSize = BFU32(errTxtSize);

    if (!errorText)
        return BI_ERROR_NULL_TEXT_PTR;

    if (inputSize)
    {
        std::memcpy(errorText, message.c_str(), std::min(inputSize, errTxtSize));
        errorText[inputSize - 1] = 0;
    }

    return inputSize < errTxtSize ? BI_ERROR_BUFFER_TOO_SMALL : BF_OK;
}

std::string BFExceptionBase::getErrorText ( void  ) const

virtual

Return the error text as a std::string. Throws a BFException on any error.

Referenced by getErrorText(), and showErrorMsg().

{
    return m_pd->m_message;
}

BFExceptionBase & BFExceptionBase::operator=

(

BFExceptionBase const &

to_copy

)

Replace the data stored in this exception with copies of the data from the exception to_copy.

Parameters

[in]

to_copy

- The exception to be copied.

Returns

A reference to this exception.

Referenced by BFCiException::operator=(), BiException::operator=(), and CLComm::BFCLException::operator=().

{
    if (this != &to_copy)
    {
        m_pd->m_number = to_copy.m_pd->m_number;
        m_pd->m_message = to_copy.m_pd->m_message;
    }
    return *this;
}

BFExceptionBase & BFExceptionBase::operator=

(

BFExceptionBase &&

to_take

)

Replace the data stored in this exception data taken from the exception to_take.

Parameters

[in]

to_take

- The exception to be taken.

Returns

A reference to this exception.

{
    if (this != &to_take)
    {
        delete m_pd;
        m_pd = to_take.m_pd;
        to_take.m_pd = nullptr;
    }
    return *this;
}

BFU32 BFExceptionBase::showErrorMsg ( void  ) const

virtual

Pops up a dialog displaying a text description of the error that was thrown.

Returns

Returns one of the following:

• BI_OK - The user clicked on the ok button on the dialog.
• BI_CANCEL - The user clicked on the cancel button on the dialog.

Reimplemented in BiException.

Examples:

BiSimplePlusPlus.cpp, CircClassExample.cpp, and CircHoldSimple.cpp.

References BI_CANCEL, BI_OK, getErrorNumber(), and getErrorText().

{
    const BFU32 errorNumber = getErrorNumber();

    std::ostringstream txtStrm;
    txtStrm << "BitFlow Error " << errorNumber << ": " << getErrorText();

    UINT mType = MB_OKCANCEL|(BF_OK == errorNumber ? MB_ICONEXCLAMATION : MB_ICONERROR);
    const int uButton = MessageBoxA(NULL, txtStrm.str().c_str(), "Frame Grabber Error", mType);
    
    if (IDOK == uButton)
        return BI_OK;
    
    return BI_CANCEL;
}

---

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

• BFException.hpp
• BFException.cpp