A DispPerCount gathers all the input Entities into one or several Packets, each containing a defined count of Entity This count is a Parameter of the DispPerCount, given as an IntParam, thus allowing external control of its Value. More...
#include <IFSelect_DispPerCount.hxx>
Inheritance diagram for IFSelect_DispPerCount:
Public Member Functions | |
| IFSelect_DispPerCount () | |
| Creates a DispPerCount with no Count (default value 1) | |
| Handle< IFSelect_IntParam > | Count () const |
| Returns the Count Parameter used for splitting. | |
| void | SetCount (const Handle< IFSelect_IntParam > &count) |
| Sets a new Parameter for Count. | |
| Standard_Integer | CountValue () const |
| Returns the effective value of the count parameter (if Count Parameter not Set or value not positive, returns 1) | |
| TCollection_AsciiString | Label () const override |
| Returns as Label, "One File per <count> Input Entities". | |
| virtual Standard_Boolean | LimitedMax (const Standard_Integer nbent, Standard_Integer &max) const override |
| Returns True, maximum count is given as <nbent> | |
| void | Packets (const Interface_Graph &G, IFGraph_SubPartsIterator &packs) const override |
| Computes the list of produced Packets. It defines Packets in order to have at most <Count> Entities per Packet, Entities are given by RootResult from the Final Selection. | |
 Public Member Functions inherited from IFSelect_Dispatch | |
| void | SetRootName (const Handle< TCollection_HAsciiString > &name) |
| Sets a Root Name as an HAsciiString To reset it, give a Null Handle (then, a ShareOut will have to define the Default Root Name) | |
| Standard_Boolean | HasRootName () const |
| Returns True if a specific Root Name has been set (else, the Default Root Name has to be used) | |
| const Handle< TCollection_HAsciiString > & | RootName () const |
| Returns the Root Name for files produced by this dispatch It is empty if it has not been set or if it has been reset. | |
| void | SetFinalSelection (const Handle< IFSelect_Selection > &sel) |
| Stores (or Changes) the Final Selection for a Dispatch. | |
| Handle< IFSelect_Selection > | FinalSelection () const |
| Returns the Final Selection of a Dispatch we 'd like : C++ : return const &. | |
| IFSelect_SelectionIterator | Selections () const |
| Returns the complete list of source Selections (starting from FinalSelection) | |
| virtual Standard_Boolean | CanHaveRemainder () const |
| Returns True if a Dispatch can have a Remainder, i.e. if its criterium can let entities apart. It is a potential answer, remainder can be empty at run-time even if answer is True. (to attach a RemainderFromDispatch Selection is not allowed if answer is True). Default answer given here is False (can be redefined) | |
| Interface_EntityIterator | GetEntities (const Interface_Graph &G) const |
| Gets Unique Root Entities from the Final Selection, given an input Graph This the starting step for an Evaluation (Packets - Remainder) | |
| Interface_EntityIterator | Packeted (const Interface_Graph &G) const |
| Returns the list of all Input Entities (see GetEntities) which are put in a Packet. That is, Entities listed in GetEntities but not in Remainder (see below). Input is given as a Graph. | |
| virtual Interface_EntityIterator | Remainder (const Interface_Graph &G) const |
| Returns Remainder which is a set of Entities. Can be empty. Default evaluation is empty (has to be redefined if CanHaveRemainder is redefined to return True). | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| 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. | |
| 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. | |
| 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. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_type_name () |
| Returns a type descriptor about this object. | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. | |
Detailed Description
A DispPerCount gathers all the input Entities into one or several Packets, each containing a defined count of Entity This count is a Parameter of the DispPerCount, given as an IntParam, thus allowing external control of its Value.
Constructor & Destructor Documentation
◆ IFSelect_DispPerCount()
| IFSelect_DispPerCount::IFSelect_DispPerCount | ( | ) |
Creates a DispPerCount with no Count (default value 1)
Member Function Documentation
◆ Count()
| Handle< IFSelect_IntParam > IFSelect_DispPerCount::Count | ( | ) | const |
Returns the Count Parameter used for splitting.
◆ CountValue()
| Standard_Integer IFSelect_DispPerCount::CountValue | ( | ) | const |
Returns the effective value of the count parameter (if Count Parameter not Set or value not positive, returns 1)
◆ Label()
|
overridevirtual |
Returns as Label, "One File per <count> Input Entities".
Implements IFSelect_Dispatch.
◆ LimitedMax()
|
overridevirtual |
Returns True, maximum count is given as <nbent>
Reimplemented from IFSelect_Dispatch.
◆ Packets()
|
overridevirtual |
Computes the list of produced Packets. It defines Packets in order to have at most <Count> Entities per Packet, Entities are given by RootResult from the Final Selection.
Implements IFSelect_Dispatch.
◆ SetCount()
| void IFSelect_DispPerCount::SetCount | ( | const Handle< IFSelect_IntParam > & | count | ) |
Sets a new Parameter for Count.
The documentation for this class was generated from the following file:
