CLComm::BFCLException Class Reference

Exception thrown for CLAllSerial.h and BFSerial.h API errors. More...

#include <CLAllSerial.hpp>

Inheritance diagram for CLComm::BFCLException:

Public Member Functions
	BFCLException (void)
	BFCLException (const CLINT32 number)
	BFCLException (BFCLException const &to_copy)
	BFCLException (BFCLException &&to_take)
BFCLException &	operator= (BFCLException const &to_copy)
BFCLException &	operator= (BFCLException &&to_take)
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
virtual BFU32	showErrorMsg (void) const

Static Public Member Functions
static BFVOID	check (const CLINT32 errorCode)

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 for CLAllSerial.h and BFSerial.h API errors.

Possible CLAllSerial.h errors are:

• CL_ERR_NO_ERR
• CL_ERR_BUFFER_TOO_SMALL
• CL_ERR_MANU_DOES_NOT_EXIST
• CL_ERR_PORT_IN_USE
• CL_ERR_TIMEOUT
• CL_ERR_INVALID_INDEX
• CL_ERR_INVALID_REFERENCE
• CL_ERR_ERROR_NOT_FOUND
• CL_ERR_BAUD_RATE_NOT_SUPPORTED
• CL_ERR_OUT_OF_MEMORY
• CL_ERR_REGISTRY_KEY_NOT_FOUND
• CL_ERR_INVALID_PTR
• CL_ERR_UNABLE_TO_LOAD_DLL
• CL_ERR_FUNCTION_NOT_FOUND

Possible BFSerial.h errors are:

• BFCL_ERROR_SERNOTFOUND
• BFCL_ERROR_BRDNOTFOUND
• BFCL_ERROR_BRDOPEN
• BFCL_ERROR_THRE
• BFCL_ERROR_TEMT
• BFCL_ERROR_FIFO_EN
• BFCL_ERROR_RCVRFIFO
• BFCL_ERROR_BAUDRATE
• BFCL_ERROR_DATABITS
• BFCL_ERROR_PARITY
• BFCL_ERROR_15STOP5DATA
• BFCL_ERROR_2STOP5DATA
• BFCL_ERROR_STOPBITS
• BFCL_ERROR_NOSIGNAL
• BFCL_ERROR_NOSTRUC
• BFCL_ERROR_NULLPTR
• BFCL_ERROR_BYTES_AVAIL
• BFCL_ERROR_FLUSH_PORT
• BFCL_ERROR_DATA_IN

Constructor & Destructor Documentation

BFCLException::BFCLException

(

void

)

Referenced by check().

{ }

BFCLException::BFCLException

(

const CLINT32

number

)

Initialize a new BFCLException with the given error code and message.

Parameters

[in]

number

- The error code value for this BFCLException.

    : BFExceptionBase ((BFU32)number, CLAllSerial::getErrorText(number))
{ }

BFCLException::BFCLException

(

BFCLException const &

to_copy

)

Initialize a new BFCLException, copying the contents of the exception to_copy.

Parameters

[in]

to_copy

- The exception to be copied.

    : BFExceptionBase (to_copy)
{ }

BFCLException::BFCLException

(

BFCLException &&

to_take

)

Initialize a new BFCLException, taking the contents of the exception to_take.

Parameters

[in]

to_take

- The exception to be taken.

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

Member Function Documentation

BFVOID BFCLException::check ( const CLINT32  errorCode )

static

Throw a BFCLException, if errorCode isn't CL_ERR_NO_ERR.

Parameters

[in]

errorCode

- The error code value to check.

Exceptions

BFCLException

thrown, initialized to errorCode, if errorCode isn't CL_ERR_NO_ERR.

References BFCLException(), and CL_ERR_NO_ERR.

Referenced by CLComm::CLAllSerial::bfGetBaudRate(), CLComm::CLAllSerial::bfSerialCancelRead(), CLComm::CLAllSerial::bfSerialInit(), CLComm::CLAllSerial::bfSerialRead(), CLComm::CLAllSerial::bfSerialSettings(), CLComm::CLAllSerial::bfsVersion(), CLComm::CLAllSerial::bfSWConnectorSerialInit(), CLComm::CLAllSerial::flushPort(), CLComm::CLAllSerial::getErrorText(), CLComm::CLAllSerial::getNumBytesAvail(), CLComm::CLAllSerial::getNumPorts(), CLComm::CLAllSerial::getPortInfo(), CLComm::CLAllSerial::getSupportedBaudRates(), CLComm::CLAllSerial::serialInit(), CLComm::CLAllSerial::serialRead(), CLComm::CLAllSerial::serialWrite(), and CLComm::CLAllSerial::setBaudRate().

{
    if (CL_ERR_NO_ERR != errorCode)
        throw BFCLException(errorCode);
}

BFCLException & BFCLException::operator=

(

BFCLException 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;
}

BFCLException & BFCLException::operator=

(

BFCLException &&

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;
}

---

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

• CLAllSerial.hpp
• CLAllSerial.cpp