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 Information, and allows to consider various criteria (criteria are cumulative) More...

#include <Transfer_TransferIterator.hxx>

Inheritance diagram for Transfer_TransferIterator:

Public Member Functions
	Transfer_TransferIterator ()
	Creates an empty Iterator.
void	AddItem (const occ::handle< Transfer_Binder > &atr)
	Adds a Binder to the iteration list (construction)
void	SelectBinder (const occ::handle< Standard_Type > &atype, const bool 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 occ::handle< Standard_Type > &atype, const bool 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 bool 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 int num, const bool keep)
	Selects/Unselect (according to <keep> an item designated by its rank <num> in the list Used by sub-classes which have specific criteria.
int	Number () const
	Returns count of Binders to be iterated.
void	Start ()
	Clears Iteration in progress, to allow it to be restarted.
bool	More ()
	Returns True if there are other Items to iterate.
void	Next ()
	Sets Iteration to the next Item.
const occ::handle< Transfer_Binder > &	Value () const
	Returns the current Binder.
bool	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.
bool	HasUniqueResult () const
	Returns True if Current Item has a Unique Result.
occ::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.
bool	HasTransientResult () const
	Returns True if the current Item has a Transient Unique Result (if yes, use TransientResult to get it)
const occ::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.
bool	HasFails () const
	Returns True if Fail Messages are recorded with the current Binder. They can then be read through Check (see below)
bool	HasWarnings () const
	Returns True if Warning Messages are recorded with the current Binder. They can then be read through Check (see below)
const occ::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
int	thecurr

Detailed Description

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

Constructor & Destructor Documentation

Transfer_TransferIterator()

Transfer_TransferIterator::Transfer_TransferIterator

(

)

Creates an empty Iterator.

Member Function Documentation

AddItem()

void Transfer_TransferIterator::AddItem

(

const occ::handle< Transfer_Binder > &

atr

)

Adds a Binder to the iteration list (construction)

Check()

const occ::handle< Interface_Check > Transfer_TransferIterator::Check

(

)

const

Returns Check associated to current Binder (in case of error, it brings Fail messages) (in case of warnings, it brings Warning messages)

HasFails()

bool Transfer_TransferIterator::HasFails

(

)

const

Returns True if Fail Messages are recorded with the current Binder. They can then be read through Check (see below)

HasResult()

bool Transfer_TransferIterator::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.

HasTransientResult()

bool Transfer_TransferIterator::HasTransientResult

(

)

const

Returns True if the current Item has a Transient Unique Result (if yes, use TransientResult to get it)

HasUniqueResult()

bool Transfer_TransferIterator::HasUniqueResult

(

)

const

Returns True if Current Item has a Unique Result.

HasWarnings()

bool Transfer_TransferIterator::HasWarnings

(

)

const

Returns True if Warning Messages are recorded with the current Binder. They can then be read through Check (see below)

More()

bool Transfer_TransferIterator::More

(

)

Returns True if there are other Items to iterate.

Next()

void Transfer_TransferIterator::Next

(

)

Sets Iteration to the next Item.

Number()

int Transfer_TransferIterator::Number

(

)

const

Returns count of Binders to be iterated.

ResultType()

occ::handle< Standard_Type > Transfer_TransferIterator::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.

SelectBinder()

void Transfer_TransferIterator::SelectBinder	(	const occ::handle< Standard_Type > &	atype,
		const bool	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)

SelectItem()

void Transfer_TransferIterator::SelectItem	(	const int	num,
		const bool	keep )

Selects/Unselect (according to <keep> an item designated by its rank <num> in the list Used by sub-classes which have specific criteria.

SelectResult()

void Transfer_TransferIterator::SelectResult	(	const occ::handle< Standard_Type > &	atype,
		const bool	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)

SelectUnique()

void Transfer_TransferIterator::SelectUnique

(

const bool

keep

)

Select Items according Unicity : keep only Unique Results (if keep is True) or keep only Multiple Results (if keep is False)

Start()

void Transfer_TransferIterator::Start

(

)

Clears Iteration in progress, to allow it to be restarted.

Status()

Transfer_StatusExec Transfer_TransferIterator::Status

(

)

const

Returns Execution Status of current Binder Normal transfer corresponds to StatusDone.

TransientResult()

const occ::handle< Standard_Transient > & Transfer_TransferIterator::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.

Value()

const occ::handle< Transfer_Binder > & Transfer_TransferIterator::Value

(

)

const

Returns the current Binder.

Field Documentation

thecurr

int Transfer_TransferIterator::thecurr

protected

---

The documentation for this class was generated from the following file:

• Transfer_TransferIterator.hxx