XSControl

Returns the WorkSession of a SessionPilot, but casts it as from XSControl : it then gives access to Control & Transfers.

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

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

Sets a TransferReader to sort entities : it brings the TransferProcess which may change, while the TransferReader does not.

Returns a text defining the criterium. "Connected Entities through produced Shapes".

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

Changes names if a name is empty, the formerly set one remains Remark : Does not call Record or AutoRecord.

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

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

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

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

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)

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

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.

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

Sets minimum 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.

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

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

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

Returns the help line recorded for a value of modetrans empty if help not defined or not within bounds or if values are free.

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.

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

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

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.

Records a Session Item, to be added for customisation of the Work Session. It must have a specific name. <setapplied> is used if is a GeneralModifier, to decide If set to true, will be applied to the hook list "send". Else, it is not applied to any hook list. 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.

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

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

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

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
If
null, it is firstly created. Then it is completed (Append without Clear) by the Shapes found Returns 0 if no Shape could be found

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 is neither null nor empty, resvar = var Else, the root part of <resfile> is considered, if defined Else, <def> is taken

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

Sets a specific session to <me>.

Returns the session used in <me>.

Loads a file and returns the read status Zero for a Model which complies with the Controller.

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

Determines the list of root entities which are candidate for a transfer to a Shape, and returns the number of entities in the list.

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

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

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

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

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.

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

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

Returns the number of shapes produced by translation.

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.

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.

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 = 0 : per entity, prints messages mode = 1 : per message, just gives count of entities per check mode = 2 : also gives entity numbers.

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.

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.

Gives statistics about Transfer.

Sets parameters for shape processing.

Returns parameters for shape processing that was set by SetParameters() method.

Sets flags defining operations to be performed on shapes.

Returns flags defining operations to be performed on shapes.

Sets a TransferReader to sort entities : it brings the Actor, which may change, while the TransferReader does not.

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

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

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

Returns True for an Entity which is recognized by the Actor, either the precised one, or the one defined by TransferReader.

Returns a text defining the criterium : "Recognized for Transfer [(current actor)]".

Sets a TransferReader to work.

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

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

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

Returns the Signature for a Transient object, as its transfer status.

Creates a TransferReader, empty.

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)

Works as PrintStatsProcess, but displays data only on the entities which are in filter).

Sets the Actor directly : this value will be used if the Controller is not set.

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.

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

Returns the currently set InterfaceModel.

Sets a Context : according to receiving appli, to be interpreted by the Actor.

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.

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

Sets a new value for (loaded) file name.

Returns actual value of file name.

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

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

Forces the TransientProcess Remark : it also changes the Model and the Actor, from those recorded in the new TransientProcess.

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.

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

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

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

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.

Returns True if an entity is noted as skipped.

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

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

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

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

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

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

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

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.

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.

Returns an entity from which a given shape result was produced Returns a Null Handle if <res> not recorded or not a Shape.

Returns the list of entities from which some shapes were produced : it corresponds to a loop on EntityFromShapeResult, but is optimised.

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

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

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

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

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.

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.

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

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.

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.

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

Returns the FinderProcess itself.

Sets a new FinderProcess and forgets the former one.

Returns the currently used Controller.

Sets a new Controller, also sets a new FinderProcess.

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

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

Changes the Transfer Mode.

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

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.

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.

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

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.

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

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

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

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.

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

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.

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

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.

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

In addition to basic ClearData, clears Transfer and Management for interactive use, for mode = 0,1,2 and over 4 Plus : mode = 5 to clear Transfers (both ways) only mode = 6 to clear enforced results mode = 7 to clear transfers, results.

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.

Selects a Norm defined by its Controller itself.

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.

Returns the norm controller itself.

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

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

Clears the whole current Context (nullifies it).

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.

Sets a Transfer Reader, which manages transfers on reading.

Returns the Transfer Reader, Null if not set.

Returns the TransientProcess(internal data for TransferReader).

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.

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.

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)

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.

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

Returns the Transfer Reader, Null if not set.

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.

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.

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

Sets a specific session to <me>.

Returns the session used in <me>.

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.

Transfers a Shape according to the mode.

Writes the produced model.

Prints Statistics about Transfer.