This class allows to describe how a set of Entities has to be dispatched into resulting Packets : a Packet is a sub-set of the initial set of entities. More...
#include <IFSelect_Dispatch.hxx>
Public Member Functions | |
| 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) | |
| virtual Standard_Boolean | LimitedMax (const Standard_Integer nbent, Standard_Integer &max) const |
| Returns True if a Dispatch generates a count of Packets always less than or equal to a maximum value : it can be computed from the total count of Entities to be dispatched : <nbent>. If answer is False, no limited maximum is expected for account If answer is True, expected maximum is given in argument <max> Default answer given here is False (can be redefined) | |
| virtual TCollection_AsciiString | Label () const =0 |
| Returns a text which defines the way a Dispatch produces packets (which will become files) from its Input. | |
| 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) | |
| virtual void | Packets (const Interface_Graph &G, IFGraph_SubPartsIterator &packs) const =0 |
| Returns the list of produced Packets into argument <pack>. Each Packet corresponds to a Part, the Entities listed are the Roots given by the Selection. Input is given as a Graph. Thus, to create a file from a packet, it suffices to take the entities listed in a Part of Packets (that is, a Packet) without worrying about Shared entities This method can raise an Exception if data are not coherent. | |
| 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
This class allows to describe how a set of Entities has to be dispatched into resulting Packets : a Packet is a sub-set of the initial set of entities.
Thus, it can generate zero, one, or more Packets according input set and criterium of dispatching. And it can let apart some entities : it is the Remainder, which can be recovered by a specific Selection (RemainderFromDispatch).
Depending of sub-classes, a Dispatch can potentially generate a limited or not count of packet, and a remainder or none.
The input set is read from a specified Selection, attached to the Dispatch : the Final Selection of the Dispatch. The input is the Unique Root Entities list of the Final Selection
Member Function Documentation
◆ CanHaveRemainder()
|
virtual |
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)
Reimplemented in IGESSelect_DispPerDrawing, and IGESSelect_DispPerSingleView.
◆ FinalSelection()
| Handle< IFSelect_Selection > IFSelect_Dispatch::FinalSelection | ( | ) | const |
Returns the Final Selection of a Dispatch we 'd like : C++ : return const &.
◆ GetEntities()
| Interface_EntityIterator IFSelect_Dispatch::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)
◆ HasRootName()
| Standard_Boolean IFSelect_Dispatch::HasRootName | ( | ) | const |
Returns True if a specific Root Name has been set (else, the Default Root Name has to be used)
◆ Label()
|
pure virtual |
Returns a text which defines the way a Dispatch produces packets (which will become files) from its Input.
Implemented in IFSelect_DispGlobal, IFSelect_DispPerCount, IFSelect_DispPerFiles, IFSelect_DispPerOne, IFSelect_DispPerSignature, IGESSelect_DispPerDrawing, and IGESSelect_DispPerSingleView.
◆ LimitedMax()
|
virtual |
Returns True if a Dispatch generates a count of Packets always less than or equal to a maximum value : it can be computed from the total count of Entities to be dispatched : <nbent>. If answer is False, no limited maximum is expected for account If answer is True, expected maximum is given in argument <max> Default answer given here is False (can be redefined)
Reimplemented in IFSelect_DispGlobal, IFSelect_DispPerCount, IFSelect_DispPerFiles, IFSelect_DispPerOne, and IFSelect_DispPerSignature.
◆ Packeted()
| Interface_EntityIterator IFSelect_Dispatch::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.
◆ Packets()
|
pure virtual |
Returns the list of produced Packets into argument <pack>. Each Packet corresponds to a Part, the Entities listed are the Roots given by the Selection. Input is given as a Graph. Thus, to create a file from a packet, it suffices to take the entities listed in a Part of Packets (that is, a Packet) without worrying about Shared entities This method can raise an Exception if data are not coherent.
Implemented in IFSelect_DispGlobal, IFSelect_DispPerCount, IFSelect_DispPerFiles, IFSelect_DispPerOne, IFSelect_DispPerSignature, IGESSelect_DispPerDrawing, and IGESSelect_DispPerSingleView.
◆ Remainder()
|
virtual |
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).
Reimplemented in IGESSelect_DispPerDrawing, and IGESSelect_DispPerSingleView.
◆ RootName()
| const Handle< TCollection_HAsciiString > & IFSelect_Dispatch::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.
◆ Selections()
| IFSelect_SelectionIterator IFSelect_Dispatch::Selections | ( | ) | const |
Returns the complete list of source Selections (starting from FinalSelection)
◆ SetFinalSelection()
| void IFSelect_Dispatch::SetFinalSelection | ( | const Handle< IFSelect_Selection > & | sel | ) |
Stores (or Changes) the Final Selection for a Dispatch.
◆ SetRootName()
| void IFSelect_Dispatch::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)
The documentation for this class was generated from the following file:
