|
Open CASCADE Technology
6.7.1
|
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
|
Open CASCADE Technology
6.7.1
|
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
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) More... | |
| Standard_Boolean | HasRootName () const |
| Returns True if a specific Root Name has been set (else, the Default Root Name has to be used) More... | |
| 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 More... | |
| void | SetFinalSelection (const Handle< IFSelect_Selection > &sel) |
| Stores (or Changes) the Final Selection for a Dispatch More... | |
| Handle_IFSelect_Selection | FinalSelection () const |
Returns the Final Selection of a Dispatch <br> we 'd like : C++ : return const & | |
| IFSelect_SelectionIterator | Selections () const |
| Returns the complete list of source Selections (starting from FinalSelection) More... | |
| 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) More... | |
| 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) More... | |
| virtual TCollection_AsciiString | Label () const =0 |
| Returns a text which defines the way a Dispatch produces packets (which will become files) from its Input More... | |
| 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) More... | |
| virtual Standard_Boolean | PacketsCount (const Interface_Graph &G, Standard_Integer &count) const |
| Returns True if Count of Packets is actually known, and the value of the count in argument "count". Returns False if this count is unknown. Input is given as a Graph. This method is intended to be quick (used for file names) hence if this count is long to compute (that is, as a result of complete evaluation made by method Packets), it is preferable to answer "unknown" by returning False Default answer if False. Can be redefined. More... | |
| 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 More... | |
| 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. More... | |
| 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). 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_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual void | ShallowDump (Standard_OStream &) const |
| 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... | |
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
|
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.
| Handle_IFSelect_Selection IFSelect_Dispatch::FinalSelection | ( | ) | const |
Returns the Final Selection of a Dispatch <br>
we 'd like : C++ : return const &
| 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)
| 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)
|
pure virtual |
Returns a text which defines the way a Dispatch produces
packets (which will become files) from its Input
Implemented in IFSelect_DispPerFiles, IFSelect_DispPerSignature, IFSelect_DispPerCount, IGESSelect_DispPerDrawing, IGESSelect_DispPerSingleView, IFSelect_DispPerOne, and IFSelect_DispGlobal.
|
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_DispPerFiles, IFSelect_DispPerSignature, IFSelect_DispPerCount, IFSelect_DispPerOne, and IFSelect_DispGlobal.
| 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.
|
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_DispPerFiles, IFSelect_DispPerCount, IFSelect_DispPerSignature, IFSelect_DispPerOne, IGESSelect_DispPerDrawing, IGESSelect_DispPerSingleView, and IFSelect_DispGlobal.
|
virtual |
Returns True if Count of Packets is actually known, and the
value of the count in argument "count". Returns False if
this count is unknown. Input is given as a Graph.
This method is intended to be quick (used for file names)
hence if this count is long to compute (that is, as a result
of complete evaluation made by method Packets), it is
preferable to answer "unknown" by returning False
Default answer if False. Can be redefined.
Reimplemented in IFSelect_DispPerFiles, IFSelect_DispPerCount, IFSelect_DispPerOne, and IFSelect_DispGlobal.
|
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.
| 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
| IFSelect_SelectionIterator IFSelect_Dispatch::Selections | ( | ) | const |
Returns the complete list of source Selections (starting
from FinalSelection)
| void IFSelect_Dispatch::SetFinalSelection | ( | const Handle< IFSelect_Selection > & | sel | ) |
Stores (or Changes) the Final Selection for a Dispatch
| 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)
1.8.5