84 lines
4.2 KiB
C++
84 lines
4.2 KiB
C++
/*=============================================================================
|
|
Copyright (C) 2014 - 2016 Allied Vision Technologies. All Rights Reserved.
|
|
|
|
Redistribution of this file, in original or modified form, without
|
|
prior written consent of Allied Vision Technologies is prohibited.
|
|
|
|
-------------------------------------------------------------------------------
|
|
|
|
File: ErrorCodeToMessage.h
|
|
|
|
Description: Convert the error codes to a self-explanatory message.
|
|
|
|
-------------------------------------------------------------------------------
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
|
|
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF TITLE,
|
|
NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
|
|
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
|
AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
|
|
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
=============================================================================*/
|
|
|
|
#ifndef ERROR_CODE_TO_MESSAGE_H_
|
|
#define ERROR_CODE_TO_MESSAGE_H_
|
|
|
|
#include <string>
|
|
|
|
#include "VimbaCPP/Include/VimbaCPP.h"
|
|
|
|
#ifdef UNICODE
|
|
typedef std::wstring string_type;
|
|
#define MAKE_STRING_LITERAL_(s) L ## s
|
|
#else
|
|
typedef std::string string_type;
|
|
#define MAKE_STRING_LITERAL_(s) s
|
|
#endif
|
|
#define MAKE_STRING_LITERAL(s) MAKE_STRING_LITERAL_(s)
|
|
|
|
namespace AVT {
|
|
namespace VmbAPI {
|
|
namespace Examples {
|
|
|
|
//
|
|
// Translates Vimba error codes to readable error messages
|
|
//
|
|
// Parameters:
|
|
// [in] eError The error code to be converted to string
|
|
//
|
|
// Returns:
|
|
// A descriptive string representation of the error code
|
|
//
|
|
inline string_type ErrorCodeToMessage( VmbError_t eError )
|
|
{
|
|
switch( eError )
|
|
{
|
|
case VmbErrorSuccess: return string_type( MAKE_STRING_LITERAL( "Success." ) );
|
|
case VmbErrorInternalFault: return string_type( MAKE_STRING_LITERAL( "Unexpected fault in VmbApi or driver." ) );
|
|
case VmbErrorApiNotStarted: return string_type( MAKE_STRING_LITERAL( "API not started." ) );
|
|
case VmbErrorNotFound: return string_type( MAKE_STRING_LITERAL( "Not found." ) );
|
|
case VmbErrorBadHandle: return string_type( MAKE_STRING_LITERAL( "Invalid handle " ) );
|
|
case VmbErrorDeviceNotOpen: return string_type( MAKE_STRING_LITERAL( "Device not open." ) );
|
|
case VmbErrorInvalidAccess: return string_type( MAKE_STRING_LITERAL( "Invalid access." ) );
|
|
case VmbErrorBadParameter: return string_type( MAKE_STRING_LITERAL( "Bad parameter." ) );
|
|
case VmbErrorStructSize: return string_type( MAKE_STRING_LITERAL( "Wrong DLL version." ) );
|
|
case VmbErrorMoreData: return string_type( MAKE_STRING_LITERAL( "More data returned than memory provided." ) );
|
|
case VmbErrorWrongType: return string_type( MAKE_STRING_LITERAL( "Wrong type." ) );
|
|
case VmbErrorInvalidValue: return string_type( MAKE_STRING_LITERAL( "Invalid value." ) );
|
|
case VmbErrorTimeout: return string_type( MAKE_STRING_LITERAL( "Timeout." ) );
|
|
case VmbErrorOther: return string_type( MAKE_STRING_LITERAL( "TL error." ) );
|
|
case VmbErrorResources: return string_type( MAKE_STRING_LITERAL( "Resource not available." ) );
|
|
case VmbErrorInvalidCall: return string_type( MAKE_STRING_LITERAL( "Invalid call." ) );
|
|
case VmbErrorNoTL: return string_type( MAKE_STRING_LITERAL( "TL not loaded." ) );
|
|
case VmbErrorNotImplemented: return string_type( MAKE_STRING_LITERAL( "Not implemented." ) );
|
|
case VmbErrorNotSupported: return string_type( MAKE_STRING_LITERAL( "Not supported." ) );
|
|
default: return string_type( MAKE_STRING_LITERAL( "Unknown" ) );
|
|
}
|
|
}
|
|
}}} // AVT::VmbAPI::Examples
|
|
#endif |