src/IFSelect/IFSelect_DispPerSignature.hxx

   1 // Created on: 1994-12-21
   2 // Created by: Christian CAILLET
   3 // Copyright (c) 1994-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 _IFSelect_DispPerSignature_HeaderFile
  18 #define _IFSelect_DispPerSignature_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <IFSelect_Dispatch.hxx>
  24 #include <Standard_Integer.hxx>
  25 class IFSelect_SignCounter;
  26 class TCollection_AsciiString;
  27 class Interface_Graph;
  28 class IFGraph_SubPartsIterator;
  29
  30
  31 class IFSelect_DispPerSignature;
  32 DEFINE_STANDARD_HANDLE(IFSelect_DispPerSignature, IFSelect_Dispatch)
  33
  34 //! A DispPerSignature sorts input Entities according to a
  35 //! Signature : it works with a SignCounter to do this.
  36 class IFSelect_DispPerSignature : public IFSelect_Dispatch
  37 {
  38
  39 public:
  40
  41
  42   //! Creates a DispPerSignature with no SignCounter (by default,
  43   //! produces only one packet)
  44   Standard_EXPORT IFSelect_DispPerSignature();
  45
  46   //! Returns the SignCounter used for splitting
  47   Standard_EXPORT Handle(IFSelect_SignCounter) SignCounter() const;
  48
  49   //! Sets a SignCounter for sort
  50   //! Remark : it is set to record lists of entities, not only counts
  51   Standard_EXPORT void SetSignCounter (const Handle(IFSelect_SignCounter)& sign);
  52
  53   //! Returns the name of the SignCounter, which caracterises the
  54   //! sorting criterium for this Dispatch
  55   Standard_EXPORT Standard_CString SignName() const;
  56
  57   //! Returns as Label, "One File per Signature <name>"
  58   Standard_EXPORT TCollection_AsciiString Label() const Standard_OVERRIDE;
  59
  60   //! Returns True, maximum count is given as <nbent>
  61   Standard_EXPORT virtual Standard_Boolean LimitedMax (const Standard_Integer nbent, Standard_Integer& max) const Standard_OVERRIDE;
  62
  63   //! Computes the list of produced Packets. It defines Packets from
  64   //! the SignCounter, which sirts the input Entities per Signature
  65   //! (specific of the SignCounter).
  66   Standard_EXPORT void Packets (const Interface_Graph& G, IFGraph_SubPartsIterator& packs) const Standard_OVERRIDE;
  67
  68
  69
  70
  71   DEFINE_STANDARD_RTTIEXT(IFSelect_DispPerSignature,IFSelect_Dispatch)
  72
  73 protected:
  74
  75
  76
  77
  78 private:
  79
  80
  81   Handle(IFSelect_SignCounter) thesign;
  82
  83
  84 };
  85
  86
  87
  88
  89
  90
  91
  92 #endif // _IFSelect_DispPerSignature_HeaderFile