Open CASCADE Technology  6.9.0
Public Member Functions

IFSelect_SelectSignedShared Class Reference

In the graph, explore the Shareds of the input entities, until it encounters some which match a given Signature (for a limited level, filters the returned list) By default, fitted for any level. More...

#include <IFSelect_SelectSignedShared.hxx>

Inheritance diagram for IFSelect_SelectSignedShared:
Inheritance graph
[legend]

Public Member Functions

 IFSelect_SelectSignedShared (const Handle< IFSelect_Signature > &matcher, const Standard_CString signtext, const Standard_Boolean exact=Standard_True, const Standard_Integer level=0)
 Creates a SelectSignedShared, defaulted for any level with a given Signature and text to match. More...
 
Handle< IFSelect_SignatureSignature () const
 Returns the used Signature, then it is possible to access it, modify it as required. More...
 
const TCollection_AsciiStringSignatureText () const
 Returns Text used to Sort Entity on its Signature. More...
 
Standard_Boolean IsExact () const
 Returns True if match must be exact. More...
 
Standard_Boolean Explore (const Standard_Integer level, const Handle< Standard_Transient > &ent, const Interface_Graph &G, Interface_EntityIterator &explored) const
 Explores an entity : its Shared entities <ent> to take if it matches the Signature At level max, filters the result. Else gives all Shareds. More...
 
TCollection_AsciiString ExploreLabel () const
 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_SelectExplore
Standard_Integer Level () const
 Returns the required exploring level. More...
 
Interface_EntityIterator RootResult (const Interface_Graph &G) const
 Returns the list of selected entities. Works by calling the method Explore on each input entity : it can be rejected, taken for output, or to explore. If the maximum level has not yet been attained, or if no max level is specified, entities to be explored are themselves used as if they were input. More...
 
TCollection_AsciiString Label () const
 Returns a text saying "(Recursive)" or "(Level nn)" plus specific criterium returned by ExploreLabel (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_SelectionInput () 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
 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 MMgt_TShared
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const 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 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...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IFSelect_SelectExplore
 IFSelect_SelectExplore (const Standard_Integer level)
 Initializes a SelectExplore : the level must be specified on starting. 0 means all levels, 1 means level one only, etc... 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

In the graph, explore the Shareds of the input entities, until it encounters some which match a given Signature (for a limited level, filters the returned list) By default, fitted for any level.

Constructor & Destructor Documentation

IFSelect_SelectSignedShared::IFSelect_SelectSignedShared ( const Handle< IFSelect_Signature > &  matcher,
const Standard_CString  signtext,
const Standard_Boolean  exact = Standard_True,
const Standard_Integer  level = 0 
)

Creates a SelectSignedShared, defaulted for any level with a given Signature and text to match.

Member Function Documentation

Standard_Boolean IFSelect_SelectSignedShared::Explore ( const Standard_Integer  level,
const Handle< Standard_Transient > &  ent,
const Interface_Graph G,
Interface_EntityIterator explored 
) const
virtual

Explores an entity : its Shared entities <ent> to take if it matches the Signature At level max, filters the result. Else gives all Shareds.

Implements IFSelect_SelectExplore.

TCollection_AsciiString IFSelect_SelectSignedShared::ExploreLabel ( ) const
virtual

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_SelectExplore.

Standard_Boolean IFSelect_SelectSignedShared::IsExact ( ) const

Returns True if match must be exact.

Handle< IFSelect_Signature > IFSelect_SelectSignedShared::Signature ( ) const

Returns the used Signature, then it is possible to access it, modify it as required.

const TCollection_AsciiString& IFSelect_SelectSignedShared::SignatureText ( ) const

Returns Text used to Sort Entity on its Signature.


The documentation for this class was generated from the following file: