OCC.Core.XSControl module

XSControl module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_xscontrol.html

class SwigPyIterator(*args, **kwargs)

Bases: object

advance()

copy()

decr()

distance()

equal()

incr()

next()

previous()

property thisown

The membership flag

value()

class XSControl_ConnectedShapes(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectExplore

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

  rtype

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

  param TR

  type TR

  XSControl_TransferReader

  rtype

  None

static AdjacentEntities()

• This functions considers a shape from a transfer and performs the search function explained above

  param ashape

  type ashape

  TopoDS_Shape

  param TP

  type TP

  Transfer_TransientProcess

  param type

  type type

  TopAbs_ShapeEnum

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

static DownCast(t)

SetReader()

• Sets a TransferReader to sort entitiesit brings the TransferProcess which may change, while the TransferReader does not

  param TR

  type TR

  XSControl_TransferReader

  rtype

  None

property thisown

The membership flag

class XSControl_Controller(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

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

  param model

  type model

  Interface_InterfaceModel

  rtype

  opencascade::handle<Transfer_ActorOfTransientProcess>

ActorWrite()

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

  rtype

  opencascade::handle<Transfer_ActorOfFinderProcess>

AdaptorSession()

Return type

NCollection_DataMap<TCollection_AsciiString, opencascade::handle<Standard_Transient> >

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 If set to true, <item> will be applied to the hook list ‘send’. Else, it is not applied to any hook list. Remarkthis method is to be called at Create time, the recorded items will be used by Customise Warningif <name> conflicts, the last recorded item is kept

  param theItem

  type theItem

  Standard_Transient

  param theName

  type theName

  char *

  param toApply

  default value is Standard_False

  type toApply

  bool

  rtype

  None

AutoRecord()

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

  rtype

  None

Customise()

• Customises a WorkSession, by adding to it the recorded items (by AddSessionItem)

  param WS

  type WS

  XSControl_WorkSession

  rtype

  void

static DownCast(t)

IsModeWrite()

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

  param modetrans

  type modetrans

  int

  param shape

  default value is Standard_True

  type shape

  bool

  rtype

  bool

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)

  param modemin

  type modemin

  int

  param modemax

  type modemax

  int

  param shape

  default value is Standard_True

  type shape

  bool

  rtype

  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

  param modetrans

  type modetrans

  int

  param shape

  default value is Standard_True

  type shape

  bool

  rtype

  char *

Name()

• Returns a name, as given when initializingrsc = False (D)True Name attached to the Norm (long name) rsc = TrueName of the ressource set (i.e. short name)

  param rsc

  default value is Standard_False

  type rsc

  bool

  rtype

  char *

NewModel()

• Creates a new empty Model ready to receive data of the Norm Used to write data from Imagine to an interface file

  rtype

  opencascade::handle<Interface_InterfaceModel>

Protocol()

• Returns the Protocol attached to the Norm (from field)

  rtype

  opencascade::handle<Interface_Protocol>

RecognizeWriteShape()

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

  param shape

  type shape

  TopoDS_Shape

  param modetrans

  default value is 0

  type modetrans

  int

  rtype

  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

  param obj

  type obj

  Standard_Transient

  param modetrans

  default value is 0

  type modetrans

  int

  rtype

  bool

Record()

• Records <self> in a general dictionary under a name Error if <name> already used for another one

  param name

  type name

  char *

  rtype

  None

static Recorded()

• Returns the Controller attached to a given name Returns a Null Handle if <name> is unknown

  param name

  type name

  char *

  rtype

  opencascade::handle<XSControl_Controller>

SessionItem()

• Returns an item given its name to record in a Session If <name> is unknown, returns a Null Handle

  param theName

  type theName

  char *

  rtype

  opencascade::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

  param modemin

  type modemin

  int

  param modemax

  type modemax

  int

  param shape

  default value is Standard_True

  type shape

  bool

  rtype

  None

SetModeWriteHelp()

• Attaches a short line of help to a value of modetrans (write)

  param modetrans

  type modetrans

  int

  param help

  type help

  char *

  param shape

  default value is Standard_True

  type shape

  bool

  rtype

  None

SetNames()

• Changes names if a name is empty, the formerly set one remains RemarkDoes not call Record or AutoRecord

  param theLongName

  type theLongName

  char *

  param theShortName

  type theShortName

  char *

  rtype

  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 followsDone OK , VoidNo Result , FailFail (e.g. exception) Errorbad conditions , bad model or null model

  param shape

  type shape

  TopoDS_Shape

  param FP

  type FP

  Transfer_FinderProcess

  param model

  type model

  Interface_InterfaceModel

  param modetrans

  default value is 0

  type modetrans

  int

  rtype

  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 follows0 OK , 1 No Result , 2 Fail (e.g. exception raised) -1 bad conditions , -2 bad model or null model For type of object not recognizedshould return 1

  param obj

  type obj

  Standard_Transient

  param FP

  type FP

  Transfer_FinderProcess

  param model

  type model

  Interface_InterfaceModel

  param modetrans

  default value is 0

  type modetrans

  int

  rtype

  IFSelect_ReturnStatus

WorkLibrary()

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

  rtype

  opencascade::handle<IFSelect_WorkLibrary>

property thisown

The membership flag

class XSControl_FuncShape

Bases: object

static FileAndVar()

• 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

  param session

  type session

  XSControl_WorkSession

  param file

  type file

  char *

  param var

  type var

  char *

  param def

  type def

  char *

  param resfile

  type resfile

  TCollection_AsciiString

  param resvar

  type resvar

  TCollection_AsciiString

  rtype

  bool

static Init()

• Defines and loads all functions which work on shapes for XSControl (as ActFunc)

  rtype

  void

static MoreShapes()

• 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 namea 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

  param session

  type session

  XSControl_WorkSession

  param list

  type list

  TopTools_HSequenceOfShape

  param name

  type name

  char *

  rtype

  int

property thisown

The membership flag

class XSControl_Functions

Bases: object

static Init()

• Defines and loads all functions for XSControl (as ActFunc)

  rtype

  void

property thisown

The membership flag

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

  rtype

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

  param norm

  type norm

  char *

  rtype

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

  param WS

  type WS

  XSControl_WorkSession

  param scratch

  default value is Standard_True

  type scratch

  bool

  rtype

  None

ClearShapes()

• Clears the list of shapes that may have accumulated in calls to TransferOne or TransferRoot.C

  rtype

  None

GetStatsTransfer()

• Gives statistics about Transfer

  param list

  type list

  TColStd_HSequenceOfTransient

  param nbMapped

  type nbMapped

  int

  param nbWithResult

  type nbWithResult

  int

  param nbWithFail

  type nbWithFail

  int

  rtype

  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.

  param first

  default value is

  type first

  char *

  param second

  default value is

  type second

  char *

  rtype

  opencascade::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

  param first

  type first

  char *

  param ent

  type ent

  Standard_Transient

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

Model()

• Returns the model. It can then be consulted (header, product)

  rtype

  opencascade::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

  rtype

  int

NbShapes()

• Returns the number of shapes produced by translation.

  rtype

  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.

  rtype

  TopoDS_Shape

PrintCheckLoad()

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

  param failsonly

  type failsonly

  bool

  param mode

  type mode

  IFSelect_PrintCount

  rtype

  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.

  param failsonly

  type failsonly

  bool

  param mode

  type mode

  IFSelect_PrintCount

  rtype

  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.

  param what

  type what

  int

  param mode

  default value is 0

  type mode

  int

  rtype

  None

ReadFile()

• Loads a file and returns the read status Zero for a Model which compies with the Controller

  param filename

  type filename

  char *

  rtype

  IFSelect_ReturnStatus

RootForTransfer()

• Returns an IGES or STEP root entity for translation. The entity is identified by its rank in a list.

  param num

  default value is 1

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

SetNorm()

• Sets a specific norm to <self> Returns True if done, False if <norm> is not available

  param norm

  type norm

  char *

  rtype

  bool

SetWS()

• Sets a specific session to <self>

  param WS

  type WS

  XSControl_WorkSession

  param scratch

  default value is Standard_True

  type scratch

  bool

  rtype

  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.

  param num

  default value is 1

  type num

  int

  rtype

  TopoDS_Shape

TransferEntity()

• Translates an IGES or STEP entity in the model. true is returned if a shape is produced; otherwise, false is returned.

  param start

  type start

  Standard_Transient

  rtype

  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.

  param list

  type list

  TColStd_HSequenceOfTransient

  rtype

  int

TransferOne()

• Translates an IGES or STEP entity identified by the rank num in the model. false is returned if no shape is produced.

  param num

  type num

  int

  rtype

  bool

TransferOneRoot()

• Translates a root identified by the rank num in the model. false is returned if no shape is produced.

  param num

  default value is 1

  type num

  int

  rtype

  bool

TransferRoots()

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

  rtype

  int

WS()

• Returns the session used in <self>

  rtype

  opencascade::handle<XSControl_WorkSession>

property thisown

The membership flag

class XSControl_SelectForTransfer(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectExtract

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

  rtype

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

  param TR

  type TR

  XSControl_TransferReader

  rtype

  None

Actor()

• Returns the Actor used as precised one. Returns a Null Handle for a creation from a TransferReader without any further setting

  rtype

  opencascade::handle<Transfer_ActorOfTransientProcess>

static DownCast(t)

Reader()

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

  rtype

  opencascade::handle<XSControl_TransferReader>

SetActor()

• Sets a precise actor to sort entities This definition oversedes the creation with a TransferReader

  param act

  type act

  Transfer_ActorOfTransientProcess

  rtype

  None

SetReader()

• Sets a TransferReader to sort entitiesit brings the Actor, which may change, while the TransferReader does not

  param TR

  type TR

  XSControl_TransferReader

  rtype

  None

property thisown

The membership flag

class XSControl_SignTransferStatus(*args)

Bases: OCC.Core.IFSelect.IFSelect_Signature

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

  rtype

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

  param TR

  type TR

  XSControl_TransferReader

  rtype

  None

static DownCast(t)

Map()

• Returns the TransientProcess used as precised one Returns a Null Handle for a creation from a TransferReader without any further setting

  rtype

  opencascade::handle<Transfer_TransientProcess>

Reader()

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

  rtype

  opencascade::handle<XSControl_TransferReader>

SetMap()

• Sets a precise map to sign entities This definition oversedes the creation with a TransferReader

  param TP

  type TP

  Transfer_TransientProcess

  rtype

  None

SetReader()

• Sets a TransferReader to work

  param TR

  type TR

  XSControl_TransferReader

  rtype

  None

property thisown

The membership flag

class XSControl_TransferReader(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates a TransferReader, empty

  rtype

  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.

  rtype

  opencascade::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)

  rtype

  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

  param theEnt

  type theEnt

  Standard_Transient

  param theLevel

  default value is 0

  type theLevel

  int

  rtype

  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 Remarkresult True and check=0 will give an empty list

  param theEnt

  type theEnt

  Standard_Transient

  param WithCheck

  default value is Interface_CheckAny

  type WithCheck

  Interface_CheckStatus

  param theResult

  default value is Standard_True

  type theResult

  bool

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

Clear()

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

  param theMode

  type theMode

  int

  rtype

  None

ClearResult()

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

  param theEnt

  type theEnt

  Standard_Transient

  param theMode

  type theMode

  int

  rtype

  bool

Context()

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

  rtype

  NCollection_DataMap<TCollection_AsciiString, opencascade::handle<Standard_Transient> >

static DownCast(t)

EntitiesFromShapeList()

• Returns the list of entities from which some shapes were producedit corresponds to a loop on EntityFromShapeResult, but is optimised

  param theRes

  type theRes

  TopTools_HSequenceOfShape

  param theMode

  default value is 0

  type theMode

  int

  rtype

  opencascade::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

  param theRes

  type theRes

  Standard_Transient

  param theMode

  default value is 0

  type theMode

  int

  rtype

  opencascade::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

  param theRes

  type theRes

  TopoDS_Shape

  param theMode

  default value is 0

  type theMode

  int

  rtype

  opencascade::handle<Standard_Transient>

FileName()

• Returns actual value of file name

  rtype

  char *

FinalEntityLabel()

• Returns the label attached to an entity recorded for final, or an empty string if not recorded

  param theEnt

  type theEnt

  Standard_Transient

  rtype

  char *

FinalEntityNumber()

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

  param theEnt

  type theEnt

  Standard_Transient

  rtype

  int

FinalResult()

• Returns the final result recorded for an entity, as such

  param theEnt

  type theEnt

  Standard_Transient

  rtype

  opencascade::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

  param theName

  type theName

  char *

  param theType

  type theType

  Standard_Type

  param theCtx

  type theCtx

  Standard_Transient

  rtype

  bool

HasChecks()

• Returns True if an entity (with a final result) has checks- failsonly = Falseany kind of check message - failsonly = Truefails only Returns False if <ent> is not recorded

  param theEnt

  type theEnt

  Standard_Transient

  param FailsOnly

  type FailsOnly

  bool

  rtype

  bool

HasResult()

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

  param theEnt

  type theEnt

  Standard_Transient

  rtype

  bool

IsMarked()

• Returns True if an entity has been asked for transfert, hence it is marked, asRecorded (a computation has ran, with or without an effective result), or Skipped (case ignored)

  param theEnt

  type theEnt

  Standard_Transient

  rtype

  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 …)

  param theEnt

  type theEnt

  Standard_Transient

  rtype

  bool

IsSkipped()

• Returns True if an entity is noted as skipped

  param theEnt

  type theEnt

  Standard_Transient

  rtype

  bool

LastCheckList()

• Returns the CheckList resulting from last TransferRead i.e. from TransientProcess itself, recorded from last Clear

  rtype

  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

  param theRoots

  type theRoots

  bool

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

Model()

• Returns the currently set InterfaceModel

  rtype

  opencascade::handle<Interface_InterfaceModel>

PrintStats()

• Prints statistics on current Trace File, according <what> and <mode>. See PrintStatsProcess for details

  param theWhat

  type theWhat

  int

  param theMode

  default value is 0

  type theMode

  int

  rtype

  None

static PrintStatsOnList()

• Works as PrintStatsProcess, but displays data only on the entities which are in <list> (filter)

  param theTP

  type theTP

  Transfer_TransientProcess

  param theList

  type theList

  TColStd_HSequenceOfTransient

  param theWhat

  type theWhat

  int

  param theMode

  default value is 0

  type theMode

  int

  rtype

  void

static PrintStatsProcess()

• 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 printed0basic figures 1root results 2all recorded (roots, intermediate, checked entities) 3abnormal records 4check messages (warnings and fails) 5fail messages //! <mode> is used according <what><what> = 0<mode> is ignored <what> = 1,2,3<mode> as follows0 (D)just lists numbers of concerned entities in the model 1for each entity, gives number,label, type and result type and/or status (fail/warning…) 2for each entity, gives maximal information (i.e. checks) 3counts per type of starting entity (class type) 4counts per result type and/or status 5counts per couple (starting type / result type/status) 6idem plus gives for each item, the list of numbers of entities in the starting model //! <what> = 4,5modes relays on an enum PrintCount0 (D)ItemsByEntity (sequential list by entity) 1CountByItem 2ShortByItem (count + 5 first numbers) 3ListByItem (count + entity numbers) 4EntitiesByItem (count + entity numbers and labels)

  param theTP

  type theTP

  Transfer_TransientProcess

  param theWhat

  type theWhat

  int

  param theMode

  default value is 0

  type theMode

  int

  rtype

  void

Recognize()

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

  param theEnt

  type theEnt

  Standard_Transient

  rtype

  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

  param theEnt

  type theEnt

  Standard_Transient

  rtype

  bool

RecordedList()

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

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

ResultFromNumber()

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

  param theNum

  type theNum

  int

  rtype

  opencascade::handle<Transfer_ResultFromModel>

SetActor()

• Sets the Actor directlythis value will be used if the Controller is not set

  param theActor

  type theActor

  Transfer_ActorOfTransientProcess

  rtype

  None

SetContext()

• Sets a Contextaccording to receiving appli, to be interpreted by the Actor

  param theName

  type theName

  char *

  param theCtx

  type theCtx

  Standard_Transient

  rtype

  None

SetController()

• Sets a Controller. It is required to generate the Actor. Elsewhere, the Actor must be provided directly

  param theControl

  type theControl

  XSControl_Controller

  rtype

  None

SetFileName()

• Sets a new value for (loaded) file name

  param theName

  type theName

  char *

  rtype

  None

SetGraph()

• Sets a Graph and its InterfaceModel (calls SetModel)

  param theGraph

  type theGraph

  Interface_HGraph

  rtype

  None

SetModel()

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

  param theModel

  type theModel

  Interface_InterfaceModel

  rtype

  None

SetTransientProcess()

• Forces the TransientProcess Remarkit also changes the Model and the Actor, from those recorded in the new TransientProcess

  param theTP

  type theTP

  Transfer_TransientProcess

  rtype

  None

ShapeResult()

• Returns the resulting object as a Shape Null Shape if no result or result not a shape

  param theEnt

  type theEnt

  Standard_Transient

  rtype

  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

  param theRec

  type theRec

  bool

  rtype

  opencascade::handle<TopTools_HSequenceOfShape>

Skip()

• Note that an entity has been required for transfer but no result at all is available (typicallycase not implemented) It is not an error, but it gives a specific statusSkipped Returns True if done, False if <ent> is not in starting model

  param theEnt

  type theEnt

  Standard_Transient

  rtype

  bool

TransferClear()

• Clears the results attached to an entity if <ents> equates the starting model, clears all results

  param theEnt

  type theEnt

  Standard_Transient

  param theLevel

  default value is 0

  type theLevel

  int

  rtype

  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

  param theList

  type theList

  TColStd_HSequenceOfTransient

  param theRec

  default value is Standard_True

  type theRec

  bool

  rtype

  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

  param theEnt

  type theEnt

  Standard_Transient

  param theRec

  default value is Standard_True

  type theRec

  bool

  rtype

  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

  param theGraph

  type theGraph

  Interface_Graph

  rtype

  int

TransientProcess()

• Returns the currently used TransientProcess It is computed from the model by TransferReadRoots, or by BeginTransferRead

  rtype

  opencascade::handle<Transfer_TransientProcess>

TransientResult()

• Returns the resulting object as a Transient Null Handle if no result or result not transient

  param theEnt

  type theEnt

  Standard_Transient

  rtype

  opencascade::handle<Standard_Transient>

property thisown

The membership flag

class XSControl_TransferWriter(*args)

Bases: OCC.Core.Standard.Standard_Transient

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

  rtype

  None

CheckList()

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

  rtype

  Interface_CheckIterator

Clear()

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

  param theMode

  type theMode

  int

  rtype

  None

Controller()

• Returns the currently used Controller

  rtype

  opencascade::handle<XSControl_Controller>

static DownCast(t)

FinderProcess()

• Returns the FinderProcess itself

  rtype

  opencascade::handle<Transfer_FinderProcess>

PrintStats()

• Prints statistics on current Trace File, according what,mode See PrintStatsProcess for details

  param theWhat

  type theWhat

  int

  param theMode

  default value is 0

  type theMode

  int

  rtype

  None

RecognizeShape()

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

  param theShape

  type theShape

  TopoDS_Shape

  rtype

  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

  param theObj

  type theObj

  Standard_Transient

  rtype

  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

  param theModel

  type theModel

  Interface_InterfaceModel

  rtype

  Interface_CheckIterator

SetController()

• Sets a new Controller, also sets a new FinderProcess

  param theCtl

  type theCtl

  XSControl_Controller

  rtype

  None

SetFinderProcess()

• Sets a new FinderProcess and forgets the former one

  param theFP

  type theFP

  Transfer_FinderProcess

  rtype

  None

SetTransferMode()

• Changes the Transfer Mode

  param theMode

  type theMode

  int

  rtype

  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)

  rtype

  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

  param theModel

  type theModel

  Interface_InterfaceModel

  param theShape

  type theShape

  TopoDS_Shape

  rtype

  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

  param theModel

  type theModel

  Interface_InterfaceModel

  param theObj

  type theObj

  Standard_Transient

  rtype

  IFSelect_ReturnStatus

property thisown

The membership flag

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

  rtype

  None

AppendCStr()

Parameters

seqval –

type seqval

TColStd_HSequenceOfHAsciiString

param strval

type strval

char *

rtype

None

AppendEStr()

Parameters

seqval –

type seqval

TColStd_HSequenceOfHExtendedString

param strval

type strval

Standard_ExtString

rtype

None

AppendShape()

Parameters

seqv –

type seqv

TopTools_HSequenceOfShape

param shape

type shape

TopoDS_Shape

rtype

None

AppendTra()

Parameters

seqval –

type seqval

TColStd_HSequenceOfTransient

param traval

type traval

Standard_Transient

rtype

None

ArrToSeq()

Parameters

arr –

type arr

Standard_Transient

rtype

opencascade::handle<Standard_Transient>

AsciiToExtended()

Parameters

str –

type str

char *

rtype

Standard_ExtString

BinderShape()

• From a Transient, returns a Shape. In fact, recognizes ShapeBinder ShapeMapper and HShape

  param tr

  type tr

  Standard_Transient

  rtype

  TopoDS_Shape

CStrValue()

Parameters

list –

type list

Standard_Transient

param num

type num

int

rtype

char *

CompoundFromSeq()

• Converts a list of Shapes to a Compound (a kind of Shape)

  param seqval

  type seqval

  TopTools_HSequenceOfShape

  rtype

  TopoDS_Shape

DateString()

Parameters

yy –

type yy

int

param mm

type mm

int

param dd

type dd

int

param hh

type hh

int

param mn

type mn

int

param ss

type ss

int

rtype

char *

DateValues()

Parameters

text –

type text

char *

param yy

type yy

int

param mm

type mm

int

param dd

type dd

int

param hh

type hh

int

param mn

type mn

int

param ss

type ss

int

rtype

None

EStrValue()

Parameters

list –

type list

Standard_Transient

param num

type num

int

rtype

Standard_ExtString

ExtendedToAscii()

Parameters

str –

type str

Standard_ExtString

rtype

char *

IsAscii()

Parameters

str –

type str

Standard_ExtString

rtype

bool

IsKind()

Parameters

item –

type item

Standard_Transient

param what

type what

Standard_Type

rtype

bool

NewSeqCStr()

Return type

opencascade::handle<TColStd_HSequenceOfHAsciiString>

NewSeqEStr()

Return type

opencascade::handle<TColStd_HSequenceOfHExtendedString>

NewSeqShape()

Return type

opencascade::handle<TopTools_HSequenceOfShape>

NewSeqTra()

Return type

opencascade::handle<TColStd_HSequenceOfTransient>

SeqIntValue()

Parameters

list –

type list

TColStd_HSequenceOfInteger

param num

type num

int

rtype

int

SeqLength()

Parameters

list –

type list

Standard_Transient

rtype

int

SeqToArr()

Parameters

seq –

type seq

Standard_Transient

param first

default value is 1

type first

int

rtype

opencascade::handle<Standard_Transient>

ShapeBinder()

• Creates a Transient Object from a Shapeit 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

  param shape

  type shape

  TopoDS_Shape

  param hs

  default value is Standard_True

  type hs

  bool

  rtype

  opencascade::handle<Standard_Transient>

ShapeType()

• Returns the type of a Shapetrue 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

  param shape

  type shape

  TopoDS_Shape

  param compound

  type compound

  bool

  rtype

  TopAbs_ShapeEnum

ShapeValue()

Parameters

seqv –

type seqv

TopTools_HSequenceOfShape

param num

type num

int

rtype

TopoDS_Shape

SortedCompound()

• From a Shape, builds a Compound as followsexplores 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

  param shape

  type shape

  TopoDS_Shape

  param type

  type type

  TopAbs_ShapeEnum

  param explore

  type explore

  bool

  param compound

  type compound

  bool

  rtype

  TopoDS_Shape

ToAString()

Parameters

strcon –

type strcon

char *

rtype

TCollection_AsciiString

ToCString()

Parameters

strval –

type strval

TCollection_HAsciiString

rtype

char *:param strval:

type strval

TCollection_AsciiString

rtype

char *

ToEString()

Parameters

strval –

type strval

TCollection_HExtendedString

rtype

Standard_ExtString:param strval:

type strval

TCollection_ExtendedString

rtype

Standard_ExtString

ToHString()

Parameters

strcon –

type strcon

char *

rtype

opencascade::handle<TCollection_HAsciiString>:param strcon:

type strcon

Standard_ExtString

rtype

opencascade::handle<TCollection_HExtendedString>

ToXString()

Parameters

strcon –

type strcon

Standard_ExtString

rtype

TCollection_ExtendedString

TraValue()

Parameters

list –

type list

Standard_Transient

param num

type num

int

rtype

opencascade::handle<Standard_Transient>

TraceLine()

• Just prints a line into the current Trace File. This allows to better characterise the various trace outputs, as desired.

  param line

  type line

  char *

  rtype

  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)

  param lines

  type lines

  Standard_Transient

  rtype

  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

  param item

  type item

  Standard_Transient

  param nopk

  default value is Standard_False

  type nopk

  bool

  rtype

  char *

property thisown

The membership flag

class XSControl_Vars(*args)

Bases: OCC.Core.Standard.Standard_Transient

Return type

None

static DownCast(t)

Get()

Parameters

name –

type name

char *

rtype

opencascade::handle<Standard_Transient>

GetCurve()

Parameters

name –

type name

char *

rtype

opencascade::handle<Geom_Curve>

GetCurve2d()

Parameters

name –

type name

char *

rtype

opencascade::handle<Geom2d_Curve>

GetGeom()

Parameters

name –

type name

char *

rtype

opencascade::handle<Geom_Geometry>

GetPoint()

Parameters

name –

type name

char *

param pnt

type pnt

gp_Pnt

rtype

bool

GetPoint2d()

Parameters

name –

type name

char *

param pnt

type pnt

gp_Pnt2d

rtype

bool

GetShape()

Parameters

name –

type name

char *

rtype

TopoDS_Shape

GetSurface()

Parameters

name –

type name

char *

rtype

opencascade::handle<Geom_Surface>

Set()

Parameters

name –

type name

char *

param val

type val

Standard_Transient

rtype

void

SetPoint()

Parameters

name –

type name

char *

param val

type val

gp_Pnt

rtype

void

SetPoint2d()

Parameters

name –

type name

char *

param val

type val

gp_Pnt2d

rtype

void

SetShape()

Parameters

name –

type name

char *

param val

type val

TopoDS_Shape

rtype

void

property thisown

The membership flag

class XSControl_WorkSession(*args)

Bases: OCC.Core.IFSelect.IFSelect_WorkSession

Return type

None

ClearContext()

• Clears the whole current Context (nullifies it)

  rtype

  None

Context()

• Returns the current Context List, Null if not defined The Context is given to the TransientProcess for TransferRead

  rtype

  NCollection_DataMap<TCollection_AsciiString, opencascade::handle<Standard_Transient> >

static DownCast(t)

InitTransferReader()

• Sets a Transfer Reader, by internal ways, according mode0 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

  param theMode

  type theMode

  int

  rtype

  None

MapReader()

• Returns the TransientProcess(internal data for TransferReader)

  rtype

  opencascade::handle<Transfer_TransientProcess>

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)

  rtype

  opencascade::handle<Interface_InterfaceModel>

NormAdaptor()

• Returns the norm controller itself

  rtype

  opencascade::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)

  param theNum

  type theNum

  int

  param theWri

  type theWri

  bool

  param theS

  type theS

  Message_Messenger

  rtype

  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

  param theEnt

  type theEnt

  Standard_Transient

  param theMode

  type theMode

  int

  rtype

  opencascade::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 //! The current Profile for this Norm is taken.

  param theNormName

  type theNormName

  char *

  rtype

  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

  param theRsc

  default value is Standard_False

  type theRsc

  bool

  rtype

  char *

SetAllContext()

• Sets the current Context List, as a whole Sets it to the TransferReader

  param theContext

  type theContext

  Standard_Transient

  rtype

  None

SetController()

• Selects a Norm defined by its Controller itself

  param theCtl

  type theCtl

  XSControl_Controller

  rtype

  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

  param theTP

  type theTP

  Transfer_TransientProcess

  rtype

  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

  param theFP

  type theFP

  Transfer_FinderProcess

  rtype

  bool

SetTransferReader()

• Sets a Transfer Reader, which manages transfers on reading

  param theTR

  type theTR

  XSControl_TransferReader

  rtype

  None

SetVars()

Parameters

theVars –

type theVars

XSControl_Vars

rtype

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 Selectionits SelectionResult - <ents> a HSequenceOfTransientthis list - <ents> the Modelin this specific case, all the roots, with no cumulation of former transfers (TransferReadRoots)

  param theEnts

  type theEnts

  Standard_Transient

  rtype

  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

  rtype

  int

TransferReader()

• Returns the Transfer Reader, Null if not set

  rtype

  opencascade::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)

  rtype

  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

  param theShape

  type theShape

  TopoDS_Shape

  param theCompGraph

  default value is Standard_True

  type theCompGraph

  bool

  rtype

  IFSelect_ReturnStatus

TransferWriter()

• Returns the Transfer Reader, Null if not set

  rtype

  opencascade::handle<XSControl_TransferWriter>

Vars()

Return type

opencascade::handle<XSControl_Vars>

property thisown

The membership flag

class XSControl_Writer(*args)

Bases: object

• Creates a Writer from scratch

  rtype

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

  param norm

  type norm

  char *

  rtype

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

  param WS

  type WS

  XSControl_WorkSession

  param scratch

  default value is Standard_True

  type scratch

  bool

  rtype

  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

  param newone

  default value is Standard_False

  type newone

  bool

  rtype

  opencascade::handle<Interface_InterfaceModel>

PrintStatsTransfer()

• Prints Statistics about Transfer

  param what

  type what

  int

  param mode

  default value is 0

  type mode

  int

  rtype

  None

SetNorm()

• Sets a specific norm to <self> Returns True if done, False if <norm> is not available

  param norm

  type norm

  char *

  rtype

  bool

SetWS()

• Sets a specific session to <self>

  param WS

  type WS

  XSControl_WorkSession

  param scratch

  default value is Standard_True

  type scratch

  bool

  rtype

  None

TransferShape()

• Transfers a Shape according to the mode

  param sh

  type sh

  TopoDS_Shape

  param mode

  default value is 0

  type mode

  int

  rtype

  IFSelect_ReturnStatus

WS()

• Returns the session used in <self>

  rtype

  opencascade::handle<XSControl_WorkSession>

WriteFile()

• Writes the produced model

  param filename

  type filename

  char *

  rtype

  IFSelect_ReturnStatus

property thisown

The membership flag

class xscontrol

Bases: object

static Session()

• Returns the WorkSession of a SessionPilot, but casts it as from XSControlit then gives access to Control & Transfers

  param pilot

  type pilot

  IFSelect_SessionPilot

  rtype

  opencascade::handle<XSControl_WorkSession>

static Vars()

• Returns the Vars of a SessionPilot, it is brought by Session it provides access to external variables

  param pilot

  type pilot

  IFSelect_SessionPilot

  rtype

  opencascade::handle<XSControl_Vars>

property thisown

The membership flag