Error_WithMessage.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2022 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef _ODERROR_WITHMESSAGE_INCLUDED
#define _ODERROR_WITHMESSAGE_INCLUDED
 
#include "OdaCommon.h"
#include "OdResult.h"
#include "OdError.h"
 
//creates error with specified code and custom message
FIRSTDLL_EXPORT OdError OdErrorByCodeAndMessage(OdResult iResCode, const char *iMessage);
 
//creates error with specified code and custom message
//the message may include formatted parameters
FIRSTDLL_EXPORT OdError OdErrorByCodeAndMessageFormat(OdResult iResCode, const char *iMessageFormat, ...);
 
 
 
#define OD_CHECK_THROW(CONDITION, RESULT_CODE, MESSAGE) \
  if (CONDITION) {} \
  else throw OdErrorByCodeAndMessage(RESULT_CODE, MESSAGE);
 
#define OD_CHECK_THROW_F(CONDITION, RESULT_CODE, ...) \
  if (CONDITION) {} \
  else throw OdErrorByCodeAndMessageFormat(RESULT_CODE, __VA_ARGS__);
 
 
//shortcuts for commonly encountered error codes:
 
#define OD_CHECKIN_THROW(CONDITION, MESSAGE) OD_CHECK_THROW  (CONDITION, eInvalidInput, MESSAGE)
#define OD_CHECKIN_THROW_F(CONDITION, ...)   OD_CHECK_THROW_F(CONDITION, eInvalidInput, __VA_ARGS__)
#define OD_CHECKGMF_THROW(CONDITION, MESSAGE) OD_CHECK_THROW  (CONDITION, eGeneralModelingFailure, MESSAGE)
#define OD_CHECKGMF_THROW_F(CONDITION, ...)   OD_CHECK_THROW_F(CONDITION, eGeneralModelingFailure, __VA_ARGS__)
 
#endif