Open CASCADE Technology  7.3.1.dev
Public Member Functions
IFSelect_SelectSent Class Reference

This class returns entities according sending to a file Once a model has been loaded, further sendings are recorded as status in the graph (for each value, a count of sendings) More...

#include <IFSelect_SelectSent.hxx>

Inheritance diagram for IFSelect_SelectSent:
Inheritance graph
[legend]

Public Member Functions

 IFSelect_SelectSent (const Standard_Integer sentcount=1, const Standard_Boolean atleast=Standard_True)
 Creates a SelectSent : sentcount = 0 -> remaining (non-sent) entities sentcount = 1, atleast = True (D) -> sent (at least once) sentcount = 2, atleast = True -> duplicated (sent least twice) etc... sentcount = 1, atleast = False -> sent just once (non-dupl.d) sentcount = 2, atleast = False -> sent just twice etc... More...
 
Standard_Integer SentCount () const
 Returns the queried count of sending. More...
 
Standard_Boolean AtLeast () const
 Returns the <atleast> status, True for sending at least the sending count, False for sending exactly the sending count Remark : if SentCount is 0, AtLeast is ignored. More...
 
virtual Interface_EntityIterator RootResult (const Interface_Graph &G) const override
 Returns the list of selected entities. It is redefined to work on the graph itself (not queried by sort) More...
 
Standard_Boolean Sort (const Standard_Integer rank, const Handle< Standard_Transient > &ent, const Handle< Interface_InterfaceModel > &model) const override
 Returns always False because RootResult has done the work. More...
 
TCollection_AsciiString ExtractLabel () const override
 Returns a text defining the criterium : query : SentCount = 0 -> "Remaining (non-sent) entities" SentCount = 1, AtLeast = True -> "Sent entities" SentCount = 1, AtLeast = False -> "Sent once (no duplicated)" SentCount = 2, AtLeast = True -> "Sent several times entities" SentCount = 2, AtLeast = False -> "Sent twice entities" SentCount > 2, AtLeast = True -> "Sent at least <count> times entities" SentCount > 2, AtLeast = False -> "Sent <count> times entities". 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 Standard_Boolean SortInGraph (const Standard_Integer rank, const Handle< Standard_Transient > &ent, const Interface_Graph &G) const
 Works as Sort but works on the Graph Default directly calls Sort, but it can be redefined If SortInGraph is redefined, Sort should be defined even if not called (to avoid deferred methods in a final class) 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_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 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_Transientoperator= (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_TransientThis () 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

This class returns entities according sending to a file Once a model has been loaded, further sendings are recorded as status in the graph (for each value, a count of sendings)

Hence, it is possible to query entities : sent ones (at least once), non-sent (i.e. remaining) ones, duplicated ones, etc...

This selection performs this query

Constructor & Destructor Documentation

◆ IFSelect_SelectSent()

IFSelect_SelectSent::IFSelect_SelectSent ( const Standard_Integer  sentcount = 1,
const Standard_Boolean  atleast = Standard_True 
)

Creates a SelectSent : sentcount = 0 -> remaining (non-sent) entities sentcount = 1, atleast = True (D) -> sent (at least once) sentcount = 2, atleast = True -> duplicated (sent least twice) etc... sentcount = 1, atleast = False -> sent just once (non-dupl.d) sentcount = 2, atleast = False -> sent just twice etc...

Member Function Documentation

◆ AtLeast()

Standard_Boolean IFSelect_SelectSent::AtLeast ( ) const

Returns the <atleast> status, True for sending at least the sending count, False for sending exactly the sending count Remark : if SentCount is 0, AtLeast is ignored.

◆ ExtractLabel()

TCollection_AsciiString IFSelect_SelectSent::ExtractLabel ( ) const
overridevirtual

Returns a text defining the criterium : query : SentCount = 0 -> "Remaining (non-sent) entities" SentCount = 1, AtLeast = True -> "Sent entities" SentCount = 1, AtLeast = False -> "Sent once (no duplicated)" SentCount = 2, AtLeast = True -> "Sent several times entities" SentCount = 2, AtLeast = False -> "Sent twice entities" SentCount > 2, AtLeast = True -> "Sent at least <count> times entities" SentCount > 2, AtLeast = False -> "Sent <count> times entities".

Implements IFSelect_SelectExtract.

◆ RootResult()

virtual Interface_EntityIterator IFSelect_SelectSent::RootResult ( const Interface_Graph G) const
overridevirtual

Returns the list of selected entities. It is redefined to work on the graph itself (not queried by sort)

An entity is selected if its count complies to the query in Direct Mode, rejected in Reversed Mode

Query works on the sending count recorded as status in Graph

Reimplemented from IFSelect_SelectExtract.

◆ SentCount()

Standard_Integer IFSelect_SelectSent::SentCount ( ) const

Returns the queried count of sending.

◆ Sort()

Standard_Boolean IFSelect_SelectSent::Sort ( const Standard_Integer  rank,
const Handle< Standard_Transient > &  ent,
const Handle< Interface_InterfaceModel > &  model 
) const
overridevirtual

Returns always False because RootResult has done the work.

Implements IFSelect_SelectExtract.


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