1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-16 10:08:36 +03:00
occt/src/OSD/OSD_Error.hxx
abv 42cf5bc1ca 0024002: Overall code and build procedure refactoring -- automatic
Automatic upgrade of OCCT code by command "occt_upgrade . -nocdl":
- WOK-generated header files from inc and sources from drv are moved to src
- CDL files removed
- All packages are converted to nocdlpack
2015-07-12 07:42:38 +03:00

92 lines
2.3 KiB
C++

// Created on: 1992-05-18
// Created by: Stephan GARNAUD (ARM)
// Copyright (c) 1992-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.
#ifndef _OSD_Error_HeaderFile
#define _OSD_Error_HeaderFile
#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>
#include <TCollection_AsciiString.hxx>
#include <Standard_Integer.hxx>
#include <OSD_WhoAmI.hxx>
#include <Standard_Boolean.hxx>
class OSD_OSDError;
class TCollection_AsciiString;
//! Accurate management of OSD specific errors.
class OSD_Error
{
public:
DEFINE_STANDARD_ALLOC
//! Initializes Error to be without any Error.
//! This is only used by OSD, not by programmer.
Standard_EXPORT OSD_Error();
//! Raises OSD_Error with accurate error message.
Standard_EXPORT void Perror();
//! Instantiates error
//! This is only used by OSD methods to instantiates an error code.
//! No description is done for the programmer.
Standard_EXPORT void SetValue (const Standard_Integer Errcode, const Standard_Integer From, const TCollection_AsciiString& Message);
//! Returns an accurate error code.
//! To test these values, you must include "OSD_ErrorList.hxx"
Standard_EXPORT Standard_Integer Error() const;
//! Returns TRUE if an error occurs
//! This is a way to test if a system call succeeded or not.
Standard_EXPORT Standard_Boolean Failed() const;
//! Resets error counter to zero
//! This allows the user to ignore an error (WARNING).
Standard_EXPORT void Reset();
protected:
private:
TCollection_AsciiString myMessage;
Standard_Integer myErrno;
OSD_WhoAmI myCode;
Standard_Integer extCode;
};
#endif // _OSD_Error_HeaderFile