BiException Class Reference

Exception thrown when a BitFlow SDK error occurs. More...

#include <BFException.hpp>

Inheritance diagram for BiException:

Public Member Functions
	BiException (void)
	BiException (Bd hBoard, const BFU32 error)
	BiException (BiException const &to_copy)
	BiException (BiException &&to_take)
BiException &	operator= (BiException const &to_copy)
BiException &	operator= (BiException &&to_take)
virtual BFU32	showErrorMsg (void) const
Public Member Functions inherited from BFExceptionBase
	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

Static Public Member Functions
static void	check (Bd hBoard, const BFU32 error)
static std::string	getErrorText (Bd hBoard, const BFU32 error)

Additional Inherited Members
Protected Member Functions inherited from BFExceptionBase
	BFExceptionBase (const BFU32 number, std::string const &message)
	BFExceptionBase (const BFU32 number, std::string &&message)

Detailed Description

Exception thrown when a BitFlow SDK error occurs.

Note

This is based upon the BiApi error stack, not the BF/CiApi error stack.

See also

BIRC_Enum

Constructor & Destructor Documentation

BiException::BiException

(

void

)

Referenced by check().

BiException::BiException	(	Bd	hBoard,
		const BFU32	error
	)

Initialize a BiException with the given error code and message.

Parameters

[in]	hBoard	- The board which generated the error.
[in]	error	- The error code value to check.

    : BFExceptionBase (error, getErrorText(hBoard, error))
{ }

BiException::BiException

(

BiException const &

to_copy

)

Initialize a BiException as a copy of another BiException.

Parameters

[in]

to_copy

- The exception to copy.

    : BFExceptionBase (to_copy)
{ }

BiException::BiException

(

BiException &&

to_take

)

Initialize a BiException, taking the contents of another BiException.

Parameters

[in]

to_take

- The exception to copy.

    : BFExceptionBase ( std::move(to_take) )
{ }

Member Function Documentation

void BiException::check ( Bd  hBoard, const BFU32  error  )

static

Throw a BFException, if error isn't BF_OK.

Parameters

[in]	hBoard	- The board which generated the error.
[in]	error	- The error code value to check.

Exceptions

BiException

thrown, initialized to error, if error isn't BF_OK.

References BiException().

Referenced by CLComm::CLAllSerial::bfSerialInit(), CLComm::CLAllSerial::bfSWConnectorSerialInit(), BufferAcquisition::BufferInterface::boardCount(), BFGTLUtilities::Device::boardCount(), BufferAcquisition::CircularInterface::cirControl(), BufferAcquisition::CircularInterface::cirErrorWait(), BufferAcquisition::CircularInterface::cleanup(), BufferAcquisition::SequenceInterface::cleanup(), BufferAcquisition::SequenceInterface::clearBufferInfo(), BufferAcquisition::BufferInterface::clearBuffers(), BufferAcquisition::BufferInterface::enumerateCameraModes(), BufferAcquisition::BufferInterface::getAbortAcqFlag(), BufferAcquisition::BufferInterface::getBrdInfo(), BufferAcquisition::BufferInterface::getBufferArrayPointers(), BufferAcquisition::SequenceInterface::getBufferInfo(), BufferAcquisition::BufferInterface::getBufferQueueSize(), BufferAcquisition::CircularInterface::getBufferStatus(), BufferAcquisition::CircularInterface::getCirError(), BufferAcquisition::BufferInterface::getCleanupAcqFlag(), BufferAcquisition::SequenceInterface::getCurFrameAcquired(), BufferAcquisition::BufferInterface::getErrorText(), BufferAcquisition::BufferInterface::getMajorVersion(), BufferAcquisition::BufferInterface::getMinorVersion(), BufferAcquisition::BufferInterface::getNumFramesCaptured(), BufferAcquisition::BufferInterface::getNumFramesMissed(), BufferAcquisition::BufferInterface::getPauseAcqFlag(), BufferAcquisition::SequenceInterface::getSeqError(), BufferAcquisition::BufferInterface::getStartAcqFlag(), BufferAcquisition::BufferInterface::getStopAcqFlag(), BufferAcquisition::BufferInterface::getTriggerMode(), BufferAcquisition::BufferInterface::getTriggerPolarity(), BufferAcquisition::BufferInterface::Properties::interface_type(), BufferAcquisition::BufferInterface::issueSoftwareTrigger(), BufferAcquisition::BufferInterface::loadCamFile(), CXPReg::Device::open(), BufferAcquisition::BufferInterface::open(), BFGTLUtilities::Device::open(), CXPReg::Device::openSWConnector(), BufferAcquisition::BufferInterface::openSWConnector(), BFGTLUtilities::Device::openSWConnector(), BufferAcquisition::BufferInterface::readSeqFile(), BufferAcquisition::SequenceInterface::seqControl(), BufferAcquisition::SequenceInterface::seqErrorWait(), BufferAcquisition::SequenceInterface::seqWaitDone(), BufferAcquisition::CircularInterface::setBufferStatus(), BufferAcquisition::BufferInterface::setCameraMode(), BufferAcquisition::SequenceInterface::setSettings(), BufferAcquisition::BufferInterface::setTimeout(), BufferAcquisition::BufferInterface::setTriggerMode(), BufferAcquisition::SequenceInterface::setup(), BufferAcquisition::CircularInterface::setup(), BufferAcquisition::BufferInterface::showError(), BufferAcquisition::CircularInterface::waitDoneFrame(), BufferAcquisition::SequenceInterface::waitDoneFrame(), BufferAcquisition::BufferInterface::writeBuffer(), and BufferAcquisition::BufferInterface::writeSeqBuffer().

{
    if (BF_OK == error)
        return;

    throw BiException(hBoard, error);
}

std::string BiException::getErrorText ( Bd  hBoard, const BFU32  error  )

static

Return the error text associated with the given error code.

Parameters

[in]	hBoard	- The board which generated the error.
[in]	error	- The error code value to check.

References BI_ERROR_BUFFER_TOO_SMALL, and MAX_STRING.

{
    std::vector<char> errTxt (MAX_STRING);
    BFU32 errTxtSize = (BFU32)errTxt.size();

    BFRC rc = BiErrorTextGet(hBoard, error, errTxt.data(), &errTxtSize);
    if (BI_ERROR_BUFFER_TOO_SMALL == rc)
    {
        errTxt.resize(++errTxtSize);
        rc = BiErrorTextGet(hBoard, error, errTxt.data(), &errTxtSize);
    }

    if (BF_OK != rc)
        return "Bi error code message unavailable.";

    errTxt.push_back(0);
    return errTxt.data();
}

BiException & BiException::operator=

(

BiException const &

to_copy

)

Copy the contents of the exception to_copy.

Parameters

[in]

to_copy

- The exception to be copied.

Returns

Returns a reference to this exception.

References BFExceptionBase::operator=().

{
    BFExceptionBase::operator=(to_copy);
    return *this;
}

BiException & BiException::operator=

(

BiException &&

to_take

)

Take the contents of the exception to_take.

Parameters

[in]

to_take

- The exception to be taken.

Returns

Returns a reference to this exception.

References BFExceptionBase::operator=().

{
    BFExceptionBase::operator=( std::move(to_take) );
    return *this;
}

BFU32 BiException::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 from BFExceptionBase.

References BFExceptionBase::getErrorNumber().

{
    return BiErrorShow(0, getErrorNumber());
}

---

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

• BFException.hpp
• BFException.cpp