A SelectSignature sorts the Entities on a Signature Matching. The signature to match is given at creation time. Also, the required match is given at creation time : exact (IsEqual) or contains (the Type's Name must contain the criterium Text) More...
#include <IFSelect_SelectSignature.hxx>
Inheritance diagram for IFSelect_SelectSignature:
Public Member Functions | |
| IFSelect_SelectSignature (const Handle< IFSelect_Signature > &matcher, const Standard_CString signtext, const Standard_Boolean exact=Standard_True) | |
| Creates a SelectSignature with its Signature and its Text to Match. <exact> if True requires exact match, if False requires <signtext> to be contained in the Signature of the entity (default is "exact") More... | |
| IFSelect_SelectSignature (const Handle< IFSelect_Signature > &matcher, const TCollection_AsciiString &signtext, const Standard_Boolean exact=Standard_True) | |
| As above with an AsciiString. More... | |
| IFSelect_SelectSignature (const Handle< IFSelect_SignCounter > &matcher, const Standard_CString signtext, const Standard_Boolean exact=Standard_True) | |
| Creates a SelectSignature with a Counter, more precisely a SelectSignature. Which is used here to just give a Signature Value (by SignOnly Mode) Matching is the default provided by the class Signature. More... | |
| Handle< IFSelect_Signature > | Signature () const |
| Returns the used Signature, then it is possible to access it, modify it as required. Can be null, hence see Counter. More... | |
| Handle< IFSelect_SignCounter > | Counter () const |
| Returns the used SignCounter. Can be used as alternative for Signature. More... | |
| virtual Standard_Boolean | SortInGraph (const Standard_Integer rank, const Handle< Standard_Transient > &ent, const Interface_Graph &G) const override |
| Returns True for an Entity (model->Value(num)) of which the signature matches the text given as creation time May also work with a Counter from the Graph. More... | |
| Standard_Boolean | Sort (const Standard_Integer rank, const Handle< Standard_Transient > &ent, const Handle< Interface_InterfaceModel > &model) const override |
| Not called, defined only to remove a deferred method here. More... | |
| const TCollection_AsciiString & | SignatureText () const |
| Returns Text used to Sort Entity on its Signature or SignCounter. More... | |
| Standard_Boolean | IsExact () const |
| Returns True if match must be exact. More... | |
| TCollection_AsciiString | ExtractLabel () const override |
| Returns a text defining the criterium. (it refers to the text and exact flag to be matched, and is qualified by the Name provided by the Signature) More... | |
 Public Member Functions inherited from IFSelect_SelectExtract | |
| Standard_Boolean | IsDirect () const |
| Returns True if Sort criterium is Direct, False if Reverse. More... | |
| void | SetDirect (const Standard_Boolean direct) |
| Sets Sort criterium sense to a new value (True : Direct , False : Reverse) More... | |
| virtual Interface_EntityIterator | RootResult (const Interface_Graph &G) const override |
| Returns the list of selected entities. Works by calling the method Sort on each input Entity : the Entity is kept as output if Sort returns the same value as Direct status. More... | |
| TCollection_AsciiString | Label () const override |
| Returns a text saying "Picked" or "Removed", plus the specific criterium returned by ExtractLabel (see below) More... | |
| Public Member Functions inherited from IFSelect_SelectDeduct | |
| void | SetInput (const Handle< IFSelect_Selection > &sel) |
| Defines or Changes the Input Selection. More... | |
| Handle< IFSelect_Selection > | Input () const |
| Returns the Input Selection. More... | |
| Standard_Boolean | HasInput () const |
| Returns True if the Input Selection is defined, False else. More... | |
| Standard_Boolean | HasAlternate () const |
| Tells if an Alternate List has been set, i.e. : the Alternate Definition is present and set. More... | |
| Handle< IFSelect_SelectPointed > & | Alternate () |
| Returns the Alternate Definition It is returned modifiable, hence an already defined SelectPointed can be used But if it was not yet defined, it is created the first time. More... | |
| Interface_EntityIterator | InputResult (const Interface_Graph &G) const |
| Returns the Result determined by Input Selection, as Unique if Input Selection is not defined, returns an empty list. More... | |
| void | FillIterator (IFSelect_SelectionIterator &iter) const override |
| Puts in an Iterator the Selections from which "me" depends This list contains one Selection : the InputSelection. More... | |
| Public Member Functions inherited from IFSelect_Selection | |
| Interface_EntityIterator | UniqueResult (const Interface_Graph &G) const |
| Returns the list of selected entities, each of them beeing unique. Default definition works from RootResult. According HasUniqueResult, UniqueResult returns directly RootResult, or build a Unique Result from it with a Graph. More... | |
| virtual Interface_EntityIterator | CompleteResult (const Interface_Graph &G) const |
| Returns the list of entities involved by a Selection, i.e. UniqueResult plus the shared entities (directly or not) More... | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. More... | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More... | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. More... | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. More... | |
| Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
| Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| Standard_Transient * | This () const |
| Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
| void | IncrementRefCounter () const |
| Increments the reference counter of this object. More... | |
| Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More... | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Static Public Member Functions inherited from Standard_Transient | |
| static const char * | get_type_name () |
| Returns a type descriptor about this object. More... | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. More... | |
| Protected Member Functions inherited from IFSelect_SelectExtract | |
| IFSelect_SelectExtract () | |
| Initializes a SelectExtract : enforces the sort to be Direct. More... | |
| Protected Member Functions inherited from IFSelect_Selection | |
| virtual Standard_Boolean | HasUniqueResult () const |
| Returns True if RootResult guarantees uniqueness for each Entity. Called by UniqueResult. Default answer is False. Can be redefined. More... | |
Detailed Description
A SelectSignature sorts the Entities on a Signature Matching. The signature to match is given at creation time. Also, the required match is given at creation time : exact (IsEqual) or contains (the Type's Name must contain the criterium Text)
Remark that no more interpretation is done, it is an alpha-numeric signature : for instance, DynamicType is matched as such, super-types are not considered
Also, numeric (integer) comparisons are supported : an item can be <val ou <=val or >val or >=val , val being an Integer
A SelectSignature may also be created from a SignCounter, which then just gives its LastValue as SignatureValue
Constructor & Destructor Documentation
◆ IFSelect_SelectSignature() [1/3]
| IFSelect_SelectSignature::IFSelect_SelectSignature | ( | const Handle< IFSelect_Signature > & | matcher, |
| const Standard_CString | signtext, | ||
| const Standard_Boolean | exact = Standard_True |
||
| ) |
Creates a SelectSignature with its Signature and its Text to Match. <exact> if True requires exact match, if False requires <signtext> to be contained in the Signature of the entity (default is "exact")
◆ IFSelect_SelectSignature() [2/3]
| IFSelect_SelectSignature::IFSelect_SelectSignature | ( | const Handle< IFSelect_Signature > & | matcher, |
| const TCollection_AsciiString & | signtext, | ||
| const Standard_Boolean | exact = Standard_True |
||
| ) |
As above with an AsciiString.
◆ IFSelect_SelectSignature() [3/3]
| IFSelect_SelectSignature::IFSelect_SelectSignature | ( | const Handle< IFSelect_SignCounter > & | matcher, |
| const Standard_CString | signtext, | ||
| const Standard_Boolean | exact = Standard_True |
||
| ) |
Creates a SelectSignature with a Counter, more precisely a SelectSignature. Which is used here to just give a Signature Value (by SignOnly Mode) Matching is the default provided by the class Signature.
Member Function Documentation
◆ Counter()
| Handle< IFSelect_SignCounter > IFSelect_SelectSignature::Counter | ( | ) | const |
Returns the used SignCounter. Can be used as alternative for Signature.
◆ ExtractLabel()
|
overridevirtual |
Returns a text defining the criterium. (it refers to the text and exact flag to be matched, and is qualified by the Name provided by the Signature)
Implements IFSelect_SelectExtract.
◆ IsExact()
| Standard_Boolean IFSelect_SelectSignature::IsExact | ( | ) | const |
Returns True if match must be exact.
◆ Signature()
| Handle< IFSelect_Signature > IFSelect_SelectSignature::Signature | ( | ) | const |
Returns the used Signature, then it is possible to access it, modify it as required. Can be null, hence see Counter.
◆ SignatureText()
| const TCollection_AsciiString& IFSelect_SelectSignature::SignatureText | ( | ) | const |
Returns Text used to Sort Entity on its Signature or SignCounter.
◆ Sort()
|
overridevirtual |
Not called, defined only to remove a deferred method here.
Implements IFSelect_SelectExtract.
◆ SortInGraph()
|
overridevirtual |
Returns True for an Entity (model->Value(num)) of which the signature matches the text given as creation time May also work with a Counter from the Graph.
Reimplemented from IFSelect_SelectExtract.
The documentation for this class was generated from the following file:
