src/Interface/Interface_Category.hxx

   1 // Created on: 1995-11-08
   2 // Created by: Christian CAILLET
   3 // Copyright (c) 1995-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 _Interface_Category_HeaderFile
  18 #define _Interface_Category_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <TColStd_HArray1OfInteger.hxx>
  25 #include <Standard_Integer.hxx>
  26
  27 #include <Interface_GTool.hxx>
  28 class Interface_Protocol;
  29 class Standard_Transient;
  30 class Interface_ShareTool;
  31 class Interface_InterfaceModel;
  32
  33 //! This class manages categories
  34 //! A category is defined by a name and a number, and can be
  35 //! seen as a way of rough classification, i.e. less precise than
  36 //! a cdl type.
  37 //! Hence, it is possible to dispatch every entity in about
  38 //! a dozen of categories, twenty is a reasonable maximum.
  39 //!
  40 //! Basically, the system provides the following categories :
  41 //! Shape (Geometry, BRep, CSG, Features, etc...)
  42 //! Drawing (Drawing, Views, Annotations, Pictures, Sketches ...)
  43 //! Structure (Component & Part, Groups & Patterns ...)
  44 //! Description (Meta-Data : Relations, Properties, Product ...)
  45 //! Auxiliary   (those which do not enter in the above list)
  46 //! and some dedicated categories
  47 //! FEA , Kinematics , Piping , etc...
  48 //! plus Professional  for other dedicated non-classed categories
  49 //!
  50 //! In addition, this class provides a way to compute then quickly
  51 //! query category numbers for an entire model.
  52 //! Values are just recorded as a list of numbers, control must
  53 //! then be done in a wider context (which must provide a Graph)
  54 class Interface_Category
  55 {
  56  public:
  57
  58   DEFINE_STANDARD_ALLOC
  59
  60   //! Creates a Category, with no protocol yet
  61   Interface_Category()
  62   : myGTool(new Interface_GTool)
  63   { Init(); }
  64
  65   //! Creates a Category with a given protocol
  66   Interface_Category(const Handle(Interface_Protocol)& theProtocol)
  67   : myGTool(new Interface_GTool(theProtocol))
  68   { Init(); }
  69
  70   //! Creates a Category with a given GTool
  71   Interface_Category(const Handle(Interface_GTool)& theGTool)
  72   : myGTool(theGTool)
  73   { Init(); }
  74
  75   //! Sets/Changes Protocol
  76   void SetProtocol (const Handle(Interface_Protocol)& theProtocol)
  77   { myGTool->SetProtocol(theProtocol); }
  78
  79   //! Determines the Category Number for an entity in its context,
  80   //! by using general service CategoryNumber
  81   Standard_EXPORT Standard_Integer CatNum (const Handle(Standard_Transient)& theEnt, const Interface_ShareTool& theShares);
  82
  83   //! Clears the recorded list of category numbers for a Model
  84   void ClearNums()
  85   { myNum.Nullify(); }
  86
  87   //! Computes the Category Number for each entity and records it,
  88   //! in an array (ent.number -> category number)
  89   //! Hence, it can be queried by the method Num.
  90   //! The Model itself is not recorded, this method is intended to
  91   //! be used in a wider context (which detains also a Graph, etc)
  92   Standard_EXPORT void Compute (const Handle(Interface_InterfaceModel)& theModel, const Interface_ShareTool& theShares);
  93
  94   //! Returns the category number recorded for an entity number
  95   //! Returns 0 if out of range
  96   Standard_EXPORT Standard_Integer Num (const Standard_Integer theNumEnt) const;
  97
  98   //! Records a new Category defined by its names, produces a number
  99   //! New if not yet recorded
 100   Standard_EXPORT static Standard_Integer AddCategory (const Standard_CString theName);
 101
 102   //! Returns the count of recorded categories
 103   Standard_EXPORT static Standard_Integer NbCategories();
 104
 105   //! Returns the name of a category, according to its number
 106   Standard_EXPORT static Standard_CString Name (const Standard_Integer theNum);
 107
 108   //! Returns the number of a category, according to its name
 109   Standard_EXPORT static Standard_Integer Number (const Standard_CString theName);
 110
 111   //! Default initialisation
 112   //! (protected against several calls : passes only once)
 113   Standard_EXPORT static void Init();
 114
 115  private:
 116
 117   Handle(Interface_GTool) myGTool;
 118   Handle(TColStd_HArray1OfInteger) myNum;
 119 };
 120
 121 #endif // _Interface_Category_HeaderFile