Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Member Functions
IFSelect_ModelCopier Class Reference

This class performs the Copy operations involved by the
description of a ShareOut (evaluated by a ShareOutResult)
plus, if there are, the Modifications on the results, with
the help of Modifiers. Each Modifier can work on one or more
resulting packets, accoding its criteria : it operates on a
Model once copied and filled with the content of the packet.

Modifiers can be :
More...

#include <IFSelect_ModelCopier.hxx>

Inheritance diagram for IFSelect_ModelCopier:
Inheritance graph
[legend]

Public Member Functions

 IFSelect_ModelCopier ()
 Creates an empty ModelCopier

void SetShareOut (const Handle< IFSelect_ShareOut > &sho)
 Sets the ShareOut, which is used to define Modifiers to apply

void ClearResult ()
 Clears the list of produced Models

Standard_Boolean AddFile (const TCollection_AsciiString &filename, const Handle< Interface_InterfaceModel > &content)
 Records a new File to be sent, as a couple
(Name as AsciiString, Content as InterfaceModel)
Returns True if Done, False if <filename> is already attached
to another File

Standard_Boolean NameFile (const Standard_Integer num, const TCollection_AsciiString &filename)
 Changes the Name attached to a File which was formerly defined
by a call to AddFile
Returns True if Done, False else : if <num> out of range or if
the new <filename> is already attached to another File
Remark : Giving an empty File Name is equivalent to ClearFile

Standard_Boolean ClearFile (const Standard_Integer num)
 Clears the Name attached to a File which was formerly defined
by a call to AddFile. This Clearing can be undone by a call to
NameFile (with same <num>)
Returns True if Done, False else : if <num> is out of range

Standard_Boolean SetAppliedModifiers (const Standard_Integer num, const Handle< IFSelect_AppliedModifiers > &applied)
 Sets a list of File Modifiers to be applied on a file

Standard_Boolean ClearAppliedModifiers (const Standard_Integer num)
 Clears the list of File Modifiers to be applied on a file

Interface_CheckIterator Copy (IFSelect_ShareOutResult &eval, const Handle< IFSelect_WorkLibrary > &WL, const Handle< Interface_Protocol > &protocol)
 Performs the Copy Operations, which include the Modifications
defined by the list of Modifiers. Memorizes the result, as a
list of InterfaceModels with the corresponding FileNames
They can then be sent, by the method Send, or queried
Copy calls internal method Copying.
Returns the produced CheckList

Interface_CheckIterator SendCopied (const Handle< IFSelect_WorkLibrary > &WL, const Handle< Interface_Protocol > &protocol)
 Sends the formerly defined results (see method Copy) to files,
then clears it
Remark : A Null File Name cause file to be not produced

Interface_CheckIterator Send (IFSelect_ShareOutResult &eval, const Handle< IFSelect_WorkLibrary > &WL, const Handle< Interface_Protocol > &protocol)
 Performs the Copy Operations (which include the Modifications)
and Sends the result on files, without memorizing it.
(the memorized result is ignored : neither queried not filled)

Interface_CheckIterator SendAll (const Standard_CString filename, const Interface_Graph &G, const Handle< IFSelect_WorkLibrary > &WL, const Handle< Interface_Protocol > &protocol)
 Sends a model (defined in <G>) into one file, without managing
remaining data, already sent files, etc. Applies the Model and
File Modifiers.
Returns True if well done, False else

Interface_CheckIterator SendSelected (const Standard_CString filename, const Interface_Graph &G, const Handle< IFSelect_WorkLibrary > &WL, const Handle< Interface_Protocol > &protocol, const Interface_EntityIterator &iter)
 Sends a part of a model into one file. Model is gotten from
<G>, the part is defined in <iter>.
Remaining data are managed and can be later be worked on.
Returns True if well done, False else

void CopiedRemaining (const Interface_Graph &G, const Handle< IFSelect_WorkLibrary > &WL, Interface_CopyTool &TC, Handle< Interface_InterfaceModel > &newmod)
 Produces a Model copied from the Remaining List as <newmod>
<newmod> is a Null Handle if this list is empty
<WL> performs the copy by using <TC>
<TC> is assumed to have been defined with the starting model
same as defined by <G>.

Standard_Boolean SetRemaining (Interface_Graph &CG) const
 Updates Graph status for remaining data, for each entity :

Standard_Integer NbFiles () const
 Returns the count of Files produced, i.e. the count of Models
memorized (produced by the mmethod Copy) with their file names

TCollection_AsciiString FileName (const Standard_Integer num) const
 Returns the File Name for a file given its rank
It is empty after a call to ClearFile on same <num>

Handle_Interface_InterfaceModel FileModel (const Standard_Integer num) const
 Returns the content of a file before sending, under the form
of an InterfaceModel, given its rank

Handle_IFSelect_AppliedModifiers AppliedModifiers (const Standard_Integer num) const
 Returns the list of File Modifiers to be applied on a file
when it will be sent, as computed by CopiedModel :
If it is a null handle, no File Modifier has to be applied.

void BeginSentFiles (const Handle< IFSelect_ShareOut > &sho, const Standard_Boolean record)
 Begins a sequence of recording the really sent files
<sho> : the default file numbering is cleared
If <record> is False, clears the list and stops recording
If <record> is True, clears the list and commands recording
Creation time corresponds to "stop recording"

void AddSentFile (const Standard_CString filename)
 Adds the name of a just sent file, if BeginSentFiles
has commanded recording; else does nothing
It is called by methods SendCopied Sending

Handle_TColStd_HSequenceOfHAsciiString SentFiles () const
 Returns the list of recorded names of sent files. Can be empty
(if no file has been sent). Returns a Null Handle if
BeginSentFiles has stopped recording.

Protected Member Functions

Interface_CheckIterator Copying (IFSelect_ShareOutResult &eval, const Handle< IFSelect_WorkLibrary > &WL, const Handle< Interface_Protocol > &protocol, Interface_CopyTool &TC)
 Internal routine which does the effective Copy. It allows to
work, either with a standard CopyTool, or a specialised one
Copying itself is done by <WL> which uses a CopyTool

Interface_CheckIterator Sending (IFSelect_ShareOutResult &eval, const Handle< IFSelect_WorkLibrary > &WL, const Handle< Interface_Protocol > &protocol, Interface_CopyTool &TC)
 Internal routine which does the effective Send. It allows to
work, either with a standard CopyTool, or a specialised one

void CopiedModel (const Interface_Graph &G, const Handle< IFSelect_WorkLibrary > &WL, const Handle< Interface_Protocol > &protocol, const Interface_EntityIterator &topcopy, const TCollection_AsciiString &filename, const Standard_Integer dispnum, const Standard_Integer numod, Interface_CopyTool &TC, Handle< Interface_InterfaceModel > &newmod, Handle< IFSelect_AppliedModifiers > &applied, Interface_CheckIterator &checks) const
 Performs the Copy of a unitary Packet
Input parameters are :
<G> is the graph which defines the starting entities, it
contains the original InterfaceModel
<WL> performs the copy by using <TC>
<protocol> is the used protocol (can be usefull for Modifiers)
<topcopy> is the list of Entities which are the Roots of the
packet to be copied
<filename> is the name of the file which will receive it
<dispid> is the Identifier of the Dispatch which have produced
this packet, <numod> is the rank of the packet for this
Dispatch
<TC> is a CopyTool, which performs the copy

Returned values (as arguments) are :
<newmod> is the result of the copy, as a new InterfaceModel on
which Model Modifiers have already been applied (if there are)
<applied> determines the File Modifiers which remain to be
applied (when the file itself will be output) : for each File
Modifier recorded in <me>, <applied>'s Value is :


Detailed Description

      - Model Modifiers, inheriting from the specific class Modifier <br>
        able to run on the content of a Model (header or entities), <br>
        activated by the ModelCopier itself <br>
      - File Modifiers, inheriting directly from GeneralModifier, <br>
        intended to be activated under the control of a WorkLibrary, <br>
        once the Model has been produced (i.e. to act on output <br>
        format, or other specific file features) <br>


The Copy operations can be :


Constructor & Destructor Documentation


Member Function Documentation

Handle_IFSelect_AppliedModifiers IFSelect_ModelCopier::AppliedModifiers ( const Standard_Integer  num) const
      - Null if this Modifier has not to be applied <br>
      - an empty list if this Modifier has to be applied without <br>
        distinguishing specific entities <br>
      - a list of numbers of entities in <model> if this Modifier <br>
        concerns particularly these entities (which are the results <br>
        of copying the result of its input selection) <br>
      <checks> is the produced Check List (by Modifiers as required) <br>


Warning : File Modifiers are evaluated at the time of Copy itself
If their list is changed between this Copy and the Sending
itself of the file, these changes are ignored

Handle_Interface_InterfaceModel IFSelect_ModelCopier::FileModel ( const Standard_Integer  num) const
Handle_TColStd_HSequenceOfHAsciiString IFSelect_ModelCopier::SentFiles ( ) const
  • Entities just Sent to file or Copied (by CopiedRemaining)
    have their status set to 1
  • the other keep their former status (1 for Send/Copied,
    0 for Remaining)
    These status are computed by Copying/Sending/CopiedRemaining
    Then, SetRemaining updates graph status, and mustr be called
    just after one of these method has been called
    Returns True if done, False if remaining info if not in phase
    which the Graph (not same counts of items)

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