[occt.git] / src / GC / GC_Root.hxx

// Created on: 1992-09-29
// Created by: Remi GILET
// 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 _GC_Root_HeaderFile
#define _GC_Root_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>

#include <gce_ErrorType.hxx>
#include <Standard_Boolean.hxx>

// resolve name collisions with X11 headers
#ifdef Status
  #undef Status
#endif

//! This class implements the common services for
//! all classes of gce which report error.
class GC_Root 
{
public:

  DEFINE_STANDARD_ALLOC

  
  //! Returns true if the construction is successful.
    Standard_Boolean IsDone() const;
  

  //! Returns the status of the construction:
  //! -   gce_Done, if the construction is successful, or
  //! -   another value of the gce_ErrorType enumeration
  //! indicating why the construction failed.
    gce_ErrorType Status() const;


protected:


  gce_ErrorType TheError;


private:


};


#include <GC_Root.lxx>


#endif // _GC_Root_HeaderFile
Commit	Line	Data
42cf5bc1	1	// Created on: 1992-09-29
	2	// Created by: Remi GILET
	3	// Copyright (c) 1992-1999 Matra Datavision
	4	// Copyright (c) 1999-2014 OPEN CASCADE SAS
	5	//
	6	// This file is part of Open CASCADE Technology software library.
	7	//
	8	// This library is free software; you can redistribute it and/or modify it under
	9	// the terms of the GNU Lesser General Public License version 2.1 as published
	10	// by the Free Software Foundation, with special exception defined in the file
	11	// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	12	// distribution for complete text of the license and disclaimer of any warranty.
	13	//
	14	// Alternatively, this file may be used under the terms of Open CASCADE
	15	// commercial license or contractual agreement.
	16
	17	#ifndef _GC_Root_HeaderFile
	18	#define _GC_Root_HeaderFile
	19
	20	#include <Standard.hxx>
	21	#include <Standard_DefineAlloc.hxx>
	22	#include <Standard_Handle.hxx>
	23
	24	#include <gce_ErrorType.hxx>
	25	#include <Standard_Boolean.hxx>
	26
9fd2d2c3	27	// resolve name collisions with X11 headers
	28	#ifdef Status
	29	#undef Status
	30	#endif
42cf5bc1	31
	32	//! This class implements the common services for
	33	//! all classes of gce which report error.
	34	class GC_Root
	35	{
	36	public:
	37
	38	DEFINE_STANDARD_ALLOC
	39
	40
	41	//! Returns true if the construction is successful.
	42	Standard_Boolean IsDone() const;
	43
	44
	45	//! Returns the status of the construction:
	46	//! - gce_Done, if the construction is successful, or
	47	//! - another value of the gce_ErrorType enumeration
	48	//! indicating why the construction failed.
	49	gce_ErrorType Status() const;
	50
	51
	52
	53
	54	protected:
	55
	56
	57
	58	gce_ErrorType TheError;
	59
	60
	61	private:
	62
	63
	64
	65
	66
	67	};
	68
	69
	70	#include <GC_Root.lxx>
	71
	72
	73
	74
	75
	76	#endif // _GC_Root_HeaderFile