include/opencascade/IFSelect_DispPerSignature.hxx

0001 // Created on: 1994-12-21
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 _IFSelect_DispPerSignature_HeaderFile
0018 #define _IFSelect_DispPerSignature_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IFSelect_Dispatch.hxx>
0024 #include <Standard_Integer.hxx>
0025 class IFSelect_SignCounter;
0026 class TCollection_AsciiString;
0027 class Interface_Graph;
0028 class IFGraph_SubPartsIterator;
0029
0030 class IFSelect_DispPerSignature;
0031 DEFINE_STANDARD_HANDLE(IFSelect_DispPerSignature, IFSelect_Dispatch)
0032
0033 //! A DispPerSignature sorts input Entities according to a
0034 //! Signature : it works with a SignCounter to do this.
0035 class IFSelect_DispPerSignature : public IFSelect_Dispatch
0036 {
0037
0038 public:
0039   //! Creates a DispPerSignature with no SignCounter (by default,
0040   //! produces only one packet)
0041   Standard_EXPORT IFSelect_DispPerSignature();
0042
0043   //! Returns the SignCounter used for splitting
0044   Standard_EXPORT Handle(IFSelect_SignCounter) SignCounter() const;
0045
0046   //! Sets a SignCounter for sort
0047   //! Remark : it is set to record lists of entities, not only counts
0048   Standard_EXPORT void SetSignCounter(const Handle(IFSelect_SignCounter)& sign);
0049
0050   //! Returns the name of the SignCounter, which caracterises the
0051   //! sorting criterium for this Dispatch
0052   Standard_EXPORT Standard_CString SignName() const;
0053
0054   //! Returns as Label, "One File per Signature <name>"
0055   Standard_EXPORT TCollection_AsciiString Label() const Standard_OVERRIDE;
0056
0057   //! Returns True, maximum count is given as <nbent>
0058   Standard_EXPORT virtual Standard_Boolean LimitedMax(const Standard_Integer nbent,
0059                                                       Standard_Integer&      max) const
0060     Standard_OVERRIDE;
0061
0062   //! Computes the list of produced Packets. It defines Packets from
0063   //! the SignCounter, which sirts the input Entities per Signature
0064   //! (specific of the SignCounter).
0065   Standard_EXPORT void Packets(const Interface_Graph&    G,
0066                                IFGraph_SubPartsIterator& packs) const Standard_OVERRIDE;
0067
0068   DEFINE_STANDARD_RTTIEXT(IFSelect_DispPerSignature, IFSelect_Dispatch)
0069
0070 protected:
0071 private:
0072   Handle(IFSelect_SignCounter) thesign;
0073 };
0074
0075 #endif // _IFSelect_DispPerSignature_HeaderFile