IFSelect_ShareOutResult Class Reference

This class gives results computed from a ShareOut : simulation
before transfer, helps to list entities ...
Transfer itself will later be performed, either by a
TransferCopy to simply divide up a file, or a TransferDispatch
which can be parametred with more details
More...

#include <IFSelect_ShareOutResult.hxx>

Public Member Functions
	IFSelect_ShareOutResult (const Handle< IFSelect_ShareOut > &sho, const Handle< Interface_InterfaceModel > &mod)
	Creates a ShareOutResult from a ShareOut, to work on a Model (without any more precision; uses Active Protocol) More...
	IFSelect_ShareOutResult (const Handle< IFSelect_ShareOut > &sho, const Interface_Graph &G)
	Creates a ShareOutResult from a ShareOut, to work on a Graph already computed, which defines the Input Model and can specialize some Entities More...
	IFSelect_ShareOutResult (const Handle< IFSelect_Dispatch > &disp, const Handle< Interface_InterfaceModel > &mod)
	Creates a ShareOutResult from a unique Dispatch, to work on a Model. As if it was a ShareOut with only one Dispatch (without any more precision; uses Active Protocol) Allows to compute the effect of a single Dispatch More...
	IFSelect_ShareOutResult (const Handle< IFSelect_Dispatch > &disp, const Interface_Graph &G)
	Creates a ShareOutResult from a unique Dispatch, to work on a Graph. As if it was a ShareOut with only one Dispatch Allows to compute the effect of a single Dispatch More...
Handle_IFSelect_ShareOut	ShareOut () const
	Returns the ShareOut used to create the ShareOutResult if creation from a Dispatch, returns a Null Handle More...
const Interface_Graph &	Graph () const
	Returns the Graph used to create theShareOutResult More...
void	Reset ()
	Erases computed data, in order to command a new Evaluation More...
void	Evaluate ()
	Evaluates the result of a ShareOut : determines Entities to be forgotten by the ShareOut, Entities to be transferred several times (duplicated), prepares an iteration on the packets to be produced Called the first time anyone question is asked, or after a call to Reset. Works by calling the method Prepare. More...
Handle_IFSelect_PacketList	Packets (const Standard_Boolean complete=Standard_True)
	Returns the list of recorded Packets, under two modes : More...
Standard_Integer	NbPackets ()
	Returns the total count of produced non empty packets (in out : calls Evaluate as necessary) More...
void	Prepare ()
	Prepares the iteration on the packets <br> This method is called by Evaluate, but can be called anytime <br> The iteration consists in taking each Dispatch of the ShareOut <br> beginning by the first one, compute its packets, then iterate <br> on these packets. Once all these packets are iterated, the <br> iteration passes to the next Dispatch, or stops. <br> For a creation from a unique Dispatch, same but with only <br> this Dispatch. <br> Each packet can be listed, or really transferred (producing <br> a derived Model, from which a file can be generated) <br> Prepare sets the iteration to the first Dispatch, first Packet More...
Standard_Boolean	More ()
	Returns True if there is more packets in the current Dispatch, else if there is more Dispatch in the ShareOut More...
void	Next ()
	Passes to the next Packet in the current Dispatch, or if there is none, to the next Dispatch in the ShareOut More...
void	NextDispatch ()
	Passes to the next Dispatch, regardless about remaining packets More...
Handle_IFSelect_Dispatch	Dispatch () const
	Returns the current Dispatch More...
Standard_Integer	DispatchRank () const
	Returns the Rank of the current Dispatch in the ShareOut Returns Zero if there is none (iteration finished) More...
void	PacketsInDispatch (Standard_Integer &numpack, Standard_Integer &nbpacks) const
	Returns Number (rank) of current Packet in current Dispatch, and total count of Packets in current Dispatch, as arguments More...
Interface_EntityIterator	PacketRoot ()
	Returns the list of Roots of the current Packet (never empty) (i.e. the Entities to be themselves asked for transfer) Error if there is none (iteration finished) More...
Interface_EntityIterator	PacketContent ()
	Returns the complete content of the current Packet (i.e. with shared entities, which will also be put in the file) More...
TCollection_AsciiString	FileName () const
	Returns the File Name which corresponds to current Packet (computed by ShareOut) If current Packet has no associated name (see ShareOut), the returned value is Null More...

Protected Attributes
Interface_Graph	thegraph
IFGraph_SubPartsIterator	thedispres

Detailed Description

This class gives results computed from a ShareOut : simulation
before transfer, helps to list entities ...
Transfer itself will later be performed, either by a
TransferCopy to simply divide up a file, or a TransferDispatch
which can be parametred with more details

Constructor & Destructor Documentation

IFSelect_ShareOutResult::IFSelect_ShareOutResult	(	const Handle< IFSelect_ShareOut > &	sho,
		const Handle< Interface_InterfaceModel > &	mod
	)

Creates a ShareOutResult from a ShareOut, to work on a Model
(without any more precision; uses Active Protocol)

IFSelect_ShareOutResult::IFSelect_ShareOutResult	(	const Handle< IFSelect_ShareOut > &	sho,
		const Interface_Graph &	G
	)

Creates a ShareOutResult from a ShareOut, to work on a Graph
already computed, which defines the Input Model and can
specialize some Entities

IFSelect_ShareOutResult::IFSelect_ShareOutResult	(	const Handle< IFSelect_Dispatch > &	disp,
		const Handle< Interface_InterfaceModel > &	mod
	)

Creates a ShareOutResult from a unique Dispatch, to work on
a Model. As if it was a ShareOut with only one Dispatch
(without any more precision; uses Active Protocol)
Allows to compute the effect of a single Dispatch

IFSelect_ShareOutResult::IFSelect_ShareOutResult	(	const Handle< IFSelect_Dispatch > &	disp,
		const Interface_Graph &	G
	)

Creates a ShareOutResult from a unique Dispatch, to work on
a Graph. As if it was a ShareOut with only one Dispatch
Allows to compute the effect of a single Dispatch

Member Function Documentation

Handle_IFSelect_Dispatch IFSelect_ShareOutResult::Dispatch

(

)

const

Returns the current Dispatch

Standard_Integer IFSelect_ShareOutResult::DispatchRank

(

)

const

Returns the Rank of the current Dispatch in the ShareOut
Returns Zero if there is none (iteration finished)

void IFSelect_ShareOutResult::Evaluate

(

)

Evaluates the result of a ShareOut : determines Entities to be
forgotten by the ShareOut, Entities to be transferred several
times (duplicated), prepares an iteration on the packets to be
produced
Called the first time anyone question is asked, or after a
call to Reset. Works by calling the method Prepare.

TCollection_AsciiString IFSelect_ShareOutResult::FileName

(

)

const

Returns the File Name which corresponds to current Packet
(computed by ShareOut)
If current Packet has no associated name (see ShareOut),
the returned value is Null

const Interface_Graph& IFSelect_ShareOutResult::Graph

(

)

const

Returns the Graph used to create theShareOutResult

Standard_Boolean IFSelect_ShareOutResult::More

(

)

Returns True if there is more packets in the current Dispatch,
else if there is more Dispatch in the ShareOut

Standard_Integer IFSelect_ShareOutResult::NbPackets

(

)

Returns the total count of produced non empty packets
(in out : calls Evaluate as necessary)

void IFSelect_ShareOutResult::Next

(

)

Passes to the next Packet in the current Dispatch, or if there
is none, to the next Dispatch in the ShareOut

void IFSelect_ShareOutResult::NextDispatch

(

)

Passes to the next Dispatch, regardless about remaining packets

Interface_EntityIterator IFSelect_ShareOutResult::PacketContent

(

)

Returns the complete content of the current Packet (i.e.
with shared entities, which will also be put in the file)

Interface_EntityIterator IFSelect_ShareOutResult::PacketRoot

(

)

Returns the list of Roots of the current Packet (never empty)
(i.e. the Entities to be themselves asked for transfer)
Error if there is none (iteration finished)

Handle_IFSelect_PacketList IFSelect_ShareOutResult::Packets

(

const Standard_Boolean

complete = Standard_True

)

Returns the list of recorded Packets, under two modes :

• <complete> = False, the strict definition of Packets, i.e.
  for each one, the Root Entities, to be explicitely sent
  
• <complete> = True (Default), the completely evaluated list,
  i.e. which really gives the destination of each entity :
  this mode allows to evaluate duplications
  Remark that to send packets, iteration remains preferable
  (file names are managed)
  

void IFSelect_ShareOutResult::PacketsInDispatch	(	Standard_Integer &	numpack,
		Standard_Integer &	nbpacks
	)		const

Returns Number (rank) of current Packet in current Dispatch,
and total count of Packets in current Dispatch, as arguments

void IFSelect_ShareOutResult::Prepare

(

)

 Prepares the iteration on the packets <br>
      This method is called by Evaluate, but can be called anytime <br>
      The iteration consists in taking each Dispatch of the ShareOut <br>
      beginning by the first one, compute its packets, then iterate <br>
      on these packets. Once all these packets are iterated, the <br>
      iteration passes to the next Dispatch, or stops. <br>
      For a creation from a unique Dispatch, same but with only <br>
      this Dispatch. <br>
      Each packet can be listed, or really transferred (producing <br>
      a derived Model, from which a file can be generated) <br>

Prepare sets the iteration to the first Dispatch, first Packet

void IFSelect_ShareOutResult::Reset

(

)

Erases computed data, in order to command a new Evaluation

Handle_IFSelect_ShareOut IFSelect_ShareOutResult::ShareOut

(

)

const

Returns the ShareOut used to create the ShareOutResult
if creation from a Dispatch, returns a Null Handle

Field Documentation

IFGraph_SubPartsIterator IFSelect_ShareOutResult::thedispres

protected

Interface_Graph IFSelect_ShareOutResult::thegraph

protected

---

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

• IFSelect_ShareOutResult.hxx