include/opencascade/IGESSelect.hxx

0001 // Created on: 1994-05-31
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1994-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IGESSelect_HeaderFile
0018 #define _IGESSelect_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Integer.hxx>
0025 class IGESData_IGESEntity;
0026 class Interface_Graph;
0027
0028 //! This package defines the library of the most used tools for
0029 //! IGES Files : Selections & Modifiers specific to the IGES norm,
0030 //! and the most needed converters
0031 class IGESSelect
0032 {
0033 public:
0034   DEFINE_STANDARD_ALLOC
0035
0036   //! Simply gives a prompt for a conversational action on standard
0037   //! input/output. Returns the status of a
0038   Standard_EXPORT static void Run();
0039
0040   //! Gives a quick analysis of an IGES Entity in the context of a
0041   //! model (i.e. a File) described by a Graph.
0042   //! Returned values are :
0043   //! <sup> : the most meaningful super entity, if any (else Null)
0044   //! <index> : meaningful index relating to super entity, if any
0045   //! <returned> : a status which helps exploitation of <sup>, by
0046   //! giving a case
0047   //! (normally, types of <ent> and <sup> should suffice to
0048   //! known the case)
0049   Standard_EXPORT static int WhatIges(const occ::handle<IGESData_IGESEntity>& ent,
0050                                       const Interface_Graph&                  G,
0051                                       occ::handle<IGESData_IGESEntity>&       sup,
0052                                       int&                                    index);
0053 };
0054
0055 #endif // _IGESSelect_HeaderFile