Transfer_TransferOutput Class Reference

A TransferOutput is a Tool which manages the transfer of entities created by an Interface, stored in an InterfaceModel, into a set of Objects suitable for an Application Objects to be transferred are given, by method Transfer (which calls Transfer from TransientProcess) A default action is available to get all roots of the Model Result is given as a TransferIterator (see TransferProcess) Also, it is possible to pilot directly the TransientProcess. More...

#include <Transfer_TransferOutput.hxx>

Public Member Functions
	Transfer_TransferOutput (const occ::handle< Transfer_ActorOfTransientProcess > &actor, const occ::handle< Interface_InterfaceModel > &amodel)
	Creates a TransferOutput ready to use, with a TransientProcess.
	Transfer_TransferOutput (const occ::handle< Transfer_TransientProcess > &proc, const occ::handle< Interface_InterfaceModel > &amodel)
	Creates a TransferOutput from an already existing TransientProcess, and a Model Returns (by Reference, hence can be changed) the Mode for Scope Management. False (D) means Scope is ignored. True means that each individual Transfer (direct or through TransferRoots) is regarded as one Scope.
occ::handle< Interface_InterfaceModel >	Model () const
	Returns the Starting Model.
occ::handle< Transfer_TransientProcess >	TransientProcess () const
	Returns the TransientProcess used to work.
void	Transfer (const occ::handle< Standard_Transient > &obj, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Transfer checks that all taken Entities come from the same Model, then calls Transfer from TransientProcess.
void	TransferRoots (const occ::handle< Interface_Protocol > &protocol, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Runs transfer on the roots of the Interface Model The Roots are computed with a ShareFlags created from a Protocol given as Argument.
void	TransferRoots (const Interface_Graph &G, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Runs transfer on the roots defined by a Graph of dependences (which detains also a Model and its Entities) Roots are computed with a ShareFlags created from the Graph.
void	TransferRoots (const Message_ProgressRange &theProgress=Message_ProgressRange())
	Runs transfer on the roots of the Interface Model Remark : the Roots are computed with a ShareFlags created from the Active Protocol.
Interface_EntityIterator	ListForStatus (const bool normal, const bool roots=true) const
	Returns the list of Starting Entities with these criteria :
occ::handle< Interface_InterfaceModel >	ModelForStatus (const occ::handle< Interface_Protocol > &protocol, const bool normal, const bool roots=true) const
	Fills a Model with the list determined by ListForStatus This model starts from scratch (made by NewEmptyModel from the current Model), then is filled by AddWithRefs.

Detailed Description

A TransferOutput is a Tool which manages the transfer of entities created by an Interface, stored in an InterfaceModel, into a set of Objects suitable for an Application Objects to be transferred are given, by method Transfer (which calls Transfer from TransientProcess) A default action is available to get all roots of the Model Result is given as a TransferIterator (see TransferProcess) Also, it is possible to pilot directly the TransientProcess.

Constructor & Destructor Documentation

Transfer_TransferOutput() [1/2]

Transfer_TransferOutput::Transfer_TransferOutput	(	const occ::handle< Transfer_ActorOfTransientProcess > &	actor,
		const occ::handle< Interface_InterfaceModel > &	amodel )

Creates a TransferOutput ready to use, with a TransientProcess.

Transfer_TransferOutput() [2/2]

Transfer_TransferOutput::Transfer_TransferOutput	(	const occ::handle< Transfer_TransientProcess > &	proc,
		const occ::handle< Interface_InterfaceModel > &	amodel )

Creates a TransferOutput from an already existing TransientProcess, and a Model Returns (by Reference, hence can be changed) the Mode for Scope Management. False (D) means Scope is ignored. True means that each individual Transfer (direct or through TransferRoots) is regarded as one Scope.

Member Function Documentation

ListForStatus()

Interface_EntityIterator Transfer_TransferOutput::ListForStatus	(	const bool	normal,
		const bool	roots = true ) const

Returns the list of Starting Entities with these criteria :

• <normal> False, gives the entities bound with ABNORMAL STATUS (e.g. : Fail recorded, Exception raised during Transfer)
• <normal> True, gives Entities with or without a Result, but with no Fail, no Exception (Warnings are not counted)
• <roots> False, considers all entities recorded (either for Result, or for at least one Fail or Warning message)
• <roots> True (Default), considers only roots of Transfer (the Entities recorded at highest level) This method is based on AbnormalResult from TransferProcess

Model()

occ::handle< Interface_InterfaceModel > Transfer_TransferOutput::Model

(

)

const

Returns the Starting Model.

ModelForStatus()

occ::handle< Interface_InterfaceModel > Transfer_TransferOutput::ModelForStatus	(	const occ::handle< Interface_Protocol > &	protocol,
		const bool	normal,
		const bool	roots = true ) const

Fills a Model with the list determined by ListForStatus This model starts from scratch (made by NewEmptyModel from the current Model), then is filled by AddWithRefs.

Useful to get separately from a transfer, the entities which have caused problem, in order to furtherly analyse them (with normal = False), or the "good" entities, to obtain a data set "which works well" (with normal = True)

Transfer()

void Transfer_TransferOutput::Transfer	(	const occ::handle< Standard_Transient > &	obj,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

Transfer checks that all taken Entities come from the same Model, then calls Transfer from TransientProcess.

TransferRoots() [1/3]

void Transfer_TransferOutput::TransferRoots	(	const Interface_Graph &	G,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

Runs transfer on the roots defined by a Graph of dependences (which detains also a Model and its Entities) Roots are computed with a ShareFlags created from the Graph.

TransferRoots() [2/3]

void Transfer_TransferOutput::TransferRoots

(

const Message_ProgressRange &

theProgress = Message_ProgressRange()

)

Runs transfer on the roots of the Interface Model Remark : the Roots are computed with a ShareFlags created from the Active Protocol.

TransferRoots() [3/3]

void Transfer_TransferOutput::TransferRoots	(	const occ::handle< Interface_Protocol > &	protocol,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

Runs transfer on the roots of the Interface Model The Roots are computed with a ShareFlags created from a Protocol given as Argument.

TransientProcess()

occ::handle< Transfer_TransientProcess > Transfer_TransferOutput::TransientProcess

(

)

const

Returns the TransientProcess used to work.

---

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

• Transfer_TransferOutput.hxx