#include <Transfer_IteratorOfProcessForTransient.hxx>
Inheritance diagram for Transfer_IteratorOfProcessForTransient:
Public Member Functions | |
| Transfer_IteratorOfProcessForTransient (const Standard_Boolean withstarts) | |
| Creates an empty Iterator if withstarts is True, each Binder to be iterated will be associated to its corresponding Starting Object. | |
| void | Add (const Handle< Transfer_Binder > &binder) |
| Adds a Binder to the iteration list (construction) with no corresponding Starting Object (note that Result is brought by Binder) | |
| void | Add (const Handle< Transfer_Binder > &binder, const Handle< Standard_Transient > &start) |
| Adds a Binder to the iteration list, associated with its corresponding Starting Object "start" Starting Object is ignored if not required at Creation time. | |
| void | Filter (const Handle< TColStd_HSequenceOfTransient > &list, const Standard_Boolean keep=Standard_True) |
| After having added all items, keeps or rejects items which are attached to starting data given by <only> <keep> = True (D) : keeps. <keep> = False : rejects Does nothing if <withstarts> was False. | |
| Standard_Boolean | HasStarting () const |
| Returns True if Starting Object is available (defined at Creation Time) | |
| const Handle< Standard_Transient > & | Starting () const |
| Returns corresponding Starting Object. | |
 Public Member Functions inherited from Transfer_TransferIterator | |
| Transfer_TransferIterator () | |
| Creates an empty Iterator. | |
| void | AddItem (const Handle< Transfer_Binder > &atr) |
| Adds a Binder to the iteration list (construction) | |
| void | SelectBinder (const Handle< Standard_Type > &atype, const Standard_Boolean keep) |
| Selects Items on the Type of Binder : keep only Binders which are of a given Type (if keep is True) or reject only them (if keep is False) | |
| void | SelectResult (const Handle< Standard_Type > &atype, const Standard_Boolean keep) |
| Selects Items on the Type of Result. Considers only Unique Results. Considers Dynamic Type for Transient Result, Static Type (the one given to define the Binder) else. | |
| void | SelectUnique (const Standard_Boolean keep) |
| Select Items according Unicity : keep only Unique Results (if keep is True) or keep only Multiple Results (if keep is False) | |
| void | SelectItem (const Standard_Integer num, const Standard_Boolean keep) |
| Selects/Unselect (according to <keep> an item designated by its rank <num> in the list Used by sub-classes which have specific criteria. | |
| Standard_Integer | Number () const |
| Returns count of Binders to be iterated. | |
| void | Start () |
| Clears Iteration in progress, to allow it to be restarted. | |
| Standard_Boolean | More () |
| Returns True if there are other Items to iterate. | |
| void | Next () |
| Sets Iteration to the next Item. | |
| const Handle< Transfer_Binder > & | Value () const |
| Returns the current Binder. | |
| Standard_Boolean | HasResult () const |
| Returns True if current Item brings a Result, Transient (Handle) or not or Multiple. That is to say, if it corresponds to a normally achieved Transfer, Transient Result is read by specific TransientResult below. Other kind of Result must be read specifically from its Binder. | |
| Standard_Boolean | HasUniqueResult () const |
| Returns True if Current Item has a Unique Result. | |
| Handle< Standard_Type > | ResultType () const |
| Returns the Type of the Result of the current Item, if Unique. If No Unique Result (Error Transfer or Multiple Result), returns a Null Handle The Type is : the Dynamic Type for a Transient Result, the Type defined by the Binder Class else. | |
| Standard_Boolean | HasTransientResult () const |
| Returns True if the current Item has a Transient Unique Result (if yes, use TransientResult to get it) | |
| const Handle< Standard_Transient > & | TransientResult () const |
| Returns the Transient Result of the current Item if there is (else, returns a null Handle) Supposes that Binding is done by a SimpleBinderOfTransient. | |
| Transfer_StatusExec | Status () const |
| Returns Execution Status of current Binder Normal transfer corresponds to StatusDone. | |
| Standard_Boolean | HasFails () const |
| Returns True if Fail Messages are recorded with the current Binder. They can then be read through Check (see below) | |
| Standard_Boolean | HasWarnings () const |
| Returns True if Warning Messages are recorded with the current Binder. They can then be read through Check (see below) | |
| const Handle< Interface_Check > | Check () const |
| Returns Check associated to current Binder (in case of error, it brings Fail messages) (in case of warnings, it brings Warning messages) | |
Additional Inherited Members | |
| Protected Attributes inherited from Transfer_TransferIterator | |
| Standard_Integer | thecurr |
Constructor & Destructor Documentation
◆ Transfer_IteratorOfProcessForTransient()
| Transfer_IteratorOfProcessForTransient::Transfer_IteratorOfProcessForTransient | ( | const Standard_Boolean | withstarts | ) |
Creates an empty Iterator if withstarts is True, each Binder to be iterated will be associated to its corresponding Starting Object.
Member Function Documentation
◆ Add() [1/2]
| void Transfer_IteratorOfProcessForTransient::Add | ( | const Handle< Transfer_Binder > & | binder | ) |
Adds a Binder to the iteration list (construction) with no corresponding Starting Object (note that Result is brought by Binder)
◆ Add() [2/2]
| void Transfer_IteratorOfProcessForTransient::Add | ( | const Handle< Transfer_Binder > & | binder, |
| const Handle< Standard_Transient > & | start | ||
| ) |
Adds a Binder to the iteration list, associated with its corresponding Starting Object "start" Starting Object is ignored if not required at Creation time.
◆ Filter()
| void Transfer_IteratorOfProcessForTransient::Filter | ( | const Handle< TColStd_HSequenceOfTransient > & | list, |
| const Standard_Boolean | keep = Standard_True |
||
| ) |
After having added all items, keeps or rejects items which are attached to starting data given by <only> <keep> = True (D) : keeps. <keep> = False : rejects Does nothing if <withstarts> was False.
◆ HasStarting()
| Standard_Boolean Transfer_IteratorOfProcessForTransient::HasStarting | ( | ) | const |
Returns True if Starting Object is available (defined at Creation Time)
◆ Starting()
| const Handle< Standard_Transient > & Transfer_IteratorOfProcessForTransient::Starting | ( | ) | const |
Returns corresponding Starting Object.
The documentation for this class was generated from the following file:
