# OCC.XSControl module

class `Handle_XSControl_ConnectedShapes`(*args)

  Bases: `OCC.IFSelect.Handle_IFSelect_SelectExplore`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XSControl_Controller`(*args)

  Bases: `OCC.MMgt.Handle_MMgt_TShared`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XSControl_SelectForTransfer`(*args)

  Bases: `OCC.IFSelect.Handle_IFSelect_SelectExtract`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XSControl_SignTransferStatus`(*args)

  Bases: `OCC.IFSelect.Handle_IFSelect_Signature`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XSControl_TransferReader`(*args)

  Bases: `OCC.MMgt.Handle_MMgt_TShared`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XSControl_TransferWriter`(*args)

  Bases: `OCC.MMgt.Handle_MMgt_TShared`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_XSControl_WorkSession`(*args)

  Bases: `OCC.IFSelect.Handle_IFSelect_WorkSession`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `SwigPyIterator`(*args, **kwargs)

  Bases: `object`

  `advance`()
  `copy`()
  `decr`()
  `distance`()
  `equal`()
  `incr`()
  `next`()
  `previous`()
  `thisown`

    The membership flag

  `value`()

class `XSControl_ConnectedShapes`(*args)

  Bases: `OCC.IFSelect.IFSelect_SelectExplore`

  - Creates a Selection ConnectedShapes. It remains to be set a TransferReader

  Return type: | None

  - Creates a Selection ConnectedShapes, which will work with the current TransferProcess brought by the TransferReader

  Parameters: | TR (Handle_XSControl_TransferReader &) –
  Return type: | None

  static `AdjacentEntities`(*args)
    - This functions considers a shape from a transfer and performs the search function explained above

    Parameters: | ashape (TopoDS_Shape &) – TP (Handle_Transfer_TransientProcess &) – type (TopAbs_ShapeEnum) –
    Return type: | Handle_TColStd_HSequenceOfTransient

  `GetHandle`()
  `SetReader`()
    - Sets a TransferReader to sort entities : it brings the TransferProcess which may change, while the TransferReader does not

    Parameters: | TR (Handle_XSControl_TransferReader &) –
    Return type: | None

  `thisown`

    The membership flag

`XSControl_ConnectedShapes_AdjacentEntities`(*args)
  - This functions considers a shape from a transfer and performs the search function explained above

  Parameters: | ashape (TopoDS_Shape &) – TP (Handle_Transfer_TransientProcess &) – type (TopAbs_ShapeEnum) –
  Return type: | Handle_TColStd_HSequenceOfTransient

class `XSControl_Controller`(*args, **kwargs)

  Bases: `OCC.MMgt.MMgt_TShared`

  `ActorRead`()
    - Returns the Actor for Read attached to the pair (norm,appli) It can be adapted for data of the input Model, as required Can be read from field then adapted with Model as required

    Parameters: | model (Handle_Interface_InterfaceModel &) –
    Return type: | Handle_Transfer_ActorOfTransientProcess

  `ActorWrite`()
    - Returns the Actor for Write attached to the pair (norm,appli) Read from field. Can be redefined

    Return type: | Handle_Transfer_ActorOfFinderProcess

  `AdaptorSession`()

    Return type: | Handle_Dico_DictionaryOfTransient

  `AddControlItem`()
    - Adds an item in the control list A control item of a controller is accessed by its name which is specific of a kind of item (i.e. a kind of functionnality) Adds or replaces if <name> is already recorded

    Parameters: | item (Handle_Standard_Transient &) – name (char *) –
    Return type: | None

  `AddSessionItem`()
    - Records a Session Item, to be added for customisation of the Work Session. It must have a specific name. <setapplied> is used if <item> is a GeneralModifier, to decide to which hook list it will be applied, if not empty (else, not applied to any hook list) ACTUAL : only one hook list is managed : ‘send’ Remark : this method is to be called at Create time, the recorded items will be used by Customise Warning : if <name> conflicts, the last recorded item is kept

    Parameters: | item (Handle_Standard_Transient &) – name (char *) – setapplied (char *) – default value is
    Return type: | None

  `ApplyProfile`()
    - Applies a Configuration of the Profile to the WorkSession I.E. calls SetProfile then fills WorkSession with definitions

    Parameters: | WS (Handle_XSControl_WorkSession &) – confname (char *) –
    Return type: | bool

  `ApplyingProfile`()
    - Called by ApplyProfile, can be redefined for specific sub-class of Controller The default does nothing

    Parameters: | WS (Handle_XSControl_WorkSession &) – confname (char *) –
    Return type: | bool

  `AutoRecord`()
    - Records <self> is a general dictionary under Short and Long Names (see method Name)

    Return type: | None

  `ClusterContext`()
    - Prepares and returns a context to resolve a cluster All data to be used are detained by the WorkSession The definition of this context is free and proper to each case remark that it is aimed to be used in ResolveCluster //! The context must be prepared, but resolution must not have began //! If no cluster has to be resolved, should return a null handle This is the default case, which can be redefined

    Parameters: | WS (Handle_XSControl_WorkSession &) –
    Return type: | Handle_Standard_Transient

  `ControlItem`()
    - Returns a control item from its name, Null if <name> unknown To be used then, it just remains to be down-casted

    Parameters: | name (char *) –
    Return type: | Handle_Standard_Transient

  `Customise`()
    - Customises a WorkSession, by adding to it the recorded items (by AddSessionItem), then by calling a specific method Customising, set by default to do nothing

    Parameters: | WS (Handle_XSControl_WorkSession &) –
    Return type: | void

  `Customising`()
    - Specific customisation method, which can be redefined Default does nothing

    Parameters: | WS (Handle_XSControl_WorkSession &) –
    Return type: | None

  `DefineProfile`()
    - Considers the current state of the Controller as defining a configuration, newly created or already existing

    Parameters: | confname (char *) –
    Return type: | None

  `GetHandle`()
  `IsApplied`()
    - Returns True if <item> is recorded as <setapplied = True>

    Parameters: | item (Handle_Standard_Transient &) –
    Return type: | bool

  `IsModeWrite`()
    - Tells if a value of <modetrans> is a good value(within bounds) Actually only for shapes

    Parameters: | modetrans (int) – shape (bool) – default value is Standard_True
    Return type: | bool

  static `ListRecorded`(*args)
    - Returns the list of names of recorded norms, according to mode = 0 (D) : all the recorded names < 0 : for each distinct norm, its resource (short) name > 0 : for each distinct norm, its complete (long) name

    Parameters: | mode (int) – default value is 0
    Return type: | Handle_TColStd_HSequenceOfHAsciiString

  `ModeWriteBounds`()
    - Returns recorded min and max values for modetrans (write) Actually only for shapes Returns True if bounds are set, False else (then, free value)

    Parameters: | modemin (int &) – modemax (int &) – shape (bool) – default value is Standard_True
    Return type: | bool

  `ModeWriteHelp`()
    - Returns the help line recorded for a value of modetrans empty if help not defined or not within bounds or if values are free

    Parameters: | modetrans (int) – shape (bool) – default value is Standard_True
    Return type: | char *

  `Name`()
    - Returns a name, as given when initializing : rsc = False (D) : True Name attached to the Norm (long name) rsc = True : Name of the ressource set (i.e. short name)

    Parameters: | rsc (bool) – default value is Standard_False
    Return type: | char *

  `NewModel`()
    - Creates a new empty Model ready to receive data of the Norm Used to write data from Imagine to an interface file

    Return type: | Handle_Interface_InterfaceModel

  `Profile`()
    - Returns the Profile It starts with a first configuration Base (empty) and the following options : protocol for the Protocol sign-type for the SignType (Default Signature for Type) access for the WorkLibrary tr-read for ActorRead (import processor) tr-write for ActorWrite (export processor)

    Return type: | Handle_IFSelect_Profile

  `Protocol`()
    - Returns the Protocol attached to the Norm (from field)

    Return type: | Handle_Interface_Protocol

  `RecognizeWriteShape`()
    - Tells if a shape is valid for a transfer to a model Asks the ActorWrite (through a ShapeMapper)

    Parameters: | shape (TopoDS_Shape &) – modetrans (int) – default value is 0
    Return type: | bool

  `RecognizeWriteTransient`()
    - Tells if <obj> (an application object) is a valid candidate for a transfer to a Model. By default, asks the ActorWrite if known (through a TransientMapper). Can be redefined

    Parameters: | obj (Handle_Standard_Transient &) – modetrans (int) – default value is 0
    Return type: | bool

  `Record`()
    - Records <self> in a general dictionary under a name Error if <name> already used for another one

    Parameters: | name (char *) –
    Return type: | None

  static `Recorded`(*args)
    - Returns the Controller attached to a given name Returns a Null Handle if <name> is unknown

    Parameters: | name (char *) –
    Return type: | Handle_XSControl_Controller

  `ResolveCluster`()
    - Performs the resolution itself, from the starting data and the cluster context //! Can fill a CheckList as necessary (especially when one or more references remain unresolved) //! Default does nothing and returns an empty CheckList

    Parameters: | WS (Handle_XSControl_WorkSession &) – context (Handle_Standard_Transient &) –
    Return type: | Interface_CheckIterator

  `SessionItem`()
    - Returns an item given its name to record in a Session If <name> is unknown, returns a Null Handle

    Parameters: | name (char *) –
    Return type: | Handle_Standard_Transient

  `SetModeWrite`()
    - Sets mininum and maximum values for modetrans (write) Erases formerly recorded bounds and values Actually only for shape Then, for each value a little help can be attached

    Parameters: | modemin (int) – modemax (int) – shape (bool) – default value is Standard_True
    Return type: | None

  `SetModeWriteHelp`()
    - Attaches a short line of help to a value of modetrans (write)

    Parameters: | modetrans (int) – help (char *) – shape (bool) – default value is Standard_True
    Return type: | None

  `SetNames`()
    - Changes names if a name is empty, the formerly set one remains Remark : Does not call Record or AutoRecord

    Parameters: | longname (char *) – shortname (char *) –
    Return type: | None

  `SetProfile`()
    - Sets the Controller in a given Configuration of its Profile Calls SettingProfile (which can be redefined) //! Returns True if done, False if <confname> unknown

    Parameters: | confname (char *) –
    Return type: | bool

  `SettingProfile`()
    - This method is called by SetProfile, it can be redefined for specific sub-class of Controller The default does nothing

    Parameters: | confname (char *) –
    Return type: | bool

  `SignType`()
    - Returns the SignType attached to the norm (from field)

    Return type: | Handle_IFSelect_Signature

  `TraceStatic`()
    - Records the name of a Static to be traced for a given use

    Parameters: | name (char *) – use (int) –
    Return type: | None

  `TransferWriteShape`()
    - Takes one Shape and transfers it to an InterfaceModel (already created, e.g. by NewModel) Default uses ActorWrite; can be redefined as necessary Returned value is a status, as follows : Done OK , Void : No Result , Fail : Fail (e.g. exception) Error : bad conditions , bad model or null model Resolution of file clusters According to each norm, there can (or not) be files of which definition is not complete but refers to other files : this defines a file cluster. It can then be resolved by two calls : - ClusterContext prepares the resolution, specific of each case - ResolveCluster performs the resolution, its result consists in having all data gathered in one final model

    Parameters: | shape (TopoDS_Shape &) – FP (Handle_Transfer_FinderProcess &) – model (Handle_Interface_InterfaceModel &) – modetrans (int) – default value is 0
    Return type: | IFSelect_ReturnStatus

  `TransferWriteTransient`()
    - Takes one Transient Object and transfers it to an InterfaceModel (already created, e.g. by NewModel) (result is recorded in the model by AddWithRefs) FP records produced results and checks //! Default uses ActorWrite; can be redefined as necessary Returned value is a status, as follows : 0 OK , 1 No Result , 2 Fail (e.g. exception raised) -1 bad conditions , -2 bad model or null model For type of object not recognized : should return 1

    Parameters: | obj (Handle_Standard_Transient &) – FP (Handle_Transfer_FinderProcess &) – model (Handle_Interface_InterfaceModel &) – modetrans (int) – default value is 0
    Return type: | IFSelect_ReturnStatus

  `UpdateStatics`()
    - Updates static values <mode> precises the kind of updating : (see Items from Static) -1 : a precise static item : criter = its name 0 : all items of a family : criter = the family name 1 : all items which match regexp name : criter = regexp name By default (criter empty) should consider all relevant statics If <name> is defined, can consider only this static item The provided default method does nothing, to be redefined

    Parameters: | mode (int) – criter (char *) – default value is
    Return type: | void

  `WorkLibrary`()
    - Returns the WorkLibrary attached to the Norm. Remark that it has to be in phase with the Protocol (read from field)

    Return type: | Handle_IFSelect_WorkLibrary

  `thisown`

    The membership flag

`XSControl_Controller_ListRecorded`(*args)
  - Returns the list of names of recorded norms, according to mode = 0 (D) : all the recorded names < 0 : for each distinct norm, its resource (short) name > 0 : for each distinct norm, its complete (long) name

  Parameters: | mode (int) – default value is 0
  Return type: | Handle_TColStd_HSequenceOfHAsciiString

`XSControl_Controller_Recorded`(*args)
  - Returns the Controller attached to a given name Returns a Null Handle if <name> is unknown

  Parameters: | name (char *) –
  Return type: | Handle_XSControl_Controller

class `XSControl_FuncShape`

  Bases: `object`

  static `FileAndVar`(*args)
    - Analyses given file name and variable name, with a default name for variables. Returns resulting file name and variable name plus status ‘file to read’(True) or ‘already read’(False) In the latter case, empty resfile means no file available //! If <file> is null or empty or equates ‘.’, considers Session and returned status is False Else, returns resfile = file and status is True If <var> is neither null nor empty, resvar = var Else, the root part of <resfile> is considered, if defined Else, <def> is taken

    Parameters: | session (Handle_XSControl_WorkSession &) – file (char *) – var (char *) – def (char *) – resfile (TCollection_AsciiString &) – resvar (TCollection_AsciiString &) –
    Return type: | bool

  static `Init`(*args)
    - Defines and loads all functions which work on shapes for XSControl (as ActFunc)

    Return type: | void

  static `MoreShapes`(*args)
    - Analyses a name as designating Shapes from a Vars or from XSTEP transfer (last Transfer on Reading). <name> can be : ‘*’ : all the root shapes produced by last Transfer (Read) i.e. considers roots of the TransientProcess a name : a name of a variable DRAW //! Returns the count of designated Shapes. Their list is put in <list>. If <list> is null, it is firstly created. Then it is completed (Append without Clear) by the Shapes found Returns 0 if no Shape could be found

    Parameters: | session (Handle_XSControl_WorkSession &) – list (Handle_TopTools_HSequenceOfShape &) – name (char *) –
    Return type: | int

  `thisown`

    The membership flag

`XSControl_FuncShape_FileAndVar`(*args)
  - Analyses given file name and variable name, with a default name for variables. Returns resulting file name and variable name plus status ‘file to read’(True) or ‘already read’(False) In the latter case, empty resfile means no file available //! If <file> is null or empty or equates ‘.’, considers Session and returned status is False Else, returns resfile = file and status is True If <var> is neither null nor empty, resvar = var Else, the root part of <resfile> is considered, if defined Else, <def> is taken

  Parameters: | session (Handle_XSControl_WorkSession &) – file (char *) – var (char *) – def (char *) – resfile (TCollection_AsciiString &) – resvar (TCollection_AsciiString &) –
  Return type: | bool

`XSControl_FuncShape_Init`(*args)
  - Defines and loads all functions which work on shapes for XSControl (as ActFunc)

  Return type: | void

`XSControl_FuncShape_MoreShapes`(*args)
  - Analyses a name as designating Shapes from a Vars or from XSTEP transfer (last Transfer on Reading). <name> can be : ‘*’ : all the root shapes produced by last Transfer (Read) i.e. considers roots of the TransientProcess a name : a name of a variable DRAW //! Returns the count of designated Shapes. Their list is put in <list>. If <list> is null, it is firstly created. Then it is completed (Append without Clear) by the Shapes found Returns 0 if no Shape could be found

  Parameters: | session (Handle_XSControl_WorkSession &) – list (Handle_TopTools_HSequenceOfShape &) – name (char *) –
  Return type: | int

class `XSControl_Functions`

  Bases: `object`

  static `Init`(*args)
    - Defines and loads all functions for XSControl (as ActFunc)

    Return type: | void

  `thisown`

    The membership flag

`XSControl_Functions_Init`(*args)
  - Defines and loads all functions for XSControl (as ActFunc)

  Return type: | void

class `XSControl_Reader`(*args)

  Bases: `object`

  - Creates a Reader from scratch (creates an empty WorkSession) A WorkSession or a Controller must be provided before running

  Return type: | None

  - Creates a Reader from scratch, with a norm name which identifies a Controller

  Parameters: | norm (char *) –
  Return type: | None

  - Creates a Reader from an already existing Session, with a Controller already set Virtual destructor

  Parameters: | WS (Handle_XSControl_WorkSession &) – scratch (bool) – default value is Standard_True
  Return type: | None

  `ClearShapes`()
    - Clears the list of shapes that may have accumulated in calls to TransferOne or TransferRoot.C

    Return type: | None

  `GetStatsTransfer`()
    - Gives statistics about Transfer

    Parameters: | list (Handle_TColStd_HSequenceOfTransient &) – nbMapped (int &) – nbWithResult (int &) – nbWithFail (int &) –
    Return type: | None

  `GiveList`()
    - Returns a list of entities from the IGES or STEP file according to the following rules: - if first and second are empty strings, the whole file is selected. - if first is an entity number or label, the entity referred to is selected. - if first is a list of entity numbers/labels separated by commas, the entities referred to are selected, - if first is the name of a selection in the worksession and second is not defined, the list contains the standard output for that selection. - if first is the name of a selection and second is defined, the criterion defined by second is applied to the result of the first selection. A selection is an operator which computes a list of entities from a list given in input according to its type. If no list is specified, the selection computes its list of entities from the whole model. A selection can be: - A predefined selection (xst-transferrable-mode) - A filter based on a signature A Signature is an operator which returns a string from an entity according to its type. For example: - ‘xst-type’ (CDL) - ‘iges-level’ - ‘step-type’. For example, if you wanted to select only the advanced_faces in a STEP file you would use the following code: Example Reader.GiveList(‘xst-transferrable-roots’,’step-type(ADVANCED_FACE)’); Warning If the value given to second is incorrect, it will simply be ignored.

    Parameters: | first (char *) – default value is second (char *) – default value is
    Return type: | Handle_TColStd_HSequenceOfTransient

    - Computes a List of entities from the model as follows <first> beeing a Selection, <ent> beeing an entity or a list of entities (as a HSequenceOfTransient) : the standard result of this selection applied to this list if <first> is erroneous, a null handle is returned

    Parameters: | first (char *) – ent (Handle_Standard_Transient &) –
    Return type: | Handle_TColStd_HSequenceOfTransient

  `Model`()
    - Returns the model. It can then be consulted (header, product)

    Return type: | Handle_Interface_InterfaceModel

  `NbRootsForTransfer`()
    - Determines the list of root entities which are candidate for a transfer to a Shape, and returns the number of entities in the list

    Return type: | int

  `NbShapes`()
    - Returns the number of shapes produced by translation.

    Return type: | int

  `OneShape`()
    - Returns all of the results in a single shape which is: - a null shape if there are no results, - a shape if there is one result, - a compound containing the resulting shapes if there are more than one.

    Return type: | TopoDS_Shape

  `PrintCheckLoad`()
    - Prints the check list attached to loaded data, on the Standard Trace File (starts at cout) All messages or fails only, according to <failsonly> mode = 0 : per entity, prints messages mode = 1 : per message, just gives count of entities per check mode = 2 : also gives entity numbers

    Parameters: | failsonly (bool) – mode (IFSelect_PrintCount) –
    Return type: | None

  `PrintCheckTransfer`()
    - Displays check results for the last translation of IGES or STEP entities to Open CASCADE entities. Only fail messages are displayed if failsonly is true. All messages are displayed if failsonly is false. mode determines the contents and the order of the messages according to the terms of the IFSelect_PrintCount enumeration.

    Parameters: | failsonly (bool) – mode (IFSelect_PrintCount) –
    Return type: | None

  `PrintStatsTransfer`()
    - Displays the statistics for the last translation. what defines the kind of statistics that are displayed as follows: - 0 gives general statistics (number of translated roots, number of warnings, number of fail messages), - 1 gives root results, - 2 gives statistics for all checked entities, - 3 gives the list of translated entities, - 4 gives warning and fail messages, - 5 gives fail messages only. The use of mode depends on the value of what. If what is 0, mode is ignored. If what is 1, 2 or 3, mode defines the following: - 0 lists the numbers of IGES or STEP entities in the respective model - 1 gives the number, identifier, type and result type for each IGES or STEP entity and/or its status (fail, warning, etc.) - 2 gives maximum information for each IGES or STEP entity (i.e. checks) - 3 gives the number of entities per type of IGES or STEP entity - 4 gives the number of IGES or STEP entities per result type and/or status - 5 gives the number of pairs (IGES or STEP or result type and status) - 6 gives the number of pairs (IGES or STEP or result type and status) AND the list of entity numbers in the IGES or STEP model. If what is 4 or 5, mode defines the warning and fail messages as follows: - if mode is 0 all warnings and checks per entity are returned - if mode is 2 the list of entities per warning is returned. If mode is not set, only the list of all entities per warning is given.

    Parameters: | what (int) – mode (int) – default value is 0
    Return type: | None

  `ReadFile`()
    - Loads a file and returns the read status Zero for a Model which compies with the Controller

    Parameters: | filename (char *) –
    Return type: | IFSelect_ReturnStatus

  `RootForTransfer`()
    - Returns an IGES or STEP root entity for translation. The entity is identified by its rank in a list.

    Parameters: | num (int) – default value is 1
    Return type: | Handle_Standard_Transient

  `SetNorm`()
    - Sets a specific norm to <self> Returns True if done, False if <norm> is not available

    Parameters: | norm (char *) –
    Return type: | bool

  `SetWS`()
    - Sets a specific session to <self>

    Parameters: | WS (Handle_XSControl_WorkSession &) – scratch (bool) – default value is Standard_True
    Return type: | None

  `Shape`()
    - Returns the shape resulting from a translation and identified by the rank num. num equals 1 by default. In other words, the first shape resulting from the translation is returned.

    Parameters: | num (int) – default value is 1
    Return type: | TopoDS_Shape

  `TransferEntity`()
    - Translates an IGES or STEP entity in the model. true is returned if a shape is produced; otherwise, false is returned.

    Parameters: | start (Handle_Standard_Transient &) –
    Return type: | bool

  `TransferList`()
    - Translates a list of entities. Returns the number of IGES or STEP entities that were successfully translated. The list can be produced with GiveList. Warning - This function does not clear the existing output shapes.

    Parameters: | list (Handle_TColStd_HSequenceOfTransient &) –
    Return type: | int

  `TransferOne`()
    - Translates an IGES or STEP entity identified by the rank num in the model. false is returned if no shape is produced.

    Parameters: | num (int) –
    Return type: | bool

  `TransferOneRoot`()
    - Translates a root identified by the rank num in the model. false is returned if no shape is produced.

    Parameters: | num (int) – default value is 1
    Return type: | bool

  `TransferRoots`()
    - Translates all translatable roots and returns the number of successful translations. Warning - This function clears existing output shapes first.

    Return type: | int

  `WS`()
    - Returns the session used in <self>

    Return type: | Handle_XSControl_WorkSession

  `thisown`

    The membership flag

class `XSControl_SelectForTransfer`(*args)

  Bases: `OCC.IFSelect.IFSelect_SelectExtract`

  - Creates a SelectForTransfer, non initialised it sorts nothing, unless an Actor has been defined

  Return type: | None

  - Creates a SelectForTransfer, which will work with the currently defined Actor brought by the TransferReader

  Parameters: | TR (Handle_XSControl_TransferReader &) –
  Return type: | None

  `Actor`()
    - Returns the Actor used as precised one. Returns a Null Handle for a creation from a TransferReader without any further setting

    Return type: | Handle_Transfer_ActorOfTransientProcess

  `GetHandle`()
  `Reader`()
    - Returns the Reader (if created with a Reader) Returns a Null Handle if not created with a Reader

    Return type: | Handle_XSControl_TransferReader

  `SetActor`()
    - Sets a precise actor to sort entities This definition oversedes the creation with a TransferReader

    Parameters: | act (Handle_Transfer_ActorOfTransientProcess &) –
    Return type: | None

  `SetReader`()
    - Sets a TransferReader to sort entities : it brings the Actor, which may change, while the TransferReader does not

    Parameters: | TR (Handle_XSControl_TransferReader &) –
    Return type: | None

  `thisown`

    The membership flag

class `XSControl_SignTransferStatus`(*args)

  Bases: `OCC.IFSelect.IFSelect_Signature`

  - Creates a SignTransferStatus, not initialised it gives nothing (empty string)

  Return type: | None

  - Creates a SignTransferStatus, which will work on the current TransientProcess brought by the TransferReader (its MapReader)

  Parameters: | TR (Handle_XSControl_TransferReader &) –
  Return type: | None

  `GetHandle`()
  `Map`()
    - Returns the TransientProcess used as precised one Returns a Null Handle for a creation from a TransferReader without any further setting

    Return type: | Handle_Transfer_TransientProcess

  `Reader`()
    - Returns the Reader (if created with a Reader) Returns a Null Handle if not created with a Reader

    Return type: | Handle_XSControl_TransferReader

  `SetMap`()
    - Sets a precise map to sign entities This definition oversedes the creation with a TransferReader

    Parameters: | TP (Handle_Transfer_TransientProcess &) –
    Return type: | None

  `SetReader`()
    - Sets a TransferReader to work

    Parameters: | TR (Handle_XSControl_TransferReader &) –
    Return type: | None

  `thisown`

    The membership flag

class `XSControl_TransferReader`(*args)

  Bases: `OCC.MMgt.MMgt_TShared`

  - Creates a TransferReader, empty

  Return type: | None

  `Actor`()
    - Returns the Actor, determined by the Controller, or if this one is unknown, directly set. Once it has been defined, it can then be edited.

    Return type: | Handle_Transfer_ActorOfTransientProcess

  `BeginTransfer`()
    - Defines a new TransferProcess for reading transfer Returns True if done, False if data are not properly defined (the Model, the Actor for Read)

    Return type: | bool

  `CheckList`()
    - Returns the CheckList resulting from transferring <ent>, i.e. stored in its recorded form ResultFromModel (empty if transfer successful or not recorded …) //! If <ent> is the Model, returns the complete cumulated check-list, <level> is ignored //! If <ent> is an entity of the Model, <level> applies as follows <level> : -1 for <ent> only, LAST transfer (TransientProcess) <level> : 0 for <ent> only (D) 1 for <ent> and its immediate subtransfers, if any 2 for <ent> and subtransferts at all levels

    Parameters: | ent (Handle_Standard_Transient &) – level (int) – default value is 0
    Return type: | Interface_CheckIterator

  `CheckedList`()
    - Returns the list of starting entities to which a given check status is attached, IN FINAL RESULTS <ent> can be an entity, or the model to query all entities Below, ‘entities’ are, either <ent> plus its sub-transferred, or all the entities of the model //! <check> = -2 , all entities whatever the check (see result) <check> = -1 , entities with no fail (warning allowed) <check> = 0 , entities with no check at all <check> = 1 , entities with warning but no fail <check> = 2 , entities with fail <result> : if True, only entities with an attached result Remark : result True and check=0 will give an empty list

    Parameters: | ent (Handle_Standard_Transient &) – withcheck (Interface_CheckStatus) – default value is Interface_CheckAny result (bool) – default value is Standard_True
    Return type: | Handle_TColStd_HSequenceOfTransient

  `Clear`()
    - Clears data, according mode : -1 all 0 nothing done +1 final results +2 working data (model, context, transfer process)

    Parameters: | mode (int) –
    Return type: | None

  `ClearResult`()
    - Clears recorded result for an entity, according mode <mode> = -1 : true, complete, clearing (erasing result) <mode> >= 0 : simple ‘stripping’, see ResultFromModel, in particular, 0 for simple internal strip, 10 for all but final result, 11 for all : just label, status and filename are kept Returns True when done, False if nothing was to clear

    Parameters: | ent (Handle_Standard_Transient &) – mode (int) –
    Return type: | bool

  `Context`()
    - Returns (modifiable) the whole definition of Context Rather for internal use (ex.: preparing and setting in once)

    Return type: | Handle_Dico_DictionaryOfTransient

  `EntitiesFromShapeList`()
    - Returns the list of entities from which some shapes were produced : it corresponds to a loop on EntityFromShapeResult, but is optimised

    Parameters: | res (Handle_TopTools_HSequenceOfShape &) – mode (int) – default value is 0
    Return type: | Handle_TColStd_HSequenceOfTransient

  `EntityFromResult`()
    - Returns an entity from which a given result was produced. If <mode> = 0 (D), searches in last root transfers If <mode> = 1, searches in last (root & sub) transfers If <mode> = 2, searches in root recorded results If <mode> = 3, searches in all (root & sub) recordeds <res> can be, either a transient object (result itself) or a binder. For a binder of shape, calls EntityFromShapeResult Returns a Null Handle if <res> not recorded

    Parameters: | res (Handle_Standard_Transient &) – mode (int) – default value is 0
    Return type: | Handle_Standard_Transient

  `EntityFromShapeResult`()
    - Returns an entity from which a given shape result was produced Returns a Null Handle if <res> not recorded or not a Shape

    Parameters: | res (TopoDS_Shape &) – mode (int) – default value is 0
    Return type: | Handle_Standard_Transient

  `FileName`()
    - Returns actual value of file name

    Return type: | char *

  `FinalEntityLabel`()
    - Returns the label attached to an entity recorded for final, or an empty string if not recorded

    Parameters: | ent (Handle_Standard_Transient &) –
    Return type: | char *

  `FinalEntityNumber`()
    - Returns the number attached to the entity recorded for final, or zero if not recorded (looks in the ResultFromModel)

    Parameters: | ent (Handle_Standard_Transient &) –
    Return type: | int

  `FinalResult`()
    - Returns the final result recorded for an entity, as such

    Parameters: | ent (Handle_Standard_Transient &) –
    Return type: | Handle_Transfer_ResultFromModel

  `GetContext`()
    - Returns the Context attached to a name, if set and if it is Kind of the type, else a Null Handle Returns True if OK, False if no Context

    Parameters: | name (char *) – type (Handle_Standard_Type &) – ctx (Handle_Standard_Transient &) –
    Return type: | bool

  `GetHandle`()
  `HasChecks`()
    - Returns True if an entity (with a final result) has checks : - failsonly = False : any kind of check message - failsonly = True : fails only Returns False if <ent> is not recorded

    Parameters: | ent (Handle_Standard_Transient &) – failsonly (bool) –
    Return type: | bool

  `HasResult`()
    - Returns True if a final result is recorded AND BRINGS AN EFFECTIVE RESULT (else, it brings only fail messages)

    Parameters: | ent (Handle_Standard_Transient &) –
    Return type: | bool

  `IsMarked`()
    - Returns True if an entity has been asked for transfert, hence it is marked, as : Recorded (a computation has ran, with or without an effective result), or Skipped (case ignored)

    Parameters: | ent (Handle_Standard_Transient &) –
    Return type: | bool

  `IsRecorded`()
    - Returns True if a final result is recorded for an entity Remark that it can bring no effective result if transfer has completely failed (FinalResult brings only fail messages …)

    Parameters: | ent (Handle_Standard_Transient &) –
    Return type: | bool

  `IsSkipped`()
    - Returns True if an entity is noted as skipped

    Parameters: | ent (Handle_Standard_Transient &) –
    Return type: | bool

  `LastCheckList`()
    - Returns the CheckList resulting from last TransferRead i.e. from TransientProcess itself, recorded from last Clear

    Return type: | Interface_CheckIterator

  `LastTransferList`()
    - Returns the list of entities recorded as lastly transferred i.e. from TransientProcess itself, recorded from last Clear If <roots> is True , considers only roots of transfer If <roots> is False, considers all entities bound with result

    Parameters: | roots (bool) –
    Return type: | Handle_TColStd_HSequenceOfTransient

  `Model`()
    - Returns the currently set InterfaceModel

    Return type: | Handle_Interface_InterfaceModel

  `PrintStats`()
    - Prints statistics on current Trace File, according <what> and <mode>. See PrintStatsProcess for details

    Parameters: | what (int) – mode (int) – default value is 0
    Return type: | None

  static `PrintStatsOnList`(*args)
    - Works as PrintStatsProcess, but displays data only on the entities which are in <list> (filter)

    Parameters: | TP (Handle_Transfer_TransientProcess &) – list (Handle_TColStd_HSequenceOfTransient &) – what (int) – mode (int) – default value is 0
    Return type: | void

  static `PrintStatsProcess`(*args)
    - This routines prints statistics about a TransientProcess It can be called, by a TransferReader, or isolately Prints are done on the default trace file <what> defines what kind of statistics are to be printed : 0 : basic figures 1 : root results 2 : all recorded (roots, intermediate, checked entities) 3 : abnormal records 4 : check messages (warnings and fails) 5 : fail messages //! <mode> is used according <what> : <what> = 0 : <mode> is ignored <what> = 1,2,3 : <mode> as follows : 0 (D) : just lists numbers of concerned entities in the model 1 : for each entity, gives number,label, type and result type and/or status (fail/warning…) 2 : for each entity, gives maximal information (i.e. checks) 3 : counts per type of starting entity (class type) 4 : counts per result type and/or status 5 : counts per couple (starting type / result type/status) 6 : idem plus gives for each item, the list of numbers of entities in the starting model //! <what> = 4,5 : modes relays on an enum PrintCount : 0 (D) : ItemsByEntity (sequential list by entity) 1 : CountByItem 2 : ShortByItem (count + 5 first numbers) 3 : ListByItem (count + entity numbers) 4 : EntitiesByItem (count + entity numbers and labels)

    Parameters: | TP (Handle_Transfer_TransientProcess &) – what (int) – mode (int) – default value is 0
    Return type: | void

  `Recognize`()
    - Tells if an entity is recognized as a valid candidate for Transfer. Calls method Recognize from the Actor (if known)

    Parameters: | ent (Handle_Standard_Transient &) –
    Return type: | bool

  `RecordResult`()
    - Records a final result of transferring an entity This result is recorded as a ResultFromModel, taken from the TransientProcess Returns True if a result is available, False else

    Parameters: | ent (Handle_Standard_Transient &) –
    Return type: | bool

  `RecordedList`()
    - Returns the list of entities to which a final result is attached (i.e. processed by RecordResult)

    Return type: | Handle_TColStd_HSequenceOfTransient

  `ResultFromNumber`()
    - Returns the final result recorded for a NUMBER of entity (internal use). Null if out of range

    Parameters: | num (int) –
    Return type: | Handle_Transfer_ResultFromModel

  `SetActor`()
    - Sets the Actor directly : this value will be used if the Controller is not set

    Parameters: | actor (Handle_Transfer_ActorOfTransientProcess &) –
    Return type: | None

  `SetContext`()
    - Sets a Context : according to receiving appli, to be interpreted by the Actor

    Parameters: | name (char *) – ctx (Handle_Standard_Transient &) –
    Return type: | None

  `SetController`()
    - Sets a Controller. It is required to generate the Actor. Elsewhere, the Actor must be provided directly

    Parameters: | control (Handle_XSControl_Controller &) –
    Return type: | None

  `SetFileName`()
    - Sets a new value for (loaded) file name

    Parameters: | name (char *) –
    Return type: | None

  `SetGraph`()
    - Sets a Graph and its InterfaceModel (calls SetModel)

    Parameters: | graph (Handle_Interface_HGraph &) –
    Return type: | None

  `SetModel`()
    - Sets an InterfaceModel. This causes former results, computed from another one, to be lost (see also Clear)

    Parameters: | model (Handle_Interface_InterfaceModel &) –
    Return type: | None

  `SetTransientProcess`()
    - Forces the TransientProcess Remark : it also changes the Model and the Actor, from those recorded in the new TransientProcess

    Parameters: | TP (Handle_Transfer_TransientProcess &) –
    Return type: | None

  `ShapeResult`()
    - Returns the resulting object as a Shape Null Shape if no result or result not a shape

    Parameters: | ent (Handle_Standard_Transient &) –
    Return type: | TopoDS_Shape

  `ShapeResultList`()
    - Returns a list of result Shapes If <rec> is True , sees RecordedList If <rec> is False, sees LastTransferList (last ROOT transfers) For each one, if it is a Shape, it is cumulated to the list If no Shape is found, returns an empty Sequence

    Parameters: | rec (bool) –
    Return type: | Handle_TopTools_HSequenceOfShape

  `Skip`()
    - Note that an entity has been required for transfer but no result at all is available (typically : case not implemented) It is not an error, but it gives a specific status : Skipped Returns True if done, False if <ent> is not in starting model

    Parameters: | ent (Handle_Standard_Transient &) –
    Return type: | bool

  `TransferClear`()
    - Clears the results attached to an entity if <ents> equates the starting model, clears all results

    Parameters: | ent (Handle_Standard_Transient &) – level (int) – default value is 0
    Return type: | None

  `TransferList`()
    - Commands the transfer on reading for a list of entities to data for Imagine, using the selected Actor for Read Returns count of transferred entities, ok or with fails (0/1) If <rec> is True (D), the results are recorded by RecordResult

    Parameters: | list (Handle_TColStd_HSequenceOfTransient &) – rec (bool) – default value is Standard_True
    Return type: | int

  `TransferOne`()
    - Commands the transfer on reading for an entity to data for Imagine, using the selected Actor for Read Returns count of transferred entities, ok or with fails (0/1) If <rec> is True (D), the result is recorded by RecordResult

    Parameters: | ent (Handle_Standard_Transient &) – rec (bool) – default value is Standard_True
    Return type: | int

  `TransferRoots`()
    - Transfers the content of the current Interface Model to data handled by Imagine, starting from its Roots (determined by the Graph <G>), using the selected Actor for Read Returns the count of performed root transfers (i.e. 0 if none) or -1 if no actor is defined

    Parameters: | G (Interface_Graph &) –
    Return type: | int

  `TransientProcess`()
    - Returns the currently used TransientProcess It is computed from the model by TransferReadRoots, or by BeginTransferRead

    Return type: | Handle_Transfer_TransientProcess

  `TransientResult`()
    - Returns the resulting object as a Transient Null Handle if no result or result not transient

    Parameters: | ent (Handle_Standard_Transient &) –
    Return type: | Handle_Standard_Transient

  `thisown`

    The membership flag

`XSControl_TransferReader_PrintStatsOnList`(*args)
  - Works as PrintStatsProcess, but displays data only on the entities which are in <list> (filter)

  Parameters: | TP (Handle_Transfer_TransientProcess &) – list (Handle_TColStd_HSequenceOfTransient &) – what (int) – mode (int) – default value is 0
  Return type: | void

`XSControl_TransferReader_PrintStatsProcess`(*args)
  - This routines prints statistics about a TransientProcess It can be called, by a TransferReader, or isolately Prints are done on the default trace file <what> defines what kind of statistics are to be printed : 0 : basic figures 1 : root results 2 : all recorded (roots, intermediate, checked entities) 3 : abnormal records 4 : check messages (warnings and fails) 5 : fail messages //! <mode> is used according <what> : <what> = 0 : <mode> is ignored <what> = 1,2,3 : <mode> as follows : 0 (D) : just lists numbers of concerned entities in the model 1 : for each entity, gives number,label, type and result type and/or status (fail/warning…) 2 : for each entity, gives maximal information (i.e. checks) 3 : counts per type of starting entity (class type) 4 : counts per result type and/or status 5 : counts per couple (starting type / result type/status) 6 : idem plus gives for each item, the list of numbers of entities in the starting model //! <what> = 4,5 : modes relays on an enum PrintCount : 0 (D) : ItemsByEntity (sequential list by entity) 1 : CountByItem 2 : ShortByItem (count + 5 first numbers) 3 : ListByItem (count + entity numbers) 4 : EntitiesByItem (count + entity numbers and labels)

  Parameters: | TP (Handle_Transfer_TransientProcess &) – what (int) – mode (int) – default value is 0
  Return type: | void

class `XSControl_TransferWriter`(*args)

  Bases: `OCC.MMgt.MMgt_TShared`

  - Creates a TransferWriter, empty, ready to run with an empty FinderProcess (but no controller, etc)

  Return type: | None

  `CheckList`()
    - Returns the check-list of last transfer (write), i.e. the check-list currently recorded in the FinderProcess

    Return type: | Interface_CheckIterator

  `Clear`()
    - Clears recorded data according a mode 0 clears FinderProcess (results, checks) -1 create a new FinderProcess

    Parameters: | mode (int) –
    Return type: | None

  `Controller`()
    - Returns the currently used Controller

    Return type: | Handle_XSControl_Controller

  `FinderProcess`()
    - Returns the FinderProcess itself

    Return type: | Handle_Transfer_FinderProcess

  `GetHandle`()
  `PrintStats`()
    - Prints statistics on current Trace File, according what,mode See PrintStatsProcess for details

    Parameters: | what (int) – mode (int) – default value is 0
    Return type: | None

  static `PrintStatsProcess`(*args)
    - Forecast to print statitics about a FinderProcess

    Parameters: | TP (Handle_Transfer_FinderProcess &) – what (int) – mode (int) – default value is 0
    Return type: | void

  `RecognizeShape`()
    - Tells if a Shape is valid for a transfer to a model Asks the Controller (RecognizeWriteShape)

    Parameters: | shape (TopoDS_Shape &) –
    Return type: | bool

  `RecognizeTransient`()
    - Tells if a transient object (from an application) is a valid candidate for a transfer to a model Asks the Controller (RecognizeWriteTransient) If <obj> is a HShape, calls RecognizeShape

    Parameters: | obj (Handle_Standard_Transient &) –
    Return type: | bool

  `ResultCheckList`()
    - Returns the check-list of last transfer (write), but tries to bind to each check, the resulting entity in the model instead of keeping the original Mapper, whenever known

    Parameters: | model (Handle_Interface_InterfaceModel &) –
    Return type: | Interface_CheckIterator

  `SetController`()
    - Sets a new Controller, also sets a new FinderProcess

    Parameters: | ctl (Handle_XSControl_Controller &) –
    Return type: | None

  `SetFinderProcess`()
    - Sets a new FinderProcess and forgets the former one

    Parameters: | FP (Handle_Transfer_FinderProcess &) –
    Return type: | None

  `SetTransferMode`()
    - Changes the Transfer Mode

    Parameters: | mode (int) –
    Return type: | None

  `TransferMode`()
    - Returns the current Transfer Mode (an Integer) It will be interpreted by the Controller to run Transfers This call form could be later replaced by more specific ones (parameters suited for each norm / transfer case)

    Return type: | int

  `TransferWriteShape`()
    - Transfers a Shape from CasCade to a model of current norm, according to the last call to SetTransferMode Works by calling the Controller Returns status : =0 if OK, >0 if error during transfer, <0 if transfer badly initialised

    Parameters: | model (Handle_Interface_InterfaceModel &) – shape (TopoDS_Shape &) –
    Return type: | IFSelect_ReturnStatus

  `TransferWriteTransient`()
    - Transfers a Transient object (from an application) to a model of current norm, according to the last call to SetTransferMode Works by calling the Controller Returns status : =0 if OK, >0 if error during transfer, <0 if transfer badly initialised

    Parameters: | model (Handle_Interface_InterfaceModel &) – obj (Handle_Standard_Transient &) –
    Return type: | IFSelect_ReturnStatus

  `thisown`

    The membership flag

`XSControl_TransferWriter_PrintStatsProcess`(*args)
  - Forecast to print statitics about a FinderProcess

  Parameters: | TP (Handle_Transfer_FinderProcess &) – what (int) – mode (int) – default value is 0
  Return type: | void

class `XSControl_Utils`(*args)

  Bases: `object`

  - the only use of this, is to allow a frontal to get one distinct ‘Utils’ set per separate engine

  Return type: | None

  `AppendCStr`()

    Parameters: | seqval (Handle_TColStd_HSequenceOfHAsciiString &) – strval (char *) –
    Return type: | None

  `AppendEStr`()

    Parameters: | seqval (Handle_TColStd_HSequenceOfHExtendedString &) – strval (Standard_ExtString) –
    Return type: | None

  `AppendShape`()

    Parameters: | seqv (Handle_TopTools_HSequenceOfShape &) – shape (TopoDS_Shape &) –
    Return type: | None

  `AppendTra`()

    Parameters: | seqval (Handle_TColStd_HSequenceOfTransient &) – traval (Handle_Standard_Transient &) –
    Return type: | None

  `ArrToSeq`()

    Parameters: | arr (Handle_Standard_Transient &) –
    Return type: | Handle_Standard_Transient

  `AsciiToExtended`()

    Parameters: | str (char *) –
    Return type: | Standard_ExtString

  `BinderShape`()
    - From a Transient, returns a Shape. In fact, recognizes ShapeBinder ShapeMapper and HShape

    Parameters: | tr (Handle_Standard_Transient &) –
    Return type: | TopoDS_Shape

  `CStrValue`()

    Parameters: | list (Handle_Standard_Transient &) – num (int) –
    Return type: | char *

  `CompoundFromSeq`()
    - Converts a list of Shapes to a Compound (a kind of Shape)

    Parameters: | seqval (Handle_TopTools_HSequenceOfShape &) –
    Return type: | TopoDS_Shape

  `DateString`()

    Parameters: | yy (int) – mm (int) – dd (int) – hh (int) – mn (int) – ss (int) –
    Return type: | char *

  `DateValues`()

    Parameters: | text (char *) – yy (int &) – mm (int &) – dd (int &) – hh (int &) – mn (int &) – ss (int &) –
    Return type: | None

  `EStrValue`()

    Parameters: | list (Handle_Standard_Transient &) – num (int) –
    Return type: | Standard_ExtString

  `ExtendedToAscii`()

    Parameters: | str (Standard_ExtString) –
    Return type: | char *

  `IsAscii`()

    Parameters: | str (Standard_ExtString) –
    Return type: | bool

  `IsKind`()

    Parameters: | item (Handle_Standard_Transient &) – what (Handle_Standard_Type &) –
    Return type: | bool

  `IsNullShape`()
    - Returns True if a Shape is Null

    Parameters: | shape (TopoDS_Shape &) –
    Return type: | bool

  `NewSeqCStr`()

    Return type: | Handle_TColStd_HSequenceOfHAsciiString

  `NewSeqEStr`()

    Return type: | Handle_TColStd_HSequenceOfHExtendedString

  `NewSeqShape`()

    Return type: | Handle_TopTools_HSequenceOfShape

  `NewSeqTra`()

    Return type: | Handle_TColStd_HSequenceOfTransient

  `NewShape`()
    - Returns a new empty, undefined Shape, which can then be filled by ReadShape

    Return type: | TopoDS_Shape

  `ReadShape`()
    - Reads a Shape from the internal BRepTools form and returns it (an internal help utility) Returns True if reading has succeeded, False else

    Parameters: | shape (TopoDS_Shape &) – filename (char *) –
    Return type: | bool

  `SeqIntValue`()

    Parameters: | list (Handle_TColStd_HSequenceOfInteger &) – num (int) –
    Return type: | int

  `SeqLength`()

    Parameters: | list (Handle_Standard_Transient &) –
    Return type: | int

  `SeqToArr`()

    Parameters: | seq (Handle_Standard_Transient &) – first (int) – default value is 1
    Return type: | Handle_Standard_Transient

  `ShapeBinder`()
    - Creates a Transient Object from a Shape : it is either a Binder (used by functions which require a Transient but can process a Shape, such as viewing functions) or a HShape (according to hs) Default is a HShape

    Parameters: | shape (TopoDS_Shape &) – hs (bool) – default value is Standard_True
    Return type: | Handle_Standard_Transient

  `ShapeType`()
    - Returns the type of a Shape : true type if <compound> is False If <compound> is True and <shape> is a Compound, iterates on its items. If all are of the same type, returns this type. Else, returns COMPOUND. If it is empty, returns SHAPE For a Null Shape, returns SHAPE

    Parameters: | shape (TopoDS_Shape &) – compound (bool) –
    Return type: | TopAbs_ShapeEnum

  `ShapeValue`()

    Parameters: | seqv (Handle_TopTools_HSequenceOfShape &) – num (int) –
    Return type: | TopoDS_Shape

  `SortedCompound`()
    - From a Shape, builds a Compound as follows : explores it level by level If <explore> is False, only COMPOUND items. Else, all items Adds to the result, shapes which comply to <type> + if <type> is WIRE, considers free edges (and makes wires) + if <type> is SHELL, considers free faces (and makes shells) If <compound> is True, gathers items in compounds which correspond to starting COMPOUND,SOLID or SHELL containers, or items directly contained in a Compound

    Parameters: | shape (TopoDS_Shape &) – type (TopAbs_ShapeEnum) – explore (bool) – compound (bool) –
    Return type: | TopoDS_Shape

  `ToAString`()

    Parameters: | strcon (char *) –
    Return type: | TCollection_AsciiString

  `ToCString`()

    Parameters: | strval (TCollection_AsciiString &) – strval –
    Return type: | char *
    Return type: | char *

  `ToEString`()

    Parameters: | strval (TCollection_ExtendedString &) – strval –
    Return type: | Standard_ExtString
    Return type: | Standard_ExtString

  `ToHString`()

    Parameters: | strcon (Standard_ExtString) – strcon –
    Return type: | Handle_TCollection_HAsciiString
    Return type: | Handle_TCollection_HExtendedString

  `ToXString`()

    Parameters: | strcon (Standard_ExtString) –
    Return type: | TCollection_ExtendedString

  `TraValue`()

    Parameters: | list (Handle_Standard_Transient &) – num (int) –
    Return type: | Handle_Standard_Transient

  `TraceLine`()
    - Just prints a line into the current Trace File. This allows to better characterise the various trace outputs, as desired.

    Parameters: | line (char *) –
    Return type: | None

  `TraceLines`()
    - Just prints a line or a set of lines into the current Trace File. <lines> can be a HAscii/ExtendedString (produces a print without ending line) or a HSequence or HArray1 Of .. (one new line per item)

    Parameters: | lines (Handle_Standard_Transient &) –
    Return type: | None

  `TypeName`()
    - Returns the name of the dynamic type of an object, i.e. : If it is a Type, its Name If it is a object not a type, the Name of its DynamicType If it is Null, an empty string If <nopk> is False (D), gives complete name If <nopk> is True, returns class name without package

    Parameters: | item (Handle_Standard_Transient &) – nopk (bool) – default value is Standard_False
    Return type: | char *

  `WriteShape`()
    - Writes a Shape under the internal BRepTools form (an internal help utility) Returns True if writing has succeeded, False else

    Parameters: | shape (TopoDS_Shape &) – filename (char *) –
    Return type: | bool

  `thisown`

    The membership flag

class `XSControl_WorkSession`(*args)

  Bases: `OCC.IFSelect.IFSelect_WorkSession`

  Return type: | None

  `AdaptNorm`()
    - This method is called once a new norm has been successfully selected. It can be redefined, default does nothing

    Return type: | void

  `ClearBinders`()
    - Clears binders

    Return type: | None

  `ClearContext`()
    - Clears the whole current Context (nullifies it)

    Return type: | None

  `Context`()
    - Returns the current Context List, Null if not defined The Context is given to the TransientProcess for TransferRead

    Return type: | Handle_Dico_DictionaryOfTransient

  `Destroy`()

    Return type: | None

  `GetHandle`()
  `InitTransferReader`()
    - Sets a Transfer Reader, by internal ways, according mode : 0 recreates it clear, 1 clears it (does not recreate) 2 aligns Roots of TransientProcess from final Results 3 aligns final Results from Roots of TransientProcess 4 begins a new transfer (by BeginTransfer) 5 recreates TransferReader then begins a new transfer

    Parameters: | mode (int) –
    Return type: | None

  `MapReader`()
    - Returns the TransientProcess(internal data for TransferReader)

    Return type: | Handle_Transfer_TransientProcess

  `MapWriter`()
    - Returns the FinderProcess (internal data for TransferWriter)

    Return type: | Handle_Transfer_FinderProcess

  `ModeWriteShape`()
    - Records the current Mode to Write Shapes

    Return type: | int

  `NewModel`()
    - produces and returns a new Model well conditionned It is produced by the Norm Controller It can be Null (if this function is not implemented)

    Return type: | Handle_Interface_InterfaceModel

  `NormAdaptor`()
    - Returns the norm controller itself

    Return type: | Handle_XSControl_Controller

  `PrintTransferStatus`()
    - Prints the transfer status of a transferred item, as beeing the Mapped n0 <num>, from MapWriter if <wri> is True, or from MapReader if <wri> is False Returns True when done, False else (i.e. num out of range)

    Parameters: | num (int) – wri (bool) – S (Handle_Message_Messenger &) –
    Return type: | bool

  `Result`()
    - Returns the result attached to a starting entity If <mode> = 0, returns Final Result If <mode> = 1, considers Last Result If <mode> = 2, considers Final, else if absent, Last returns it as Transient, if result is not transient returns the Binder <mode> = 10,11,12 idem but returns the Binder itself (if it is not, e.g. Shape, returns the Binder) <mode> = 20, returns the ResultFromModel

    Parameters: | ent (Handle_Standard_Transient &) – mode (int) –
    Return type: | Handle_Standard_Transient

  `SelectNorm`()
    - Selects a Norm defined by its name. A Norm is described and handled by a Controller Returns True if done, False if <normname> is unknown //! A Profile may be set too. If no Profile is provided, the current Profile for this Norm is taken If the asked Profile is not defined for this Norm, it remains in current Profile, returned value is True

    Parameters: | normname (char *) – profile (char *) – default value is
    Return type: | bool

  `SelectProfile`()
    - Sets a Profile as current for the current Norm Returns True if done, False if <profile> is unknown for this norm //! For more infos on Profile, query the Profile of the Controller

    Parameters: | profile (char *) –
    Return type: | bool

  `SelectedNorm`()
    - Returns the name of the last Selected Norm. If none is defined, returns an empty string By default, returns the complete name of the norm If <rsc> is True, returns the short name used for resource

    Parameters: | rsc (bool) – default value is Standard_False
    Return type: | char *

  `SetAllContext`()
    - Sets the current Context List, as a whole Sets it to the TransferReader

    Parameters: | context (Handle_Dico_DictionaryOfTransient &) –
    Return type: | None

  `SetController`()
    - Selects a Norm defined by its Controller itself

    Parameters: | ctl (Handle_XSControl_Controller &) –
    Return type: | None

  `SetMapReader`()
    - Changes the Map Reader, i.e. considers that the new one defines the relevant read results (forgets the former ones) Returns True when done, False in case of bad definition, i.e. if Model from TP differs from that of Session

    Parameters: | TP (Handle_Transfer_TransientProcess &) –
    Return type: | bool

  `SetMapWriter`()
    - Changes the Map Reader, i.e. considers that the new one defines the relevant read results (forgets the former ones) Returns True when done, False if <FP> is Null

    Parameters: | FP (Handle_Transfer_FinderProcess &) –
    Return type: | bool

  `SetModeWriteShape`()
    - Sets a mode to transfer Shapes from CasCade to entities of the current norm, which interprets it (see various Controllers) This call form could be later replaced by a more general one

    Parameters: | mode (int) –
    Return type: | None

  `SetTransferReader`()
    - Sets a Transfer Reader, which manages transfers on reading

    Parameters: | TR (Handle_XSControl_TransferReader &) –
    Return type: | None

  `SetVars`()

    Parameters: | newvars (Handle_XSControl_Vars &) –
    Return type: | None

  `TransferReadOne`()
    - Commands the transfer of, either one entity, or a list I.E. calls the TransferReader after having analysed <ents> It is cumulated from the last BeginTransfer <ents> is processed by GiveList, hence : - <ents> a Selection : its SelectionResult - <ents> a HSequenceOfTransient : this list - <ents> the Model : in this specific case, all the roots, with no cumulation of former transfers (TransferReadRoots)

    Parameters: | ents (Handle_Standard_Transient &) –
    Return type: | int

  `TransferReadRoots`()
    - Commands the transfer of all the root entities of the model i.e. calls TransferRoot from the TransferReader with the Graph No cumulation with former calls to TransferReadOne

    Return type: | int

  `TransferReader`()
    - Returns the Transfer Reader, Null if not set

    Return type: | Handle_XSControl_TransferReader

  `TransferWriteCheckList`()
    - Returns the check-list of last transfer (write) It is recorded in the FinderProcess, but it must be bound with resulting entities (in the resulting file model) rather than with original objects (in fact, their mappers)

    Return type: | Interface_CheckIterator

  `TransferWriteShape`()
    - Transfers a Shape from CasCade to a model of current norm, according to the last call to SetModeWriteShape Returns status :Done if OK, Fail if error during transfer, Error if transfer badly initialised

    Parameters: | shape (TopoDS_Shape &) – compgraph (bool) – default value is Standard_True
    Return type: | IFSelect_ReturnStatus

  `TransferWriter`()
    - Returns the Transfer Reader, Null if not set

    Return type: | Handle_XSControl_TransferWriter

  `Vars`()

    Return type: | Handle_XSControl_Vars

  `thisown`

    The membership flag

class `XSControl_Writer`(*args)

  Bases: `object`

  - Creates a Writer from scratch

  Return type: | None

  - Creates a Writer from scratch, with a norm name which identifie a Controller

  Parameters: | norm (char *) –
  Return type: | None

  - Creates a Writer from an already existing Session If <scratch> is True (D), clears already recorded data

  Parameters: | WS (Handle_XSControl_WorkSession &) – scratch (bool) – default value is Standard_True
  Return type: | None

  `Model`()
    - Returns the produced model. Produces a new one if not yet done or if <newone> is True This method allows for instance to edit product or header data before writing

    Parameters: | newone (bool) – default value is Standard_False
    Return type: | Handle_Interface_InterfaceModel

  `PrintStatsTransfer`()
    - Prints Statistics about Transfer

    Parameters: | what (int) – mode (int) – default value is 0
    Return type: | None

  `SetNorm`()
    - Sets a specific norm to <self> Returns True if done, False if <norm> is not available

    Parameters: | norm (char *) –
    Return type: | bool

  `SetWS`()
    - Sets a specific session to <self>

    Parameters: | WS (Handle_XSControl_WorkSession &) – scratch (bool) – default value is Standard_True
    Return type: | None

  `TransferShape`()
    - Transfers a Shape according to the mode

    Parameters: | sh (TopoDS_Shape &) – mode (int) – default value is 0
    Return type: | IFSelect_ReturnStatus

  `WS`()
    - Returns the session used in <self>

    Return type: | Handle_XSControl_WorkSession

  `WriteFile`()
    - Writes the produced model

    Parameters: | filename (char *) –
    Return type: | IFSelect_ReturnStatus

  `thisown`

    The membership flag

`register_handle`(handle, base_object)

  Inserts the handle into the base object to prevent memory corruption in certain cases

class `xscontrol`

  Bases: `object`

  static `Session`(*args)
    - Returns the WorkSession of a SessionPilot, but casts it as from XSControl : it then gives access to Control & Transfers

    Parameters: | pilot (Handle_IFSelect_SessionPilot &) –
    Return type: | Handle_XSControl_WorkSession

  static `Vars`(*args)
    - Returns the Vars of a SessionPilot, it is brought by Session it provides access to external variables

    Parameters: | pilot (Handle_IFSelect_SessionPilot &) –
    Return type: | Handle_XSControl_Vars

  `thisown`

    The membership flag

`xscontrol_Session`(*args)
  - Returns the WorkSession of a SessionPilot, but casts it as from XSControl : it then gives access to Control & Transfers

  Parameters: | pilot (Handle_IFSelect_SessionPilot &) –
  Return type: | Handle_XSControl_WorkSession

`xscontrol_Vars`(*args)
  - Returns the Vars of a SessionPilot, it is brought by Session it provides access to external variables

  Parameters: | pilot (Handle_IFSelect_SessionPilot &) –
  Return type: | Handle_XSControl_Vars