0024157: Parallelization of assembly part of BO
[occt.git] / src / IFSelect / IFSelect_SelectSignature.cdl
CommitLineData
b311480e 1-- Created on: 1994-04-21
2-- Created by: Christian CAILLET
3-- Copyright (c) 1994-1999 Matra Datavision
4-- Copyright (c) 1999-2012 OPEN CASCADE SAS
5--
6-- The content of this file is subject to the Open CASCADE Technology Public
7-- License Version 6.5 (the "License"). You may not use the content of this file
8-- except in compliance with the License. Please obtain a copy of the License
9-- at http://www.opencascade.org and read it completely before using this file.
10--
11-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13--
14-- The Original Code and all software distributed under the License is
15-- distributed on an "AS IS" basis, without warranty of any kind, and the
16-- Initial Developer hereby disclaims all such warranties, including without
17-- limitation, any warranties of merchantability, fitness for a particular
18-- purpose or non-infringement. Please see the License for the specific terms
19-- and conditions governing the rights and limitations under the License.
20
7fd59977 21
22
23class SelectSignature from IFSelect inherits SelectExtract
24
25 ---Purpose : A SelectSignature sorts the Entities on a Signature Matching.
26 -- The signature to match is given at creation time. Also, the
27 -- required match is given at creation time : exact (IsEqual) or
28 -- contains (the Type's Name must contain the criterium Text)
29 --
30 -- Remark that no more interpretation is done, it is an
31 -- alpha-numeric signature : for instance, DynamicType is matched
32 -- as such, super-types are not considered
33 --
34 -- Also, numeric (integer) comparisons are supported : an item
35 -- can be <val ou <=val or >val or >=val , val being an Integer
36 --
37 -- A SelectSignature may also be created from a SignCounter,
38 -- which then just gives its LastValue as SignatureValue
39
40uses CString, AsciiString from TCollection, Transient,
41 SequenceOfAsciiString from TColStd, SequenceOfInteger from TColStd,
42 InterfaceModel, Graph, Signature, SignCounter
43
44is
45
46 Create (matcher : Signature;
47 signtext : CString;
48 exact : Boolean = Standard_True)
49 returns mutable SelectSignature;
50 ---Purpose : Creates a SelectSignature with its Signature and its Text to
51 -- Match.
52 -- <exact> if True requires exact match,
53 -- if False requires <signtext> to be contained in the Signature
54 -- of the entity (default is "exact")
55
56 Create (matcher : Signature;
57 signtext : AsciiString from TCollection;
58 exact : Boolean = Standard_True)
59 returns mutable SelectSignature;
60 ---Purpose : As above with an AsciiString
61
62 Create (matcher : SignCounter;
63 signtext : CString;
64 exact : Boolean = Standard_True)
65 returns mutable SelectSignature;
66 ---Purpose : Creates a SelectSignature with a Counter, more precisely a
67 -- SelectSignature. Which is used here to just give a Signature
68 -- Value (by SignOnly Mode)
69 -- Matching is the default provided by the class Signature
70
71 Signature (me) returns mutable Signature;
72 ---Purpose : Returns the used Signature, then it is possible to access it,
73 -- modify it as required. Can be null, hence see Counter
74
75 Counter (me) returns mutable SignCounter;
76 ---Purpose : Returns the used SignCounter. Can be used as alternative for
77 -- Signature
78
79 SortInGraph (me; rank : Integer; ent : Transient; G : Graph)
80 returns Boolean is redefined;
81 ---Purpose : Returns True for an Entity (model->Value(num)) of which the
82 -- signature matches the text given as creation time
83 -- May also work with a Counter from the Graph
84
85 Sort (me; rank : Integer; ent : Transient; model : InterfaceModel)
86 returns Boolean;
87 ---Purpose : Not called, defined only to remove a deferred method here
88
89 SignatureText (me) returns AsciiString from TCollection;
90 ---Purpose : Returns Text used to Sort Entity on its Signature or SignCounter
91 ---C++ : return const &
92
93 IsExact (me) returns Boolean;
94 ---Purpose : Returns True if match must be exact
95
96 ExtractLabel (me) returns AsciiString from TCollection;
97 ---Purpose : Returns a text defining the criterium.
98 -- (it refers to the text and exact flag to be matched, and is
99 -- qualified by the Name provided by the Signature)
100
101fields
102
103 thematcher : Signature;
104 thecounter : SignCounter;
105 thesigntext : AsciiString from TCollection;
106 theexact : Integer;
107 thesignlist : SequenceOfAsciiString from TColStd;
108 thesignmode : SequenceOfInteger from TColStd;
109
110end SelectSignature;