Open CASCADE Technology 6.6.0
Public Member Functions | Protected Attributes
Transfer_TransferIterator Class Reference

Defines an Iterator on the result of a Transfer
Available for Normal Results or not (Erroneous Transfer)
It gives several kinds of Informations, and allows to consider
various criteria (criteria are cumulative)

#include <Transfer_TransferIterator.hxx>

Inheritance diagram for Transfer_TransferIterator:
Inheritance graph
[legend]

Public Member Functions

 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.

Results which are of a given Type (if keep is True) or reject
only them (if keep is False)

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 acheived 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 Transfert 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_TransientTransientResult () 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)

Protected Attributes

Standard_Integer thecurr

Constructor & Destructor Documentation

Transfer_TransferIterator::Transfer_TransferIterator ( )

Member Function Documentation

void Transfer_TransferIterator::AddItem ( const Handle< Transfer_Binder > &  atr)
const Handle_Interface_Check Transfer_TransferIterator::Check ( ) const
Standard_Boolean Transfer_TransferIterator::HasFails ( ) const
Standard_Boolean Transfer_TransferIterator::HasResult ( ) const
Standard_Boolean Transfer_TransferIterator::HasTransientResult ( ) const
Standard_Boolean Transfer_TransferIterator::HasUniqueResult ( ) const
Standard_Boolean Transfer_TransferIterator::HasWarnings ( ) const
Standard_Boolean Transfer_TransferIterator::More ( )
void Transfer_TransferIterator::Next ( )
Standard_Integer Transfer_TransferIterator::Number ( ) const
Handle_Standard_Type Transfer_TransferIterator::ResultType ( ) const
void Transfer_TransferIterator::SelectBinder ( const Handle< Standard_Type > &  atype,
const Standard_Boolean  keep 
)
void Transfer_TransferIterator::SelectItem ( const Standard_Integer  num,
const Standard_Boolean  keep 
)
void Transfer_TransferIterator::SelectResult ( const Handle< Standard_Type > &  atype,
const Standard_Boolean  keep 
)
void Transfer_TransferIterator::SelectUnique ( const Standard_Boolean  keep)
void Transfer_TransferIterator::Start ( )
Transfer_StatusExec Transfer_TransferIterator::Status ( ) const
const Handle_Standard_Transient& Transfer_TransferIterator::TransientResult ( ) const
const Handle_Transfer_Binder& Transfer_TransferIterator::Value ( ) const

Field Documentation


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines