OCC.Core.IFSelect module

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

class IFSelect_Act(*args)

Bases: OCC.Core.IFSelect.IFSelect_Activator

• Creates an Act with a name, help and a function mode (Add or AddSet) is given when recording

  param name

  type name

  char *

  param help

  type help

  char *

  param func

  type func

  IFSelect_ActFunc

  rtype

  None

static AddFSet()

• Adds a function with its name and helpcreates an Act then records it as function for XSET (i.e. to create control item)

  param name

  type name

  char *

  param help

  type help

  char *

  param func

  type func

  IFSelect_ActFunc

  rtype

  void

static AddFunc()

• Adds a function with its name and helpcreates an Act then records it as normal function

  param name

  type name

  char *

  param help

  type help

  char *

  param func

  type func

  IFSelect_ActFunc

  rtype

  void

static DownCast(t)

static SetGroup()

• Changes the default group name for the following Acts group empty means to come back to default from Activator Also a file name can be precised (to query by getsource)

  param group

  type group

  char *

  param file

  default value is

  type file

  char *

  rtype

  void

property thisown

The membership flag

class IFSelect_Activator(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Add()

• Allows a self-definition by an Activator of the Commands it processes, call the class method Adding (mode 0)

  param number

  type number

  int

  param command

  type command

  char *

  rtype

  None

AddSet()

• Same as Add but specifies that this command is candidate for xset (creation of items, xsetnamed items; mode 1)

  param number

  type number

  int

  param command

  type command

  char *

  rtype

  None

static Adding()

• Records, in a Dictionary available for all the Activators, the command title an Activator can process, attached with its number, proper for this Activator <mode> allows to distinguish various execution modes 0: default mode; 1for xset

  param actor

  type actor

  IFSelect_Activator

  param number

  type number

  int

  param command

  type command

  char *

  param mode

  type mode

  int

  rtype

  void

static Commands()

• Returns, for a root of command title, the list of possible commands. <mode>-1 (D) for all commands if <commands> is empty -1 + commandabout a Group , >= 0 see Adding By default, it returns the whole list of known commands.

  param mode

  default value is -1

  type mode

  int

  param command

  default value is

  type command

  char *

  rtype

  opencascade::handle<TColStd_HSequenceOfAsciiString>

Do()

• Tries to execute a Command Line. <number> is the number of the command for this Activator. It Must forecast to record the result of the execution, for need of Undo-Redo Must Returns0 for a void command (not to be recorded), 1 if execution OK, -1 if command incorrect, -2 if error on execution

  param number

  type number

  int

  param pilot

  type pilot

  IFSelect_SessionPilot

  rtype

  IFSelect_ReturnStatus

static DownCast(t)

File()

Return type

char *

Group()

Return type

char *

Help()

• Sends a short help message for a given command identified by it number for this Activator (must take one line max)

  param number

  type number

  int

  rtype

  char *

static Mode()

• Returns mode recorded for a command. -1 if not found

  param command

  type command

  char *

  rtype

  int

static Remove()

• Removes a Command, if it is recorded (else, does nothing)

  param command

  type command

  char *

  rtype

  void

static Select()

• Selects, for a Command given by its title, an actor with its command number. Returns True if found, False else

  param command

  type command

  char *

  param number

  type number

  int

  param actor

  type actor

  IFSelect_Activator

  rtype

  bool

SetForGroup()

• Group and SetGroup define a ‘Group of commands’ which correspond to an Activator. Default is ‘XSTEP’ Also a file may be attached

  param group

  type group

  char *

  param file

  default value is

  type file

  char *

  rtype

  None

property thisown

The membership flag

class IFSelect_AppliedModifiers(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an AppliedModifiers, ready to record up to <nbmax> modifiers, on a model of <nbent> entities

  param nbmax

  type nbmax

  int

  param nbent

  type nbent

  int

  rtype

  None

AddModif()

• Records a modifier. By default, it is to apply on all a produced file. Further calls to AddNum will restrict this. Returns True if done, False if too many modifiers are already recorded

  param modif

  type modif

  IFSelect_GeneralModifier

  rtype

  bool

AddNum()

• Adds a number of entity of the output file to be applied on. If a sequence of AddNum is called after AddModif, this Modifier will be applied on the list of designated entities. Else, it will be applied on all the file Returns True if done, False if no modifier has yet been added

  param nument

  type nument

  int

  rtype

  bool

Count()

• Returns the count of recorded modifiers

  rtype

  int

static DownCast(t)

IsForAll()

• Returns True if the applied modifier queried by last call to Item is to be applied to all the produced file. Else, <entcount> returned by Item gives the count of entity numbers, each one is queried by ItemNum

  rtype

  bool

Item()

• Returns the description for applied modifier n0 <num>the modifier itself, and the count of entities to be applied on. If no specific list of number has been defined, returns the total count of entities of the file If this count is zero, then the modifier applies to all the file (see below). Else, the numbers are then queried by calls to ItemNum between 1 and <entcount> Returns True if OK, False if <num> is out of range

  param num

  type num

  int

  param modif

  type modif

  IFSelect_GeneralModifier

  param entcount

  type entcount

  int

  rtype

  bool

ItemList()

• Returns the list of entities to be applied on (see Item) as a HSequence (IsForAll produces the complete list of all the entity numbers of the file

  rtype

  opencascade::handle<TColStd_HSequenceOfInteger>

ItemNum()

• Returns a numero of entity to be applied on, given its rank in the list. If no list is defined (i.e. for all the file), returns <nument> itself, to give all the entities of the file Returns 0 if <nument> out of range

  param nument

  type nument

  int

  rtype

  int

property thisown

The membership flag

class IFSelect_BasicDumper(*args)

Bases: OCC.Core.IFSelect.IFSelect_SessionDumper

• Creates a BasicDumper and puts it into the Library of Dumper

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_CheckCounter(*args)

Bases: OCC.Core.IFSelect.IFSelect_SignatureList

• Creates a CheckCounter, empty ready to work

  param withlist

  default value is Standard_False

  type withlist

  bool

  rtype

  None

Analyse()

• Analyses a CheckIterator according a Model (which detains the entities for which the CheckIterator has messages), i.e. counts messages for entities If <original> is True, does not consider final messages but those before interpretation (such as inserting variablesintegers, reals, strings) If <failsonly> is True, only Fails are considered Remarkglobal messages are recorded with a Null entity

  param list

  type list

  Interface_CheckIterator

  param model

  type model

  Interface_InterfaceModel

  param original

  default value is Standard_False

  type original

  bool

  param failsonly

  default value is Standard_False

  type failsonly

  bool

  rtype

  None

static DownCast(t)

SetSignature()

• Sets a specific signature Else, the current SignType (in the model) is used

  param sign

  type sign

  MoniTool_SignText

  rtype

  None

Signature()

• Returns the Signature;

  rtype

  opencascade::handle<MoniTool_SignText>

property thisown

The membership flag

class IFSelect_ContextModif(*args)

Bases: object

• Prepares a ContextModif with these informations- the graph established from original model (target passed directly to Modifier) - the CopyTool which detains the CopyControl, which maps starting (in original) and result (in target) entities - an optional file name (for file output) //! Such a ContextModif is considered to be applied on all transferred entities (no filter active)

  param graph

  type graph

  Interface_Graph

  param TC

  type TC

  Interface_CopyTool

  param filename

  default value is

  type filename

  char *

  rtype

  None* Prepares a ContextModif with these informations : - the graph established from original model (target passed directly to Modifier) - an optional file name (for file output) Here, no CopyControl, hence all entities are considered equal as starting and result //! Such a ContextModif is considered to be applied on all transferred entities (no filter active)

  param graph

  type graph

  Interface_Graph

  param filename

  default value is

  type filename

  char *

  rtype

  None

AddCheck()

• Adds a Check to the CheckList. If it is empty, nothing is done If it concerns an Entity from the Original Model (by SetEntity) to which another Check is attached, it is merged to it. Else, it is added or merged as to GlobalCheck.

  param check

  type check

  Interface_Check

  rtype

  None

AddFail()

• Adds a Fail Message for an Entity from the original Model If <start> is not an Entity from the original model (e.g. the model itself) this message is added to Global Check.

  param start

  type start

  Standard_Transient

  param mess

  type mess

  char *

  param orig

  default value is

  type orig

  char *

  rtype

  None

AddWarning()

• Adds a Warning Message for an Entity from the original Model If <start> is not an Entity from the original model (e.g. the model itself) this message is added to Global Check.

  param start

  type start

  Standard_Transient

  param mess

  type mess

  char *

  param orig

  default value is

  type orig

  char *

  rtype

  None

CCheck()

• Returns a Check given an Entity number (in the original Model) by default a Global Check. Creates it the first time. It can then be acknowledged on the spot, in condition that the caller works by reference (‘Interface_Check& check = …’)

  param num

  default value is 0

  type num

  int

  rtype

  opencascade::handle<Interface_Check>* Returns a Check attached to an Entity from the original Model It can then be acknowledged on the spot, in condition that the caller works by reference (‘Interface_Check& check = …’)

  param start

  type start

  Standard_Transient

  rtype

  opencascade::handle<Interface_Check>

CheckList()

• Returns the complete CheckList

  rtype

  Interface_CheckIterator

Control()

• Returns the map for a direct use, if required

  rtype

  opencascade::handle<Interface_CopyControl>

FileName()

• Returns File Name (can be empty)

  rtype

  char *

HasFileName()

• Returns True if a non empty file name has been defined

  rtype

  bool

IsForAll()

• Returns True if no filter is defineda Modifier has to work on all entities of the resulting (target) model

  rtype

  bool

IsForNone()

• Returns True if Select has determined that a Modifier may not be run (filter defined and empty)

  rtype

  bool

IsSelected()

• Returns True if a starting item has been transferred and selected

  param ent

  type ent

  Standard_Transient

  rtype

  bool

IsTransferred()

• Returns True if a starting item has been transferred

  param ent

  type ent

  Standard_Transient

  rtype

  bool

More()

• Returns True until the iteration has finished

  rtype

  bool

Next()

• Advances the iteration

  rtype

  None

OriginalGraph()

• Returns the original Graph (compared to OriginalModel, it gives more query capabilitites)

  rtype

  Interface_Graph

OriginalModel()

• Returns the original model

  rtype

  opencascade::handle<Interface_InterfaceModel>

Protocol()

• Returns the Protocol (Null if not set)

  rtype

  opencascade::handle<Interface_Protocol>

Select()

• This method requires ContextModif to be applied with a filter. If a ModelModifier is defined with a Selection criterium, the result of this Selection is used as a filter- if none of its items has been transferred, the modification does not apply at all - else, the Modifier can query for what entities were selected and what are their results - if this method is not called before working, the Modifier has to work on the whole Model

  param list

  type list

  Interface_EntityIterator

  rtype

  None

SelectedCount()

• Returns the count of selected and transferred items

  rtype

  int

SelectedOriginal()

• Returns the list of original selected items. See also the iteration

  rtype

  Interface_EntityIterator

SelectedResult()

• Returns the list of resulting counterparts of selected items. See also the iteration

  rtype

  Interface_EntityIterator

SetProtocol()

• Allows to transmit a Protocol as part of a ContextModif

  param proto

  type proto

  Interface_Protocol

  rtype

  None

Start()

• Starts an iteration on selected items. It takes into account IsForAll/IsForNone, by really iterating on all selected items.

  rtype

  None

Trace()

• Traces the modification of the current entity (see above, ValueOriginal and ValueResult) for default trace level >= 2. To be called on each indivudual entity really modified <mess> is an optionnal additional message

  param mess

  default value is

  type mess

  char *

  rtype

  None

TraceModifier()

• Traces the application of a Modifier. Works with default trace File and Level. Fills the trace if default trace level is at least 1. Traces the Modifier (its Label) and its Selection if there is one (its Label). To be called after Select (because status IsForAll is printed) Worths to trace a global modification. See also Trace below

  param modif

  type modif

  IFSelect_GeneralModifier

  rtype

  None

ValueOriginal()

• Returns the current selected item in the original model

  rtype

  opencascade::handle<Standard_Transient>

ValueResult()

• Returns the result counterpart of current selected item (in the target model)

  rtype

  opencascade::handle<Standard_Transient>

property thisown

The membership flag

class IFSelect_ContextWrite(*args)

Bases: object

• Prepares a ContextWrite with these informations- the model which is to be written - the protocol to be used - the filename - an object AppliedModifiers to work. It gives a list of FileModifiers to be ran, and for each one it can give a restricted list of entities (in the model), else all the model is considered

  param model

  type model

  Interface_InterfaceModel

  param proto

  type proto

  Interface_Protocol

  param applieds

  type applieds

  IFSelect_AppliedModifiers

  param filename

  type filename

  char *

  rtype

  None* Same as above but with an already computed Graph

  param hgraph

  type hgraph

  Interface_HGraph

  param proto

  type proto

  Interface_Protocol

  param applieds

  type applieds

  IFSelect_AppliedModifiers

  param filename

  type filename

  char *

  rtype

  None

AddCheck()

• Adds a Check to the CheckList. If it is empty, nothing is done If it concerns an Entity from the Model (by SetEntity) to which another Check is attached, it is merged to it. Else, it is added or merged as to GlobalCheck.

  param check

  type check

  Interface_Check

  rtype

  None

AddFail()

• Adds a Fail Message for an Entity from the Model If <start> is not an Entity from the model (e.g. the model itself) this message is added to Global Check.

  param start

  type start

  Standard_Transient

  param mess

  type mess

  char *

  param orig

  default value is

  type orig

  char *

  rtype

  None

AddWarning()

• Adds a Warning Message for an Entity from the Model If <start> is not an Entity from the model (e.g. the model itself) this message is added to Global Check.

  param start

  type start

  Standard_Transient

  param mess

  type mess

  char *

  param orig

  default value is

  type orig

  char *

  rtype

  None

AppliedModifiers()

• Returns the object AppliedModifiers

  rtype

  opencascade::handle<IFSelect_AppliedModifiers>

CCheck()

• Returns a Check given an Entity number (in the Model) by default a Global Check. Creates it the first time. It can then be acknowledged on the spot, in condition that the caller works by reference (‘Interface_Check& check = …’)

  param num

  default value is 0

  type num

  int

  rtype

  opencascade::handle<Interface_Check>* Returns a Check attached to an Entity from the Model It can then be acknowledged on the spot, in condition that the caller works by reference (‘Interface_Check& check = …’)

  param start

  type start

  Standard_Transient

  rtype

  opencascade::handle<Interface_Check>

CheckList()

• Returns the complete CheckList

  rtype

  Interface_CheckIterator

FileModifier()

• Returns the currently active File Modifier. Cast to be done Null if not properly setmust be test IsNull after casting

  rtype

  opencascade::handle<IFSelect_GeneralModifier>

FileName()

• Returns the File Name

  rtype

  char *

Graph()

• Returns the Graph, either given when created, else created the first time it is queried

  rtype

  Interface_Graph

IsForAll()

• Returns True if the current modifier is to be applied to the whole model. Else, a restricted list of selected entities is defined, it can be exploited by the File Modifier

  rtype

  bool

IsForNone()

• Returns True if no modifier is currently set

  rtype

  bool

Model()

• Returns the Model

  rtype

  opencascade::handle<Interface_InterfaceModel>

More()

• Returns True until the iteration has finished

  rtype

  bool

NbEntities()

• Returns the total count of selected entities

  rtype

  int

NbModifiers()

• Returns the count of recorded File Modifiers

  rtype

  int

Next()

• Advances the iteration

  rtype

  None

Protocol()

• Returns the Protocol;

  rtype

  opencascade::handle<Interface_Protocol>

SetModifier()

• Sets active the File Modifier n0 <numod> Then, it prepares the list of entities to consider, if any Returns False if <numod> out of range

  param numod

  type numod

  int

  rtype

  bool

Start()

• Starts an iteration on selected items. It takes into account IsForAll/IsForNone, by really iterating on all selected items.

  rtype

  None

Value()

• Returns the current selected entity in the model

  rtype

  opencascade::handle<Standard_Transient>

property thisown

The membership flag

class IFSelect_DispGlobal(*args)

Bases: OCC.Core.IFSelect.IFSelect_Dispatch

• Creates a DispGlobal

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_DispPerCount(*args)

Bases: OCC.Core.IFSelect.IFSelect_Dispatch

• Creates a DispPerCount with no Count (default value 1)

  rtype

  None

Count()

• Returns the Count Parameter used for splitting

  rtype

  opencascade::handle<IFSelect_IntParam>

CountValue()

• Returns the effective value of the count parameter (if Count Parameter not Set or value not positive, returns 1)

  rtype

  int

static DownCast(t)

SetCount()

• Sets a new Parameter for Count

  param count

  type count

  IFSelect_IntParam

  rtype

  None

property thisown

The membership flag

class IFSelect_DispPerFiles(*args)

Bases: OCC.Core.IFSelect.IFSelect_Dispatch

• Creates a DispPerFiles with no Count (default value 1 file)

  rtype

  None

Count()

• Returns the Count Parameter used for splitting

  rtype

  opencascade::handle<IFSelect_IntParam>

CountValue()

• Returns the effective value of the count parameter (if Count Parameter not Set or value not positive, returns 1)

  rtype

  int

static DownCast(t)

SetCount()

• Sets a new Parameter for Count

  param count

  type count

  IFSelect_IntParam

  rtype

  None

property thisown

The membership flag

class IFSelect_DispPerOne(*args)

Bases: OCC.Core.IFSelect.IFSelect_Dispatch

• Creates a DispPerOne

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_DispPerSignature(*args)

Bases: OCC.Core.IFSelect.IFSelect_Dispatch

• Creates a DispPerSignature with no SignCounter (by default, produces only one packet)

  rtype

  None

static DownCast(t)

SetSignCounter()

• Sets a SignCounter for sort Remarkit is set to record lists of entities, not only counts

  param sign

  type sign

  IFSelect_SignCounter

  rtype

  None

SignCounter()

• Returns the SignCounter used for splitting

  rtype

  opencascade::handle<IFSelect_SignCounter>

SignName()

• Returns the name of the SignCounter, which caracterises the sorting criterium for this Dispatch

  rtype

  char *

property thisown

The membership flag

class IFSelect_Dispatch(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

CanHaveRemainder()

• Returns True if a Dispatch can have a Remainder, i.e. if its criterium can let entities apart. It is a potential answer, remainder can be empty at run-time even if answer is True. (to attach a RemainderFromDispatch Selection is not allowed if answer is True). Default answer given here is False (can be redefined)

  rtype

  bool

static DownCast(t)

FinalSelection()

• Returns the Final Selection of a Dispatch we ‘d likeC++return const &

  rtype

  opencascade::handle<IFSelect_Selection>

GetEntities()

• Gets Unique Root Entities from the Final Selection, given an input Graph This the starting step for an Evaluation (Packets - Remainder)

  param G

  type G

  Interface_Graph

  rtype

  Interface_EntityIterator

HasRootName()

• Returns True if a specific Root Name has been set (else, the Default Root Name has to be used)

  rtype

  bool

Label()

• Returns a text which defines the way a Dispatch produces packets (which will become files) from its Input

  rtype

  TCollection_AsciiString

LimitedMax()

• Returns True if a Dispatch generates a count of Packets always less than or equal to a maximum valueit can be computed from the total count of Entities to be dispatched<nbent>. If answer is False, no limited maximum is expected for account If answer is True, expected maximum is given in argument <max> Default answer given here is False (can be redefined)

  param nbent

  type nbent

  int

  param max

  type max

  int

  rtype

  bool

Packeted()

• Returns the list of all Input Entities (see GetEntities) which are put in a Packet. That is, Entities listed in GetEntities but not in Remainder (see below). Input is given as a Graph.

  param G

  type G

  Interface_Graph

  rtype

  Interface_EntityIterator

Packets()

• Returns the list of produced Packets into argument <pack>. Each Packet corresponds to a Part, the Entities listed are the Roots given by the Selection. Input is given as a Graph. Thus, to create a file from a packet, it suffices to take the entities listed in a Part of Packets (that is, a Packet) without worrying about Shared entities This method can raise an Exception if data are not coherent

  param G

  type G

  Interface_Graph

  param packs

  type packs

  IFGraph_SubPartsIterator

  rtype

  void

Remainder()

• Returns Remainder which is a set of Entities. Can be empty. Default evaluation is empty (has to be redefined if CanHaveRemainder is redefined to return True).

  param G

  type G

  Interface_Graph

  rtype

  Interface_EntityIterator

RootName()

• Returns the Root Name for files produced by this dispatch It is empty if it has not been set or if it has been reset

  rtype

  opencascade::handle<TCollection_HAsciiString>

Selections()

• Returns the complete list of source Selections (starting from FinalSelection)

  rtype

  IFSelect_SelectionIterator

SetFinalSelection()

• Stores (or Changes) the Final Selection for a Dispatch

  param sel

  type sel

  IFSelect_Selection

  rtype

  None

SetRootName()

• Sets a Root Name as an HAsciiString To reset it, give a Null Handle (then, a ShareOut will have to define the Default Root Name)

  param name

  type name

  TCollection_HAsciiString

  rtype

  None

property thisown

The membership flag

class IFSelect_EditForm(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates a complete EditForm from an Editor A specific Label can be given

  param editor

  type editor

  IFSelect_Editor

  param readonly

  type readonly

  bool

  param undoable

  type undoable

  bool

  param label

  default value is

  type label

  char *

  rtype

  None* Creates an extracted EditForm from an Editor, limited to the values identified in <nums> A specific Label can be given

  param editor

  type editor

  IFSelect_Editor

  param nums

  type nums

  TColStd_SequenceOfInteger

  param readonly

  type readonly

  bool

  param undoable

  type undoable

  bool

  param label

  default value is

  type label

  char *

  rtype

  None

Apply()

• Applies modifications to own data Calls ApplyData then Clears Status according EditKeepStatus

  rtype

  bool

ApplyData()

• Applies modifications to data Default uses Editor. Can be redefined

  param ent

  type ent

  Standard_Transient

  param model

  type model

  Interface_InterfaceModel

  rtype

  bool

ClearData()

Return type

None

ClearEdit()

• Clears modification statusby default all, or one by its numbers (in the Editor)

  param num

  default value is 0

  type num

  int

  rtype

  None

static DownCast(t)

EditedList()

• Returns the Edited Value as a list If IsModified is False, returns OriginalValue Null with IsModified Truemeans that this value is not defined or has been removed For a single parameter, gives a Null Handle

  param num

  type num

  int

  rtype

  opencascade::handle<TColStd_HSequenceOfHAsciiString>

EditedValue()

• Returns the Edited (i.e. Modified) Value (string for single) <num> reports to the EditForm If IsModified is False, returns OriginalValue Null with IsModified Truemeans that this value is not defined or has been removed It is for a single parameter. For a list, gives a Null Handle

  param num

  type num

  int

  rtype

  opencascade::handle<TCollection_HAsciiString>

Editor()

Return type

opencascade::handle<IFSelect_Editor>

Entity()

Return type

opencascade::handle<Standard_Transient>

GetEditKeepStatus(IFSelect_EditForm self) → Standard_Boolean

IsComplete()

• Tells if an EditForm is complete or is an extract from Editor

  rtype

  bool

IsLoaded()

• Tells if the EditForm is loaded now

  rtype

  bool

IsModified()

• Tells if a Value (of the EditForm) is modified (directly or through touching by Update)

  param num

  type num

  int

  rtype

  bool

IsTouched()

• Tells if a Value (of the EditForm) has been touched, i.e. not modified directly but by the modification of another one (by method Update from the Editor)

  param num

  type num

  int

  rtype

  bool

Label()

Return type

char *

ListEditor()

• Returns a ListEditor to edit the parameter <num> of the EditForm, if it is a List The Editor created it (by ListEditor) then loads it (by ListValue) For a single parameter, returns a Null Handle …

  param num

  type num

  int

  rtype

  opencascade::handle<IFSelect_ListEditor>

LoadData()

• Loads modifications to data Default uses Editor. Can be redefined Remark that <ent> and/or <model> may be null, according to the kind of Editor. Shortcuts are available for these cases, but they finally call LoadData (hence, just ignore non-used args)

  param ent

  type ent

  Standard_Transient

  param model

  type model

  Interface_InterfaceModel

  rtype

  bool* Shortcut when both <ent> and <model> are not used (when the Editor works on fully static or global data)

  rtype

  bool

LoadDefault()

• For a read-write undoable EditForm, loads original values from defaults stored in the Editor

  rtype

  None

LoadEntity()

• Shortcut for LoadData when <model> is not used

  param ent

  type ent

  Standard_Transient

  rtype

  bool

LoadList()

• Loads an original value as a list. Called by the Editor only

  param num

  type num

  int

  param list

  type list

  TColStd_HSequenceOfHAsciiString

  rtype

  None

LoadModel()

• Shortcut for LoadData when only the model is concerned

  param model

  type model

  Interface_InterfaceModel

  rtype

  bool

LoadValue()

• Loads an original value (single). Called by the Editor only

  param num

  type num

  int

  param val

  type val

  TCollection_HAsciiString

  rtype

  None

Model()

Return type

opencascade::handle<Interface_InterfaceModel>

Modify()

• Gives a new value for the item <num> of the EditForm, if it is a single parameter (for a list, just returns False) Null means to Remove it <enforce> True to overpass Protected or Computed Access Mode Calls the method Update from the Editor, which can touch other parameters (see NbTouched) Returns True if well recorded, False if this value is not allowed WarningDoes not apply immediatelywill be applied by the method Apply

  param num

  type num

  int

  param newval

  type newval

  TCollection_HAsciiString

  param enforce

  default value is Standard_False

  type enforce

  bool

  rtype

  bool

ModifyList()

• Changes the value of an item of the EditForm, if it is a List (else, just returns False) The ListEditor contains the edited values of the list If no edition was recorded, just returns False Calls the method Update from the Editor, which can touch other parameters (see NbTouched) Returns True if well recorded, False if this value is not allowed WarningDoes not apply immediatelywill be applied by the method Apply

  param num

  type num

  int

  param edited

  type edited

  IFSelect_ListEditor

  param enforce

  default value is Standard_False

  type enforce

  bool

  rtype

  bool

ModifyListValue()

• As ModifyList but the new value is given as such Creates a ListEditor, Loads it, then calls ModifyList

  param num

  type num

  int

  param list

  type list

  TColStd_HSequenceOfHAsciiString

  param enforce

  default value is Standard_False

  type enforce

  bool

  rtype

  bool

NameNumber()

• Returns the Value Number in the Editor for a given Name i.e. the true ValueNumber which can be used in various methods of EditForm If it is not complete, for a recorded (in the Editor) but non-loaded name, returns negative value (- number)

  param name

  type name

  char *

  rtype

  int

NameRank()

• Returns the Rank of Value in the EditForm for a given Name i.e. if it is not complete, for a recorded (in the Editor) but non-loaded name, returns 0

  param name

  type name

  char *

  rtype

  int

NbValues()

• Returns the count of values <editable> Truecount of editable values, i.e. For a complete EditForm, it is given by the Editor Else, it is the length of the extraction map <editable> Falseall the values from the Editor

  param editable

  type editable

  bool

  rtype

  int

NumberFromRank()

• Returns the Value Number in the Editor from a given Rank in the EditForm For a complete EditForm, both are equal Else, it is given by the extraction map Returns 0 if <rank> exceeds the count of editable values,

  param rank

  type rank

  int

  rtype

  int

OriginalList()

• Returns an original value, as a list <num> is for the EditForm, not the Editor For a single parameter, gives a Null Handle

  param num

  type num

  int

  rtype

  opencascade::handle<TColStd_HSequenceOfHAsciiString>

OriginalValue()

• From an edited value, returns its … value (original one) Null means that this value is not defined <num> is for the EditForm, not the Editor It is for a single parameter. For a list, gives a Null Handle

  param num

  type num

  int

  rtype

  opencascade::handle<TCollection_HAsciiString>

PrintDefs()

• Prints Definitions, relative to the Editor

  param S

  type S

  Message_Messenger

  rtype

  None

PrintValues()

• Prints Values, according to what and alsolist <names> Trueprints Long Names; Falseprints Short Names <what> < 0prints Original Values (+ flag Modified) <what> > 0prints Final Values (+flag Modified) <what> = 0prints Modified Values (Original + Edited) <alsolist> False (D)lists are printed only as their count <alsolist> Truelists are printed for all their items

  param S

  type S

  Message_Messenger

  param what

  type what

  int

  param names

  type names

  bool

  param alsolist

  default value is Standard_False

  type alsolist

  bool

  rtype

  None

RankFromNumber()

• Returns the Rank in the EditForm from a given Number of Value for the Editor For a complete EditForm, both are equal Else, it is given by the extraction map Returns 0 if <number> is not forecast to be edited, or is out of range

  param number

  type number

  int

  rtype

  int

Recognize()

• Tells if this EditForm can work with its Editor and its actual Data (Entity and Model) Default uses Editor. Can be redefined

  rtype

  bool

SetData()

Parameters

ent –

type ent

Standard_Transient

param model

type model

Interface_InterfaceModel

rtype

None

SetEditKeepStatus(IFSelect_EditForm self, Standard_Boolean value)

SetEntity()

Parameters

ent –

type ent

Standard_Transient

rtype

None

SetModel()

Parameters

model –

type model

Interface_InterfaceModel

rtype

None

TouchList()

• Acts as Touch but for a list Does not work (returns False) if <num> is for a single param

  param num

  type num

  int

  param newlist

  type newlist

  TColStd_HSequenceOfHAsciiString

  rtype

  bool

Undo()

• For an undoable EditForm, Applies … origibal values ! and clears modified ones Can be run only once

  rtype

  bool

property thisown

The membership flag

class IFSelect_Editor(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Apply()

• Applies modified values of the EditForm with some data Remark: <ent> may be Null, this means all <model> is concerned Also <model> may be Null, if no context applies for <ent> And both <ent> and <model> may be Null, for a full static editor

  param form

  type form

  IFSelect_EditForm

  param ent

  type ent

  Standard_Transient

  param model

  type model

  Interface_InterfaceModel

  rtype

  bool

static DownCast(t)

EditMode()

• Returns the edit mode of a Value

  param num

  type num

  int

  rtype

  IFSelect_EditValue

Form()

• Builds and Returns an EditForm, empty (no data yet) Can be redefined to return a specific type of EditForm

  param readonly

  type readonly

  bool

  param undoable

  default value is Standard_True

  type undoable

  bool

  rtype

  opencascade::handle<IFSelect_EditForm>

IsList()

• Tells if a parameter is a list

  param num

  type num

  int

  rtype

  bool

Label()

• Returns the specific label

  rtype

  TCollection_AsciiString

ListEditor()

• Returns a ListEditor for a parameter which is a List Default returns a basic ListEditor for a List, a Null Handle if <num> is not for a List. Can be redefined

  param num

  type num

  int

  rtype

  opencascade::handle<IFSelect_ListEditor>

ListValue()

• Returns the value of an EditForm as a List, for a given item If not a list, a Null Handle should be returned Default returns a Null Handle, because many Editors have no list to edit. To be redefined as required

  param form

  type form

  IFSelect_EditForm

  param num

  type num

  int

  rtype

  opencascade::handle<TColStd_HSequenceOfHAsciiString>

Load()

• Loads original values from some data, to an EditForm Remark: <ent> may be Null, this means all <model> is concerned Also <model> may be Null, if no context applies for <ent> And both <ent> and <model> may be Null, for a full static editor

  param form

  type form

  IFSelect_EditForm

  param ent

  type ent

  Standard_Transient

  param model

  type model

  Interface_InterfaceModel

  rtype

  bool

MaxList()

• Returns max length allowed for a list = 0 meanslist with no limit < 0 meansnot a list

  param num

  type num

  int

  rtype

  int

MaxNameLength()

• Returns the MaxLength of, according to what<what> = -1length of short names <what> = 0length of complete names <what> = 1length of values labels

  param what

  type what

  int

  rtype

  int

Name()

• Returns the name of a Value (complete or short) from its ident Short Name can be empty

  param num

  type num

  int

  param isshort

  default value is Standard_False

  type isshort

  bool

  rtype

  char *

NameNumber()

• Returns the number (ident) of a Value, from its name, short or complete. If not found, returns 0

  param name

  type name

  char *

  rtype

  int

NbValues()

• Returns the count of Typed Values

  rtype

  int

PrintDefs()

Parameters

S –

type S

Message_Messenger

param labels

default value is Standard_False

type labels

bool

rtype

None

PrintNames()

Parameters

S –

type S

Message_Messenger

rtype

None

Recognize()

• Tells if this Editor can work on this EditForm and its content (model, entity ?)

  param form

  type form

  IFSelect_EditForm

  rtype

  bool

SetList()

• Sets a parameter to be a List max < 0not for a list (set when starting) max = 0list with no length limit (default for SetList) max > 0list limited to <max> items

  param num

  type num

  int

  param max

  default value is 0

  type max

  int

  rtype

  None

SetValue()

• Sets a Typed Value for a given ident and short name, with an Edit Mode

  param num

  type num

  int

  param typval

  type typval

  Interface_TypedValue

  param shortname

  default value is

  type shortname

  char *

  param accessmode

  default value is IFSelect_Editable

  type accessmode

  IFSelect_EditValue

  rtype

  None

StringValue()

• Returns the value of an EditForm, for a given item (if not a list. for a list, a Null String may be returned)

  param form

  type form

  IFSelect_EditForm

  param num

  type num

  int

  rtype

  opencascade::handle<TCollection_HAsciiString>

TypedValue()

• Returns a Typed Value from its ident

  param num

  type num

  int

  rtype

  opencascade::handle<Interface_TypedValue>

Update()

• Updates the EditForm when a parameter is modified I.E. default does nothing, can be redefined, as followsReturns True when done (even if does nothing), False in case of refuse (for instance, if the new value is not suitable) <num> is the rank of the parameter for the EDITOR itself <enforce> True means that protected parameters can be touched //! If a parameter commands the value of other ones, when it is modified, it is necessary to touch them by Touch from EditForm

  param form

  type form

  IFSelect_EditForm

  param num

  type num

  int

  param newval

  type newval

  TCollection_HAsciiString

  param enforce

  type enforce

  bool

  rtype

  bool

UpdateList()

• Acts as Update, but when the value is a list

  param form

  type form

  IFSelect_EditForm

  param num

  type num

  int

  param newlist

  type newlist

  TColStd_HSequenceOfHAsciiString

  param enforce

  type enforce

  bool

  rtype

  bool

property thisown

The membership flag

class IFSelect_Functions

Bases: object

static GiveDispatch()

• Evaluates and returns a Dispatch, from data of a WorkSession if <mode> is False, searches for exact name of Dispatch in WS Else (D), allows a parameter between bracketsex.: dispatch_name(parameter) The parameter can be: an integer for DispPerCount or DispPerFiles or the name of a Signature for DispPerSignature Returns Null Handle if not found not well evaluated

  param WS

  type WS

  IFSelect_WorkSession

  param name

  type name

  char *

  param mode

  default value is Standard_True

  type mode

  bool

  rtype

  opencascade::handle<IFSelect_Dispatch>

static GiveEntity()

• Takes the name of an entity, either as argument, or (if <name> is empty) on keybord, and returns the entity name can be a label or a number (in alphanumeric), it is searched by NumberFromLabel from WorkSession. If <name> doesn’t match en entity, a Null Handle is returned

  param WS

  type WS

  IFSelect_WorkSession

  param name

  default value is

  type name

  char *

  rtype

  opencascade::handle<Standard_Transient>

static GiveEntityNumber()

• Same as GetEntity, but returns the number in the model of the entity. Returns 0 for null handle

  param WS

  type WS

  IFSelect_WorkSession

  param name

  default value is

  type name

  char *

  rtype

  int

static GiveList()

• Computes a List of entities from a WorkSession and two idents, first and second, as followsif <first> is a Number or Label of an entitythis entity if <first> is the name of a Selection in <WS>, and <second> not defined, the standard result of this Selection if <first> is for a Selection and <second> is defined, the standard result of this selection from the list computed with <second> (an entity or a selection) If <second> is erroneous, it is ignored

  param WS

  type WS

  IFSelect_WorkSession

  param first

  default value is

  type first

  char *

  param second

  default value is

  type second

  char *

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

static Init()

• Defines and loads all basic functions (as ActFunc)

  rtype

  void

property thisown

The membership flag

class IFSelect_GeneralModifier(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Applies()

• Returns True if a Model obtained from the Dispatch <disp> is to be treated (apart from the Selection criterium) If Dispatch(me) is Null, returns True. Else, checks <disp>

  param disp

  type disp

  IFSelect_Dispatch

  rtype

  bool

Dispatch()

• Returns the Dispatch to be matched, Null if not set

  rtype

  opencascade::handle<IFSelect_Dispatch>

static DownCast(t)

HasSelection()

• Returns True if a Selection is set as an additionnal criterium

  rtype

  bool

Label()

• Returns a short text which defines the operation performed

  rtype

  TCollection_AsciiString

MayChangeGraph()

• Returns True if this modifier may change the graph of dependences (aknowledged at creation time)

  rtype

  bool

ResetSelection()

• Resets the Selectionthis criterium is not longer active

  rtype

  None

Selection()

• Returns the Selection, or a Null Handle if not set

  rtype

  opencascade::handle<IFSelect_Selection>

SetDispatch()

• Attaches to a Dispatch. If <disp> is Null, Resets it (to apply the Modifier on every Dispatch)

  param disp

  type disp

  IFSelect_Dispatch

  rtype

  None

SetSelection()

• Sets a Selectiona Model is treated if it contains one or more Entities designated by the Selection

  param sel

  type sel

  IFSelect_Selection

  rtype

  None

property thisown

The membership flag

class IFSelect_GraphCounter(*args)

Bases: OCC.Core.IFSelect.IFSelect_SignCounter

• Creates a GraphCounter, without applied selection

  param withmap

  default value is Standard_True

  type withmap

  bool

  param withlist

  default value is Standard_False

  type withlist

  bool

  rtype

  None

Applied()

• Returns the applied selection

  rtype

  opencascade::handle<IFSelect_SelectDeduct>

static DownCast(t)

SetApplied()

• Sets a new applied selection

  param sel

  type sel

  IFSelect_SelectDeduct

  rtype

  None

property thisown

The membership flag

class IFSelect_HSeqOfSelection(*args)

Bases: OCC.Core.IFSelect.IFSelect_TSeqOfSelection, OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Append()

ChangeSequence()

static DownCast(t)

Sequence()

property thisown

The membership flag

class IFSelect_IntParam(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an IntParam. Initial value is set to zer

  rtype

  None

static DownCast(t)

SetStaticName()

• Commands this IntParam to be bound to a Static Hence, Value will return the value if this Static if it is set Else, Value works on the locally stored value SetValue also will set the value of the Static This works only for a present static of type integer or enum Else, it is ignored //! If <statname> is empty, disconnects the IntParam from Static

  param statname

  type statname

  char *

  rtype

  None

SetValue()

• Sets a new Integer Value for the IntParam. If a StaticName is defined and the Static is set, also sets the value of the static

  param val

  type val

  int

  rtype

  None

Value()

• Reads Integer Value of the IntParam. If a StaticName is defined and the Static is set, looks in priority the value of the static

  rtype

  int

property thisown

The membership flag

class IFSelect_ListEditor(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates a ListEditor with absolutely no constraint

  rtype

  None* Creates a ListEditor, for which items of the list to edit are defined by <def>, and <max> describes max length : 0 (D) means no limit value > 0 means : no more the <max> items are allowed

  param def

  type def

  Interface_TypedValue

  param max

  default value is 0

  type max

  int

  rtype

  None

AddValue()

• Adds a new item. By default appends (at the end of the list) Can insert before a given rank <num>, if positive Returns True when done. False if MaxLength may be overpassed or if <val> does not satisfy the definition

  param val

  type val

  TCollection_HAsciiString

  param atnum

  default value is 0

  type atnum

  int

  rtype

  bool

ClearEdit()

• Clears all editions already recorded

  rtype

  None

static DownCast(t)

EditedValues()

• Returns the result of the edition

  rtype

  opencascade::handle<TColStd_HSequenceOfHAsciiString>

IsAdded()

• Tells if a value (in edited list) has been added (new one)

  param num

  type num

  int

  rtype

  bool

IsChanged()

• Tells if a value (in edited list) has been changed, i.e. either modified-value, or added

  param num

  type num

  int

  rtype

  bool

IsModified()

• Tells if a value (in edited list) has been modified-value (not added)

  param num

  type num

  int

  rtype

  bool

IsTouched()

• Tells if at least one edition (SetValue-AddValue-Remove) has been recorded

  rtype

  bool

LoadEdited()

• Loads a new list to replace the older one, in once ! By default (can be redefined) checks the length of the list and the value of each item according to the def Items are all recorded as Modified //! If no def has been given at creation time, no check is done Returns True when done, False if checks have failed … a specialisation may also lock it by returning always False …

  param list

  type list

  TColStd_HSequenceOfHAsciiString

  rtype

  bool

LoadModel()

• Loads a Model. It is used to check items of type Entity(Ident)

  param model

  type model

  Interface_InterfaceModel

  rtype

  None

LoadValues()

• Loads the original values for the list RemarkIf its length is mor then MaxLength, editions remain allowed, except Add

  param vals

  type vals

  TColStd_HSequenceOfHAsciiString

  rtype

  None

NbValues()

• Returns count of values, edited (D) or original

  param edited

  default value is Standard_True

  type edited

  bool

  rtype

  int

OriginalValues()

• Returns the value from which the edition started

  rtype

  opencascade::handle<TColStd_HSequenceOfHAsciiString>

Remove()

• Removes items from the list By default removes one item. Else, count given by <howmany> Remove from rank <num> included. By default, from the end Returns True when done, False (and does not work) if case of out of range of if <howmany> is greater than current length

  param num

  default value is 0

  type num

  int

  param howmany

  default value is 1

  type howmany

  int

  rtype

  bool

SetTouched()

• Declares this ListEditor to have been touched (whatever action)

  rtype

  None

SetValue()

• Sets a new value for the item <num> (in edited list) <val> may be a Null Handle, then the value will be cleared but not removed Returns True when done. False if <num> is out of range or if <val> does not satisfy the definition

  param num

  type num

  int

  param val

  type val

  TCollection_HAsciiString

  rtype

  bool

Value()

• Returns a value given its rank. Edited (D) or Original A Null String means the value is cleared but not removed

  param num

  type num

  int

  param edited

  default value is Standard_True

  type edited

  bool

  rtype

  opencascade::handle<TCollection_HAsciiString>

property thisown

The membership flag

class IFSelect_ModelCopier(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an empty ModelCopier

  rtype

  None

AddFile()

• Records a new File to be sent, as a couple (Name as AsciiString, Content as InterfaceModel) Returns True if Done, False if <filename> is already attached to another File

  param filename

  type filename

  TCollection_AsciiString

  param content

  type content

  Interface_InterfaceModel

  rtype

  bool

AddSentFile()

• Adds the name of a just sent file, if BeginSentFiles has commanded recording; else does nothing It is called by methods SendCopied Sending

  param filename

  type filename

  char *

  rtype

  None

AppliedModifiers()

• Returns the list of File Modifiers to be applied on a file when it will be sent, as computed by CopiedModelIf it is a null handle, no File Modifier has to be applied.

  param num

  type num

  int

  rtype

  opencascade::handle<IFSelect_AppliedModifiers>

BeginSentFiles()

• Begins a sequence of recording the really sent files <sho>the default file numbering is cleared If <record> is False, clears the list and stops recording If <record> is True, clears the list and commands recording Creation time corresponds to ‘stop recording’

  param sho

  type sho

  IFSelect_ShareOut

  param record

  type record

  bool

  rtype

  None

ClearAppliedModifiers()

• Clears the list of File Modifiers to be applied on a file

  param num

  type num

  int

  rtype

  bool

ClearFile()

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

  param num

  type num

  int

  rtype

  bool

ClearResult()

• Clears the list of produced Models

  rtype

  None

CopiedRemaining()

• Produces a Model copied from the Remaining List as <newmod> <newmod> is a Null Handle if this list is empty <WL> performs the copy by using <TC> <TC> is assumed to have been defined with the starting model same as defined by <G>.

  param G

  type G

  Interface_Graph

  param WL

  type WL

  IFSelect_WorkLibrary

  param TC

  type TC

  Interface_CopyTool

  param newmod

  type newmod

  Interface_InterfaceModel

  rtype

  None

Copy()

• Performs the Copy Operations, which include the Modifications defined by the list of Modifiers. Memorizes the result, as a list of InterfaceModels with the corresponding FileNames They can then be sent, by the method Send, or queried Copy calls internal method Copying. Returns the produced CheckList

  param eval

  type eval

  IFSelect_ShareOutResult

  param WL

  type WL

  IFSelect_WorkLibrary

  param protocol

  type protocol

  Interface_Protocol

  rtype

  Interface_CheckIterator

static DownCast(t)

FileModel()

• Returns the content of a file before sending, under the form of an InterfaceModel, given its rank

  param num

  type num

  int

  rtype

  opencascade::handle<Interface_InterfaceModel>

FileName()

• Returns the File Name for a file given its rank It is empty after a call to ClearFile on same <num>

  param num

  type num

  int

  rtype

  TCollection_AsciiString

NameFile()

• Changes the Name attached to a File which was formerly defined by a call to AddFile Returns True if Done, False elseif <num> out of range or if the new <filename> is already attached to another File RemarkGiving an empty File Name is equivalent to ClearFile

  param num

  type num

  int

  param filename

  type filename

  TCollection_AsciiString

  rtype

  bool

NbFiles()

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

  rtype

  int

Send()

• Performs the Copy Operations (which include the Modifications) and Sends the result on files, without memorizing it. (the memorized result is ignoredneither queried not filled)

  param eval

  type eval

  IFSelect_ShareOutResult

  param WL

  type WL

  IFSelect_WorkLibrary

  param protocol

  type protocol

  Interface_Protocol

  rtype

  Interface_CheckIterator

SendAll()

• Sends a model (defined in <G>) into one file, without managing remaining data, already sent files, etc. Applies the Model and File Modifiers. Returns True if well done, False else

  param filename

  type filename

  char *

  param G

  type G

  Interface_Graph

  param WL

  type WL

  IFSelect_WorkLibrary

  param protocol

  type protocol

  Interface_Protocol

  rtype

  Interface_CheckIterator

SendCopied()

• Sends the formerly defined results (see method Copy) to files, then clears it RemarkA Null File Name cause file to be not produced

  param WL

  type WL

  IFSelect_WorkLibrary

  param protocol

  type protocol

  Interface_Protocol

  rtype

  Interface_CheckIterator

SendSelected()

• Sends a part of a model into one file. Model is gotten from <G>, the part is defined in <iter>. Remaining data are managed and can be later be worked on. Returns True if well done, False else

  param filename

  type filename

  char *

  param G

  type G

  Interface_Graph

  param WL

  type WL

  IFSelect_WorkLibrary

  param protocol

  type protocol

  Interface_Protocol

  param iter

  type iter

  Interface_EntityIterator

  rtype

  Interface_CheckIterator

SentFiles()

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

  rtype

  opencascade::handle<TColStd_HSequenceOfHAsciiString>

SetAppliedModifiers()

• Sets a list of File Modifiers to be applied on a file

  param num

  type num

  int

  param applied

  type applied

  IFSelect_AppliedModifiers

  rtype

  bool

SetRemaining()

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

  param CG

  type CG

  Interface_Graph

  rtype

  bool

SetShareOut()

• Sets the ShareOut, which is used to define Modifiers to apply

  param sho

  type sho

  IFSelect_ShareOut

  rtype

  None

property thisown

The membership flag

class IFSelect_ModifEditForm(*args)

Bases: OCC.Core.IFSelect.IFSelect_Modifier

• Creates a ModifEditForm. It may not change the graph

  param editform

  type editform

  IFSelect_EditForm

  rtype

  None

static DownCast(t)

EditForm()

• Returns the EditForm

  rtype

  opencascade::handle<IFSelect_EditForm>

property thisown

The membership flag

class IFSelect_ModifReorder(*args)

Bases: OCC.Core.IFSelect.IFSelect_Modifier

• Creates a ModifReorder. It may change the graph (it does !) If <rootlast> is True (D), roots are set at the end of packets Else, they are set at beginning (as done by AddWithRefs)

  param rootlast

  default value is Standard_True

  type rootlast

  bool

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_Modifier(*args, **kwargs)

Bases: OCC.Core.IFSelect.IFSelect_GeneralModifier

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

Perform()

• This deferred method defines the action specific to each class of Modifier. It is called by a ModelCopier, once the Model generated and filled. ModelCopier has already checked the criteria (Dispatch, Model Rank, Selection) before calling it. //! <ctx> detains informations about original data and selection. The result of copying, on which modifications are to be done, is <target>. <TC> allows to run additional copies as required //! In case of Error, use methods CCheck from the ContextModif to aknowledge an entity Check or a Global Check with messages

  param ctx

  type ctx

  IFSelect_ContextModif

  param target

  type target

  Interface_InterfaceModel

  param protocol

  type protocol

  Interface_Protocol

  param TC

  type TC

  Interface_CopyTool

  rtype

  void

property thisown

The membership flag

class IFSelect_PacketList(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates a PackList, empty, ready to receive entities from a given Model

  param model

  type model

  Interface_InterfaceModel

  rtype

  None

Add()

• Adds an entity from the Model into the current packet for Add

  param ent

  type ent

  Standard_Transient

  rtype

  None

AddList()

• Adds an list of entities into the current packet for Add

  param list

  type list

  TColStd_HSequenceOfTransient

  rtype

  None

AddPacket()

• Declares a new Packet, ready to be filled The entities to be added will be added to this Packet

  rtype

  None

static DownCast(t)

Duplicated()

• Returns a list of entities duplicated<count> times, if <andmore> is False, or <count> or more times, if <andmore> is True Hence, count=2 & andmore=True gives all duplicated entities count=1 gives non-duplicated entities (in only one packet) count=0 gives remaining entities (in no packet at all)

  param count

  type count

  int

  param andmore

  type andmore

  bool

  rtype

  Interface_EntityIterator

Entities()

• Returns the content of a Packet given its rank Null Handle if <numpack> is out of range

  param numpack

  type numpack

  int

  rtype

  Interface_EntityIterator

HighestDuplicationCount()

• Returns the highest number of packets which know a same entity For no duplication, should be one

  rtype

  int

Model()

• Returns the Model of reference

  rtype

  opencascade::handle<Interface_InterfaceModel>

Name()

• Returns the recorded name for a packet list

  rtype

  char *

NbDuplicated()

• Returns the count of entities duplicated<count> times, if <andmore> is False, or <count> or more times, if <andmore> is True See Duplicated for more details

  param count

  type count

  int

  param andmore

  type andmore

  bool

  rtype

  int

NbEntities()

• Returns the count of entities in a Packet given its rank, or 0

  param numpack

  type numpack

  int

  rtype

  int

NbPackets()

• Returns the count of non-empty packets

  rtype

  int

SetName()

• Sets a name to a packet listthis makes easier a general routine to print it. Default is ‘Packets’

  param name

  type name

  char *

  rtype

  None

property thisown

The membership flag

class IFSelect_ParamEditor(*args)

Bases: OCC.Core.IFSelect.IFSelect_Editor

• Creates a ParamEditor, empty, with a maximum count of params (default is 100) And a label, by default it will be ‘Param Editor’

  param nbmax

  default value is 100

  type nbmax

  int

  param label

  default value is

  type label

  char *

  rtype

  None

AddConstantText()

• Adds a Constant Text, it will be Read Only By default, its long name equates its shortname

  param val

  type val

  char *

  param shortname

  type shortname

  char *

  param completename

  default value is

  type completename

  char *

  rtype

  None

AddValue()

• Adds a TypedValue By default, its short name equates its complete name, it can be explicited

  param val

  type val

  Interface_TypedValue

  param shortname

  default value is

  type shortname

  char *

  rtype

  None

static DownCast(t)

static StaticEditor()

• Returns a ParamEditor to work on the Static Parameters of which names are listed in <list> Null Handle if <list> is null or empty

  param list

  type list

  TColStd_HSequenceOfHAsciiString

  param label

  default value is

  type label

  char *

  rtype

  opencascade::handle<IFSelect_ParamEditor>

property thisown

The membership flag

class IFSelect_SelectAnyList(*args, **kwargs)

Bases: OCC.Core.IFSelect.IFSelect_SelectDeduct

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

FillResult()

• Puts into <res>, the sub-entities of the list, from n1 to n2 included. Remark that adequation with Entity’s type and length of list has already been made at this stage Called by RootResult

  param n1

  type n1

  int

  param n2

  type n2

  int

  param ent

  type ent

  Standard_Transient

  param res

  type res

  Interface_EntityIterator

  rtype

  void

HasLower()

• Returns True if a Lower limit is defined

  rtype

  bool

HasUpper()

• Returns True if a Lower limit is defined

  rtype

  bool

KeepInputEntity()

• Keeps Input Entity, as having required type. It works by keeping in <iter>, only suitable Entities (SelectType can be used). Called by RootResult (which waits for ONE ENTITY MAX)

  param iter

  type iter

  Interface_EntityIterator

  rtype

  void

ListLabel()

• Returns the specific label for the list, which is included as a part of Label

  rtype

  TCollection_AsciiString

Lower()

• Returns Lower limit (if there is; else, value is senseless)

  rtype

  opencascade::handle<IFSelect_IntParam>

LowerValue()

• Returns Integer Value of Lower Limit (0 if none)

  rtype

  int

NbItems()

• Returns count of Items in the list in the Entity <ent> If <ent> has not required type, returned value must be Zero

  param ent

  type ent

  Standard_Transient

  rtype

  int

SetFrom()

• Sets a Lower limit but no upper limit

  param rankfrom

  type rankfrom

  IFSelect_IntParam

  rtype

  None

SetOne()

• Sets a unique number (only one Entity will be sorted as True)

  param rank

  type rank

  IFSelect_IntParam

  rtype

  None

SetRange()

• Sets a Range for numbers, with a lower and a upper limits

  param rankfrom

  type rankfrom

  IFSelect_IntParam

  param rankto

  type rankto

  IFSelect_IntParam

  rtype

  None

SetUntil()

• Sets an Upper limit but no lower limit (equivalent to lower 1)

  param rankto

  type rankto

  IFSelect_IntParam

  rtype

  None

Upper()

• Returns Upper limit (if there is; else, value is senseless)

  rtype

  opencascade::handle<IFSelect_IntParam>

UpperValue()

• Returns Integer Value of Upper Limit (0 if none)

  rtype

  int

property thisown

The membership flag

class IFSelect_SelectAnyType(*args, **kwargs)

Bases: OCC.Core.IFSelect.IFSelect_SelectExtract

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

TypeForMatch()

• Returns the Type which has to be matched for select

  rtype

  opencascade::handle<Standard_Type>

property thisown

The membership flag

class IFSelect_SelectBase(*args, **kwargs)

Bases: OCC.Core.IFSelect.IFSelect_Selection

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

property thisown

The membership flag

class IFSelect_SelectCombine(*args, **kwargs)

Bases: OCC.Core.IFSelect.IFSelect_Selection

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Add()

• Adds a Selection to the filling list By default, adds it to the end of the list A Positive rank less then NbInputs gives an insertion rank (InsertBeforethe new <atnum>th item of the list is <sel>)

  param sel

  type sel

  IFSelect_Selection

  param atnum

  default value is 0

  type atnum

  int

  rtype

  None

static DownCast(t)

Input()

• Returns an Input Selection, given its rank in the list

  param num

  type num

  int

  rtype

  opencascade::handle<IFSelect_Selection>

InputRank()

• Returns the rank of an input Selection, 0 if not in the list. Most generally, its value is meaningless, except for testing the presence of an input Selection- == 0 if <sel> is not an input for <self> - > 0 if <sel> is an input for <self>

  param sel

  type sel

  IFSelect_Selection

  rtype

  int

NbInputs()

• Returns the count of Input Selections

  rtype

  int

Remove()

• Removes an input Selection. Returns True if Done, False, if <sel> is not an input for <self>

  param sel

  type sel

  IFSelect_Selection

  rtype

  bool* Removes an input Selection, given its rank in the list Returns True if Done, False if <num> is out of range

  param num

  type num

  int

  rtype

  bool

property thisown

The membership flag

class IFSelect_SelectControl(*args, **kwargs)

Bases: OCC.Core.IFSelect.IFSelect_Selection

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

HasSecondInput()

• Returns True if a Control Input is defined Thus, Result can be computed differently if there is a Control Input or if there is none

  rtype

  bool

MainInput()

• Returns the Main Input Selection

  rtype

  opencascade::handle<IFSelect_Selection>

SecondInput()

• Returns the Control Input Selection, or a Null Handle

  rtype

  opencascade::handle<IFSelect_Selection>

SetMainInput()

• Sets a Selection to be the Main Input

  param sel

  type sel

  IFSelect_Selection

  rtype

  None

SetSecondInput()

• Sets a Selection to be the Control Input

  param sel

  type sel

  IFSelect_Selection

  rtype

  None

property thisown

The membership flag

class IFSelect_SelectDeduct(*args, **kwargs)

Bases: OCC.Core.IFSelect.IFSelect_Selection

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Alternate()

• Returns the Alternate Definition It is returned modifiable, hence an already defined SelectPointed can be used But if it was not yet defined, it is created the first time //! It is exploited by InputResult

  rtype

  opencascade::handle<IFSelect_SelectPointed>

static DownCast(t)

HasAlternate()

• Tells if an Alternate List has been set, i.e.the Alternate Definition is present and set

  rtype

  bool

HasInput()

• Returns True if the Input Selection is defined, False else

  rtype

  bool

Input()

• Returns the Input Selection

  rtype

  opencascade::handle<IFSelect_Selection>

InputResult()

• Returns the Result determined by Input Selection, as Unique if Input Selection is not defined, returns an empty list. //! If Alternate is set, InputResult takes its definition instead of calling the Input Selection, then clears it

  param G

  type G

  Interface_Graph

  rtype

  Interface_EntityIterator

SetInput()

• Defines or Changes the Input Selection

  param sel

  type sel

  IFSelect_Selection

  rtype

  None

property thisown

The membership flag

class IFSelect_SelectDiff(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectControl

• Creates an empty SelectDiff

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_SelectEntityNumber(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectBase

• Creates a SelectEntityNumber, initially with no specified Number

  rtype

  None

static DownCast(t)

Number()

• Returns specified Number (as a Parameter)

  rtype

  opencascade::handle<IFSelect_IntParam>

SetNumber()

• Sets Entity Number to be taken (initially, none is set0)

  param num

  type num

  IFSelect_IntParam

  rtype

  None

property thisown

The membership flag

class IFSelect_SelectErrorEntities(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectExtract

• Creates a SelectErrorEntities

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_SelectExplore(*args, **kwargs)

Bases: OCC.Core.IFSelect.IFSelect_SelectDeduct

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

Explore()

• Analyses and, if required, Explores an entity, as followsThe explored list starts as empty, it has to be filled by this method. If it returns False, <ent> is rejected for result (this is to be used only as safety) If it returns True and <explored> remains empty, <ent> is taken itself for result, not explored If it returns True and <explored> is not empty, the content of this list is consideredIf maximum level is attained, it is taken for result Else (or no max), each of its entity will be itself explored

  param level

  type level

  int

  param ent

  type ent

  Standard_Transient

  param G

  type G

  Interface_Graph

  param explored

  type explored

  Interface_EntityIterator

  rtype

  bool

ExploreLabel()

• Returns a text defining the way of exploration

  rtype

  TCollection_AsciiString

Level()

• Returns the required exploring level

  rtype

  int

property thisown

The membership flag

class IFSelect_SelectExtract(*args, **kwargs)

Bases: OCC.Core.IFSelect.IFSelect_SelectDeduct

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

ExtractLabel()

• Returns a text defining the criterium for extraction

  rtype

  TCollection_AsciiString

IsDirect()

• Returns True if Sort criterium is Direct, False if Reverse

  rtype

  bool

SetDirect()

• Sets Sort criterium sense to a new value (TrueDirect , FalseReverse)

  param direct

  type direct

  bool

  rtype

  None

Sort()

• Returns True for an Entity if it satisfies the Sort criterium It receives- <rank>, the rank of the Entity in the Iteration, - <ent> , the Entity itself, and - <model>, the Starting Model Hence, the Entity to check is ‘model->Value(num)’ (but an InterfaceModel allows other checks) This method is specific to each class of SelectExtract

  param rank

  type rank

  int

  param ent

  type ent

  Standard_Transient

  param model

  type model

  Interface_InterfaceModel

  rtype

  bool

SortInGraph()

• Works as Sort but works on the Graph Default directly calls Sort, but it can be redefined If SortInGraph is redefined, Sort should be defined even if not called (to avoid deferred methods in a final class)

  param rank

  type rank

  int

  param ent

  type ent

  Standard_Transient

  param G

  type G

  Interface_Graph

  rtype

  bool

property thisown

The membership flag

class IFSelect_SelectFlag(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectExtract

• Creates a Select Flag, to query a flag designated by its name

  param flagname

  type flagname

  char *

  rtype

  None

static DownCast(t)

FlagName()

• Returns the name of the flag

  rtype

  char *

property thisown

The membership flag

class IFSelect_SelectInList(*args, **kwargs)

Bases: OCC.Core.IFSelect.IFSelect_SelectAnyList

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

ListedEntity()

• Returns an Entity, given its rank in the list

  param num

  type num

  int

  param ent

  type ent

  Standard_Transient

  rtype

  opencascade::handle<Standard_Transient>

property thisown

The membership flag

class IFSelect_SelectIncorrectEntities(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectFlag

• Creates a SelectIncorrectEntities i.e. a SelectFlag(‘Incorrect’)

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_SelectIntersection(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectCombine

• Creates an empty SelectIntersection

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_SelectModelEntities(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectBase

• Creates a SelectModelRoot

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_SelectModelRoots(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectBase

• Creates a SelectModelRoot

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_SelectPointed(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectBase

• Creates a SelectPointed

  rtype

  None

Add()

• Adds an item. Returns True if Done, False if <item> is already in the selected list

  param item

  type item

  Standard_Transient

  rtype

  bool

AddList()

• Adds all the items defined in a list. Returns True if at least one item has been added, False else

  param list

  type list

  TColStd_HSequenceOfTransient

  rtype

  bool

Clear()

• Clears the list of selected items Also says the list is unset All Add* methods and SetList say the list is set

  rtype

  None

static DownCast(t)

IsSet()

• Tells if the list has been set. Even if empty

  rtype

  bool

Item()

• Returns an item given its rank, or a Null Handle

  param num

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

NbItems()

• Returns the count of selected items

  rtype

  int

Rank()

• Returns the rank of an item in the selected list, or 0.

  param item

  type item

  Standard_Transient

  rtype

  int

Remove()

• Removes an item. Returns True if Done, False if <item> was not in the selected list

  param item

  type item

  Standard_Transient

  rtype

  bool

RemoveList()

• Removes all the items defined in a list. Returns True if at least one item has been removed, False else

  param list

  type list

  TColStd_HSequenceOfTransient

  rtype

  bool

SetEntity()

• As SetList but with only one entity If <ent> is Null, the list is said as being set but is empty

  param item

  type item

  Standard_Transient

  rtype

  None

SetList()

• Sets a given list to define the list of selected items <list> can be empty or nullin this case, the list is said as being set, but it is empty //! To use it as an alternate input, one shot- SetList or SetEntity to define the input list - RootResult to get it - then Clear to drop it

  param list

  type list

  TColStd_HSequenceOfTransient

  rtype

  None

Toggle()

• Toggles status of an itemadds it if not pointed or removes it if already pointed. Returns the new status (Pointed or not)

  param item

  type item

  Standard_Transient

  rtype

  bool

ToggleList()

• Toggles status of all the items defined in a listadds it if not pointed or removes it if already pointed.

  param list

  type list

  TColStd_HSequenceOfTransient

  rtype

  bool

Update()

• Rebuilds the selected list. Any selected entity which has a bound result is replaced by this result, else it is removed.

  param control

  type control

  Interface_CopyControl

  rtype

  None* Rebuilds the selected list, by querying a Transformer (same principle as from a CopyControl)

  param trf

  type trf

  IFSelect_Transformer

  rtype

  None

property thisown

The membership flag

class IFSelect_SelectRange(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectExtract

• Creates a SelectRange. Default is Take all the input list

  rtype

  None

static DownCast(t)

HasLower()

• Returns True if a Lower limit is defined

  rtype

  bool

HasUpper()

• Returns True if a Lower limit is defined

  rtype

  bool

Lower()

• Returns Lower limit (if there is; else, value is senseless)

  rtype

  opencascade::handle<IFSelect_IntParam>

LowerValue()

• Returns Value of Lower Limit (0 if none is defined)

  rtype

  int

SetFrom()

• Sets a Lower limit but no upper limit

  param rankfrom

  type rankfrom

  IFSelect_IntParam

  rtype

  None

SetOne()

• Sets a unique number (only one Entity will be sorted as True)

  param rank

  type rank

  IFSelect_IntParam

  rtype

  None

SetRange()

• Sets a Range for numbers, with a lower and a upper limits Error if rankto is lower then rankfrom

  param rankfrom

  type rankfrom

  IFSelect_IntParam

  param rankto

  type rankto

  IFSelect_IntParam

  rtype

  None

SetUntil()

• Sets an Upper limit but no lower limit (equivalent to lower 1)

  param rankto

  type rankto

  IFSelect_IntParam

  rtype

  None

Upper()

• Returns Upper limit (if there is; else, value is senseless)

  rtype

  opencascade::handle<IFSelect_IntParam>

UpperValue()

• Returns Value of Upper Limit (0 if none is defined)

  rtype

  int

property thisown

The membership flag

class IFSelect_SelectRootComps(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectExtract

• Creates a SelectRootComps

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_SelectRoots(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectExtract

• Creates a SelectRoots

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_SelectSent(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectExtract

• Creates a SelectSentsentcount = 0 -> remaining (non-sent) entities sentcount = 1, atleast = True (D) -> sent (at least once) sentcount = 2, atleast = True -> duplicated (sent least twice) etc… sentcount = 1, atleast = False -> sent just once (non-dupl.d) sentcount = 2, atleast = False -> sent just twice etc…

  param sentcount

  default value is 1

  type sentcount

  int

  param atleast

  default value is Standard_True

  type atleast

  bool

  rtype

  None

AtLeast()

• Returns the <atleast> status, True for sending at least the sending count, False for sending exactly the sending count Remarkif SentCount is 0, AtLeast is ignored

  rtype

  bool

static DownCast(t)

SentCount()

• Returns the queried count of sending

  rtype

  int

property thisown

The membership flag

class IFSelect_SelectShared(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectDeduct

• Creates a SelectShared;

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_SelectSharing(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectDeduct

• Creates a SelectSharing;

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_SelectSignature(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectExtract

• Creates a SelectSignature with its Signature and its Text to Match. <exact> if True requires exact match, if False requires <signtext> to be contained in the Signature of the entity (default is ‘exact’)

  param matcher

  type matcher

  IFSelect_Signature

  param signtext

  type signtext

  char *

  param exact

  default value is Standard_True

  type exact

  bool

  rtype

  None* As above with an AsciiString

  param matcher

  type matcher

  IFSelect_Signature

  param signtext

  type signtext

  TCollection_AsciiString

  param exact

  default value is Standard_True

  type exact

  bool

  rtype

  None* Creates a SelectSignature with a Counter, more precisely a SelectSignature. Which is used here to just give a Signature Value (by SignOnly Mode) Matching is the default provided by the class Signature

  param matcher

  type matcher

  IFSelect_SignCounter

  param signtext

  type signtext

  char *

  param exact

  default value is Standard_True

  type exact

  bool

  rtype

  None

Counter()

• Returns the used SignCounter. Can be used as alternative for Signature

  rtype

  opencascade::handle<IFSelect_SignCounter>

static DownCast(t)

IsExact()

• Returns True if match must be exact

  rtype

  bool

Signature()

• Returns the used Signature, then it is possible to access it, modify it as required. Can be null, hence see Counter

  rtype

  opencascade::handle<IFSelect_Signature>

SignatureText()

• Returns Text used to Sort Entity on its Signature or SignCounter

  rtype

  TCollection_AsciiString

property thisown

The membership flag

class IFSelect_SelectSignedShared(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectExplore

• Creates a SelectSignedShared, defaulted for any level with a given Signature and text to match

  param matcher

  type matcher

  IFSelect_Signature

  param signtext

  type signtext

  char *

  param exact

  default value is Standard_True

  type exact

  bool

  param level

  default value is 0

  type level

  int

  rtype

  None

static DownCast(t)

IsExact()

• Returns True if match must be exact

  rtype

  bool

Signature()

• Returns the used Signature, then it is possible to access it, modify it as required

  rtype

  opencascade::handle<IFSelect_Signature>

SignatureText()

• Returns Text used to Sort Entity on its Signature

  rtype

  TCollection_AsciiString

property thisown

The membership flag

class IFSelect_SelectSignedSharing(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectExplore

• Creates a SelectSignedSharing, defaulted for any level with a given Signature and text to match

  param matcher

  type matcher

  IFSelect_Signature

  param signtext

  type signtext

  char *

  param exact

  default value is Standard_True

  type exact

  bool

  param level

  default value is 0

  type level

  int

  rtype

  None

static DownCast(t)

IsExact()

• Returns True if match must be exact

  rtype

  bool

Signature()

• Returns the used Signature, then it is possible to access it, modify it as required

  rtype

  opencascade::handle<IFSelect_Signature>

SignatureText()

• Returns Text used to Sort Entity on its Signature

  rtype

  TCollection_AsciiString

property thisown

The membership flag

class IFSelect_SelectSuite(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectDeduct

• Creates an empty SelectSuite

  rtype

  None

AddInput()

• Adds an input selection. I.E.If <item> is a SelectDeduct, adds it as Previous, not as Input Else, sets it as Input Returns True when done Returns False and refuses to work if Input is already defined

  param item

  type item

  IFSelect_Selection

  rtype

  bool

AddNext()

• Adds a new last item (prepends to the list) If <item> is null, does nothing

  param item

  type item

  IFSelect_SelectDeduct

  rtype

  None

AddPrevious()

• Adds a new first item (prepends to the list). The Input is not touched If <item> is null, does nothing

  param item

  type item

  IFSelect_SelectDeduct

  rtype

  None

static DownCast(t)

Item()

• Returns an item from its rank in the list (the Input is always apart)

  param num

  type num

  int

  rtype

  opencascade::handle<IFSelect_SelectDeduct>

NbItems()

• Returns the count of Items

  rtype

  int

SetLabel()

• Sets a value for the Label

  param lab

  type lab

  char *

  rtype

  None

property thisown

The membership flag

class IFSelect_SelectType(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectAnyType

• Creates a SelectType. Default is no filter

  rtype

  None* Creates a SelectType for a given Type

  param atype

  type atype

  Standard_Type

  rtype

  None

static DownCast(t)

SetType()

• Sets a TYpe for filter

  param atype

  type atype

  Standard_Type

  rtype

  None

property thisown

The membership flag

class IFSelect_SelectUnion(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectCombine

• Creates an empty SelectUnion

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_SelectUnknownEntities(*args)

Bases: OCC.Core.IFSelect.IFSelect_SelectExtract

• Creates a SelectUnknownEntities

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_Selection(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

CompleteResult()

• Returns the list of entities involved by a Selection, i.e. UniqueResult plus the shared entities (directly or not)

  param G

  type G

  Interface_Graph

  rtype

  Interface_EntityIterator

static DownCast(t)

FillIterator()

• Puts in an Iterator the Selections from which ‘me’ depends (there can be zero, or one, or a list). Specific to each class of Selection

  param iter

  type iter

  IFSelect_SelectionIterator

  rtype

  void

Label()

• Returns a text which defines the criterium applied by a Selection (can be used to be printed, displayed …) Specific to each class

  rtype

  TCollection_AsciiString

RootResult()

• Returns the list of selected entities, computed from Input given as a Graph. Specific to each class of Selection Note that uniqueness of each entity is not required here This method can raise an exception as necessary

  param G

  type G

  Interface_Graph

  rtype

  Interface_EntityIterator

UniqueResult()

• Returns the list of selected entities, each of them beeing unique. Default definition works from RootResult. According HasUniqueResult, UniqueResult returns directly RootResult, or build a Unique Result from it with a Graph.

  param G

  type G

  Interface_Graph

  rtype

  Interface_EntityIterator

property thisown

The membership flag

class IFSelect_SelectionIterator(*args)

Bases: object

• Creates an empty iterator, ready to be filled

  rtype

  None* Creates an iterator from a Selection : it lists the Selections from which <sel> depends (given by its method FillIterator)

  param sel

  type sel

  IFSelect_Selection

  rtype

  None

AddFromIter()

• Adds to an iterator the content of another one (each selection is present only once in the result)

  param iter

  type iter

  IFSelect_SelectionIterator

  rtype

  None

AddItem()

• Adds a Selection to an iterator (if not yet noted)

  param sel

  type sel

  IFSelect_Selection

  rtype

  None

AddList()

• Adds a list of Selections to an iterator (this list comes from the description of a Selection or a Dispatch, etc…)

  param list

  type list

  IFSelect_TSeqOfSelection

  rtype

  None

More()

• Returns True if there are more Selections to get

  rtype

  bool

Next()

• Sets iterator to the next item

  rtype

  None

Value()

• Returns the current Selction beeing iterated Error if count of Selection has been passed

  rtype

  opencascade::handle<IFSelect_Selection>

property thisown

The membership flag

class IFSelect_SequenceOfAppliedModifiers(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class IFSelect_SequenceOfGeneralModifier(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class IFSelect_SequenceOfInterfaceModel(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class IFSelect_SessionDumper(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

static First()

• Returns the First item of the Library of Dumper. The Next ones are then obtained by Next on the returned items

  rtype

  opencascade::handle<IFSelect_SessionDumper>

Next()

• Returns the Next SesionDumper in the Library. Returns a Null Handle at the End.

  rtype

  opencascade::handle<IFSelect_SessionDumper>

ReadOwn()

• Recognizes a Type (given as <type>) then Creates an Item of this Type with the Own Parameter, as required. Returns True if it has recognized the Type (in this case, it is assumed to have created the Item, returned as <item>), False elsein that case, SessionFile will try another SessionDumper in the Library. ReadOwn can use these methods from SessionFile to access Own ParametersNbOwnParams, IsVoid, IsText, TextValue, ItemValue

  param file

  type file

  IFSelect_SessionFile

  param type

  type type

  TCollection_AsciiString

  param item

  type item

  Standard_Transient

  rtype

  bool

WriteOwn()

• Writes the Own Parameters of a given Item, if it forecast to manage its Type. Returns True if it has recognized the Type of the Item (in this case, it is assumed to have written the Own Parameters if there are some), False elsein that case, SessionFile will try another SessionDumper in the Library. WriteOwn can use these methods from SessionFileSendVoid, SendItem, SendText, and if necessary, WorkSession.

  param file

  type file

  IFSelect_SessionFile

  param item

  type item

  Standard_Transient

  rtype

  bool

property thisown

The membership flag

class IFSelect_SessionFile(*args)

Bases: object

• Creates a SessionFile, ready to read Files in order to load them into a given WorkSession. The following Read Operations must then be called. It is also possible to perform a Write, which produces a complete File of all the content of the WorkSession.

  param WS

  type WS

  IFSelect_WorkSession

  rtype

  None* Creates a SessionFile which Writes the content of a WorkSession to a File (directly calls Write) Then, IsDone aknowledges on the result of the Operation. But such a SessionFile may not Read a File to a WorkSession.

  param WS

  type WS

  IFSelect_WorkSession

  param filename

  type filename

  char *

  rtype

  None

AddItem()

• Adds an Item to the WorkSession, taken as Name the first item of the read Line. If this Name is not a Name but a Number or if this Name is already recorded in the WorkSession, it adds the Item but with no Name. Then the Name is recorded in order to be used by the method ItemValue <active> commands to make <item> active or not in the session

  param item

  type item

  Standard_Transient

  param active

  default value is Standard_True

  type active

  bool

  rtype

  None

AddLine()

• Adds a line to the list of recorded lines

  param line

  type line

  char *

  rtype

  None

ClearLines()

• Clears the lines recorded whatever for writing or for reading

  rtype

  None

Destroy()

• Specific Destructor (closes the File if not yet done)

  rtype

  None

IsDone()

• Returns True if the last Read or Write operation has been corectly performed. ELse returns False.

  rtype

  bool

IsText()

• Returns True if a Parameter, in the Own List (see NbOwnParams) is a Text (between ‘…’). Else it is an Item (Parameter, Selection, Dispatch …), which can be Void.

  param num

  type num

  int

  rtype

  bool

IsVoid()

• Returns True if a Parameter, given its rank in the Own List (see NbOwnParams), is Void. Returns also True if <num> is out of range (undefined parameters)

  param num

  type num

  int

  rtype

  bool

ItemValue()

• Returns a Parameter as an Item. Returns a Null Handle if the Parameter is a Text, or if it is defined as Void

  param num

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

Line()

• Returns a line given its rank in the list of recorded lines

  param num

  type num

  int

  rtype

  TCollection_AsciiString

NbLines()

• Returns the count of recorded lines

  rtype

  int

NbParams()

• During a Read operation, SessionFile processes sequencially the Items to read. For each one, it gives access to the list of its Parametersthey were defined by calls to SendVoid/SendParam/SendText during Writing the File. NbParams returns the count of Parameters for the line currently read.

  rtype

  int

NewItem()

• At beginning of writing an Item, writes its basics- either its name in the session if it has one - or its relative number of item in the file, else (preceeded by a ‘_’) - then, its Dynamic Type (in the sense of cdlpk_class) This basic description can be followed by the parameters which are used in the definition of the item.

  param ident

  type ident

  int

  param par

  type par

  Standard_Transient

  rtype

  None

ParamValue()

• Returns a Parameter (alphanumeric item of a line) as it has been read

  param num

  type num

  int

  rtype

  TCollection_AsciiString

Read()

• Performs a Read Operation from a file to a WorkSession i.e. calls ReadFile, then ReadSession and ReadEnd Returned Value is0 for OK, -1 File could not be opened, >0 Error during Read (see WriteSession) IsDone can be called too (will return True for OK)

  param filename

  type filename

  char *

  rtype

  int

ReadEnd()

• Reads the end of a file (its last line). Returns 0 if OK, status >0 in case of error (not a suitable end line).

  rtype

  int

ReadFile()

• Reads the recorded lines from a file named <name>, after having cleared the list (stops if RecognizeFile fails) Returns False (with no clearing) if the file could not be read

  param name

  type name

  char *

  rtype

  bool

ReadLine()

• Reads a Line and splits it into a set of alphanumeric items, which can then be queried by NbParams/ParamValue …

  rtype

  bool

ReadOwn()

• Tries to Read an Item, by calling the Library of Dumpers Sets the list of parameters of the line to be read from the first own one

  param item

  type item

  Standard_Transient

  rtype

  bool

ReadSession()

• Performs a Read Operation from a File to a WorkSession, i.e. reads the list of line (which must have already been loaded, by ReadFile or by calls to AddLine) Important Remarkthis excludes the reading of the last line, which is performed by ReadEnd Returns 0 for OK, >0 status for Read Error (not a suitable File, or WorkSession given as Immutable at Creation Time) IsDone can be called too (will return True for OK)

  rtype

  int

RecognizeFile()

• Recognizes the header line. returns True if OK, False else

  param headerline

  type headerline

  char *

  rtype

  bool

RemoveLastLine()

• Removes the last line. Can be called recursively. Does nothing if the list is empty

  rtype

  None

SendItem()

• During a Write action, commands to send the identification of a Parameterif it is Null (undefined) it is send as Void ($) if it is Named in the WorkSession, its Name is sent preceeded by ‘:’, else a relative Ident Number is sent preceeded by ‘#’ (relative to the present Write, i.e. starting at one, without skip, and counted part from Named Items)

  param par

  type par

  Standard_Transient

  rtype

  None

SendText()

• During a Write action, commands to send a Text without interpretation. It will be sent as well

  param text

  type text

  char *

  rtype

  None

SendVoid()

• During a Write action, commands to send a Void Parameter i.e. a Parameter which is present but undefined Its form will be the dollar sign$

  rtype

  None

SetLastGeneral()

• Sets the rank of Last General Parameter to a new value. It is followed by the Fist Own Parameter of the item. Used by SessionFile after reading general parameters.

  param lastgen

  type lastgen

  int

  rtype

  None

SetOwn()

• Sets Parameters to be sent as Own if <mode> is True (their Name or Number or Void Mark or Text Value is preceeded by a Column sign ‘:’) else they are sent normally Hence, the Own Parameter are clearly identified in the File

  param mode

  type mode

  bool

  rtype

  None

SplitLine()

• Internal routine which processes a line into words and prepares its exploration

  param line

  type line

  char *

  rtype

  None

TextValue()

• Returns the content of a Text Parameter (without the quotes). Returns an empty string if the Parameter is not a Text.

  param num

  type num

  int

  rtype

  TCollection_AsciiString

WorkSession()

• Returns the WorkSession on which a SessionFile works. Remark that it is returned as Immutable.

  rtype

  opencascade::handle<IFSelect_WorkSession>

Write()

• Performs a Write Operation from a WorkSession to a File i.e. calls WriteSession then WriteEnd, and WriteFile Returned Value is0 for OK, -1 File could not be created, >0 Error during Write (see WriteSession) IsDone can be called too (will return True for OK)

  param filename

  type filename

  char *

  rtype

  int

WriteEnd()

• Writes the trailing line. It is separate from WriteSession, in order to allow to redefine WriteSession without touching WriteEnd (WriteSession defines the body of the file) WriteEnd fills the list of lines. Returns a status of error, 0 if OK, >0 else

  rtype

  int

WriteFile()

• Writes the recorded lines to a file named <name> then clears the list of lines. Returns False (with no clearing) if the file could not be created

  param name

  type name

  char *

  rtype

  bool

WriteLine()

• Writes a line to the File. If <follow> is given, it is added at the following of the line. A newline must be added for the end.

  param line

  type line

  char *

  param follow

  default value is 0

  type follow

  Standard_Character

  rtype

  None

WriteOwn()

• Writes the Parameters own to each type of Item. Uses the Library of SessionDumpers Returns True if Done, False if <item> could not be treated (hence it remains written with no Own Parameter)

  param item

  type item

  Standard_Transient

  rtype

  bool

WriteSession()

• Prepares the Write operation from a WorkSession (IFSelect) to a File, i.e. fills the list of lines (the file itself remains to be written; or NbLines/Line may be called) Important Remarkthis excludes the reading of the last line, which is performed by WriteEnd Returns 0 if OK, status > 0 in case of error

  rtype

  int

property thisown

The membership flag

class IFSelect_SessionPilot(*args)

Bases: OCC.Core.IFSelect.IFSelect_Activator

• Creates an empty SessionPilot, with a prompt which will be displayed on querying commands. If not precised (‘’), this prompt is set to ‘Test-XSTEP>’

  param prompt

  default value is

  type prompt

  char *

  rtype

  None

Arg()

• Returns a word given its rank, as a CString. As for Word, begins at 0 (the command name), etc…

  param num

  type num

  int

  rtype

  char *

Clear()

• Clears the recorded informations (commands, objects)

  rtype

  None

Command()

• Returns a recorded Command, given its rank (from 1)

  param num

  type num

  int

  rtype

  TCollection_AsciiString

CommandLine()

• Returns the Command Line to be interpreted

  rtype

  TCollection_AsciiString

CommandPart()

• Returns the part of the command line which begins at argument <numarg> between 0 and NbWords-1 (by default, all the line) Empty string if out of range

  param numarg

  default value is 0

  type numarg

  int

  rtype

  char *

static DownCast(t)

Execute()

• Sets the Command then tries to execute it. Return valuesame as for Perform

  param command

  type command

  TCollection_AsciiString

  rtype

  IFSelect_ReturnStatus

ExecuteAlias()

• Executes the Commands, except that the command name (word 0) is aliased. The rest of the command line is unchanged If <alias> is empty, Executes with no change //! Error status is returned if the alias is unknown as command

  param aliasname

  type aliasname

  TCollection_AsciiString

  rtype

  IFSelect_ReturnStatus

ExecuteCounter()

• Executes a Counter in a general way If <numword> is greater than count of command words, it counts all the model. Else it considers the word <numword> as the identifier of a Selection <mode> gives the mode of printing results, default is CountByItem

  param counter

  type counter

  IFSelect_SignCounter

  param numword

  type numword

  int

  param mode

  default value is IFSelect_CountByItem

  type mode

  IFSelect_PrintCount

  rtype

  IFSelect_ReturnStatus

Library()

• Returns the WorKlibrary (Null if not set). WorkLibrary is used to Read and Write Files, according to the Norm

  rtype

  opencascade::handle<IFSelect_WorkLibrary>

NbCommands()

• Returns the count of recorded Commands

  rtype

  int

NbWords()

• Returns the count of words of the Command Line, separated by blanks0 if empty, one if a command without args, else it gives the count of args minus one. Warninglimited to 10 (command title + 9 args)

  rtype

  int

Number()

• Interprets a string value as an entity numberif it gives an integer, returns its value else, considers it as ENtityLabel (preferably case sensitive) in case of failure, returns 0

  param val

  type val

  char *

  rtype

  int

Perform()

• Executes the Command, itself (for built-in commands, which have priority) or by using the list of Activators. The value returned isRetVoid if nothing done (void command) RetDone if execution OK, RetEnd if END OF SESSION, RetError if command unknown or incorrect, RetFail if error on execution If execution is OK and RecordMode is set, this Command Line is recorded to the list (see below).

  rtype

  IFSelect_ReturnStatus

ReadScript()

• Reads commands from a Script File, named <file>. By default (file = ‘’), reads from standard input with a prompt Else (reading from a file), the read commands are displayed onto standard output. Allows nested reads. Reading is stopped either by command x or exit, or by reaching end of file Return Value follows the rules of DoRetEnd for normal end, RetFail if script could not be opened

  param file

  default value is

  type file

  char *

  rtype

  IFSelect_ReturnStatus

RecordItem()

• Allows to associate a Transient Value with the last execution as a partial result Returns RetDone if item is not Null, RetFail if item is Null Remarkit is nullified for each Perform

  param item

  type item

  Standard_Transient

  rtype

  IFSelect_ReturnStatus

RecordMode()

• Returns the Record Mode for Commands. Default is False.

  rtype

  bool

RecordedItem()

• Returns the Transient Object which was recorded with the current Line Command. If none was, returns a Null Handle

  rtype

  opencascade::handle<Standard_Transient>

RemoveWord()

• Removes a word given its rank. Returns True if Done, False if <num> is out of range

  param num

  type num

  int

  rtype

  bool

Session()

• Returns the WorkSession which is worked on

  rtype

  opencascade::handle<IFSelect_WorkSession>

SetCommandLine()

• Sets the value of the Command Line to be interpreted Also prepares the interpretation (splitting by blanks)

  param command

  type command

  TCollection_AsciiString

  rtype

  None

SetLibrary()

• Sets a WorkLibrary

  param WL

  type WL

  IFSelect_WorkLibrary

  rtype

  None

SetRecordMode()

• Changes the RecordMode.

  param mode

  type mode

  bool

  rtype

  None

SetSession()

• Sets a WorkSession to be worked on

  param WS

  type WS

  IFSelect_WorkSession

  rtype

  None

Word()

• Returns a word given its rank in the Command Line. Begins at 0 which is the Command Title, 1 is the 1st arg., etc…

  param num

  type num

  int

  rtype

  TCollection_AsciiString

property thisown

The membership flag

class IFSelect_ShareOut(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an empty ShareOut

  rtype

  None

AddDispatch()

• Adds a Dispatch to the list

  param disp

  type disp

  IFSelect_Dispatch

  rtype

  None

AddModif()

• Adds a Modifier to the list of ModifiersModel Modifiers if <formodel> is True, File Modifiers else (internal).

  param modifier

  type modifier

  IFSelect_GeneralModifier

  param formodel

  type formodel

  bool

  param atnum

  default value is 0

  type atnum

  int

  rtype

  None

AddModifier()

• Sets a Modifier to be applied on all Dispatches to be run If <modifier> is a ModelModifier, adds it to the list of Model Modifiers; else to the list of File Modifiers By default (atnum = 0) at the end of the list, else at <atnum> Each Modifier is used, after each copy of a packet of Entities into a Modelits criteria are checked and if they are OK, the method Perform of this Modifier is run.

  param modifier

  type modifier

  IFSelect_GeneralModifier

  param atnum

  type atnum

  int

  rtype

  None* Sets a Modifier to be applied on the Dispatch <dispnum> If <modifier> is a ModelModifier, adds it to the list of Model Modifiers; else to the list of File Modifiers This is the same list as for all Dispatches, but the Modifier is qualified to be applied to one Dispatch only Then, <atnum> refers to the entire list By default (atnum = 0) at the end of the list, else at <atnum> Remark : if the Modifier was already in the list and if <atnum> = 0, the Modifier is not moved, but only qualified for a Dispatch

  param modifier

  type modifier

  IFSelect_GeneralModifier

  param dispnum

  type dispnum

  int

  param atnum

  type atnum

  int

  rtype

  None

ChangeModifierRank()

• Changes the rank of a modifier in the listModel Modifiers if <formodel> is True, File Modifiers else from <before> to <after> Returns True if done, False else (before or after out of range)

  param formodel

  type formodel

  bool

  param befor

  type befor

  int

  param after

  type after

  int

  rtype

  bool

Clear()

• Removes in one operation all the Dispatches with their Idents Also clears all informations about Names, and all Results but naming informations which are- kept if <onlydisp> is True. - cleared if <onlydisp> is False (complete clearing) If <onlydisp> is True, that’s all. Else, clears also Modifiers

  param onlydisp

  type onlydisp

  bool

  rtype

  None

ClearResult()

• Clears all data produced (apart from Dispatches, etc…) if <alsoname> is True, all is cleared. Else, informations about produced Names are kept (to maintain unicity of naming across clearings)

  param alsoname

  type alsoname

  bool

  rtype

  None

DefaultRootName()

• Returns the Default Root Name. Can be empty.

  rtype

  opencascade::handle<TCollection_HAsciiString>

Dispatch()

• Returns a Dispatch, given its rank in the list

  param num

  type num

  int

  rtype

  opencascade::handle<IFSelect_Dispatch>

DispatchRank()

• Returns the Rank of a Dispatch, given its Value (Handle). Returns 0 if the Dispatch is unknown in the ShareOut

  param disp

  type disp

  IFSelect_Dispatch

  rtype

  int

static DownCast(t)

Extension()

• Returns the general Extension. Can be empty (not recommanded)

  rtype

  opencascade::handle<TCollection_HAsciiString>

FileName()

• Computes the complete file name for a Packet of a Dispatch, given Dispatch Number (Rank), Packet Number, and Count of Packets generated by this Dispatch (0 if unknown) //! File Name is made of following strings, concatenatedGeneral Prefix, Root Name for Dispatch, Packet Suffix, and General Extension. If no Root Name is specified for a Dispatch, DefaultRootName is considered (and pnum is not used, but <thenbdefs> is incremented and used Error if no Root is defined for this <idnum>

  param dnum

  type dnum

  int

  param pnum

  type pnum

  int

  param nbpack

  default value is 0

  type nbpack

  int

  rtype

  TCollection_AsciiString

GeneralModifier()

• Returns a Modifier of the list, given its rankModel Modifiers if <formodel> is True, File Modifiers else

  param formodel

  type formodel

  bool

  param num

  type num

  int

  rtype

  opencascade::handle<IFSelect_GeneralModifier>

HasRootName()

• Returns True if the Dispatch of rank <num> has an attached Root Name. False else, or if num is out of range

  param num

  type num

  int

  rtype

  bool

LastRun()

• Returns the rank of last run item (ClearResult resets it to 0)

  rtype

  int

ModelModifier()

• Returns a Modifier of the list of Model Modifiers, duely casted

  param num

  type num

  int

  rtype

  opencascade::handle<IFSelect_Modifier>

ModifierRank()

• Gives the rank of a Modifier in the list, 0 if not in the list Model Modifiers if <modifier> is kind of ModelModifer, File Modifiers else

  param modifier

  type modifier

  IFSelect_GeneralModifier

  rtype

  int

NbDispatches()

• Returns the count of Dispatches

  rtype

  int

NbModifiers()

• Returns count of Modifiers (which apply to complete Models)Model Modifiers if <formodel> is True, File Modifiers else

  param formodel

  type formodel

  bool

  rtype

  int

Prefix()

• Returns the general Prefix. Can be empty.

  rtype

  opencascade::handle<TCollection_HAsciiString>

RemoveDispatch()

• Removes a Dispatch, given its rank in the list Returns True if done, False if rank is not between (LastRun + 1) and (NbDispatches)

  param rank

  type rank

  int

  rtype

  bool

RemoveItem()

• Removes an item, which can be, either a Dispatch (removed from the list of Dispatches), or a GeneralModifier (removed from the list of Model Modifiers or from the list of File Modifiers according to its type). Returns True if done, False if has not been found or if it is neither a Dispatch, nor a Modifier.

  param item

  type item

  Standard_Transient

  rtype

  bool

RemoveModifier()

• Removes a Modifier, given it rank in the listModel Modifiers if <formodel> is True, File Modifiers else Returns True if done, False if <num> is out of range

  param formodel

  type formodel

  bool

  param num

  type num

  int

  rtype

  bool

RootName()

• Returns the Root bound to a Dispatch, given its rank Returns a Null Handle if not defined

  param num

  type num

  int

  rtype

  opencascade::handle<TCollection_HAsciiString>

RootNumber()

• Returns an integer value about a given root name- positiveit’s the rank of the Dispatch which has this name - nullthis root name is unknown - negative (-1)this root name is the default root name

  param name

  type name

  TCollection_HAsciiString

  rtype

  int

SetDefaultRootName()

• Defines or Changes the Default Root Name to a new value (which is used for dispatches which have no attached root name). If this method is not called, DefaultRootName remains empty Returns True if OK, False if this Name is already attached, for a Dispatch or for Default

  param defrt

  type defrt

  TCollection_HAsciiString

  rtype

  bool

SetExtension()

• Defines or Changes the general Extension (which is appended to complete file name generated). If this method is not call, Extension remains empty

  param ext

  type ext

  TCollection_HAsciiString

  rtype

  None

SetLastRun()

• Records a new alue for the rank of last run item

  param last

  type last

  int

  rtype

  None

SetPrefix()

• Defines or Changes the general Prefix (which is prepended to complete file name generated). If this method is not call, Prefix remains empty

  param pref

  type pref

  TCollection_HAsciiString

  rtype

  None

SetRootName()

• Attaches a Root Name to a Dispatch given its rank, as an HAsciiString (standard form). A Null Handle resets this name. Returns True if OK, False if this Name is already attached, for a Dispatch or for Default, or <num> out of range

  param num

  type num

  int

  param name

  type name

  TCollection_HAsciiString

  rtype

  bool

property thisown

The membership flag

class IFSelect_ShareOutResult(*args)

Bases: object

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

  param sho

  type sho

  IFSelect_ShareOut

  param mod

  type mod

  Interface_InterfaceModel

  rtype

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

  param sho

  type sho

  IFSelect_ShareOut

  param G

  type G

  Interface_Graph

  rtype

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

  param disp

  type disp

  IFSelect_Dispatch

  param mod

  type mod

  Interface_InterfaceModel

  rtype

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

  param disp

  type disp

  IFSelect_Dispatch

  param G

  type G

  Interface_Graph

  rtype

  None

Dispatch()

• Returns the current Dispatch

  rtype

  opencascade::handle<IFSelect_Dispatch>

DispatchRank()

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

  rtype

  int

Evaluate()

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

  rtype

  None

FileName()

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

  rtype

  TCollection_AsciiString

Graph()

• Returns the Graph used to create theShareOutResult

  rtype

  Interface_Graph

More()

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

  rtype

  bool

NbPackets()

• Returns the total count of produced non empty packets (in outcalls Evaluate as necessary)

  rtype

  int

Next()

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

  rtype

  None

NextDispatch()

• Passes to the next Dispatch, regardless about remaining packets

  rtype

  None

PacketContent()

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

  rtype

  Interface_EntityIterator

PacketRoot()

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

  rtype

  Interface_EntityIterator

Packets()

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

  param complete

  default value is Standard_True

  type complete

  bool

  rtype

  opencascade::handle<IFSelect_PacketList>

PacketsInDispatch()

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

  param numpack

  type numpack

  int

  param nbpacks

  type nbpacks

  int

  rtype

  None

Prepare()

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

  rtype

  None

Reset()

• Erases computed data, in order to command a new Evaluation

  rtype

  None

ShareOut()

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

  rtype

  opencascade::handle<IFSelect_ShareOut>

property thisown

The membership flag

class IFSelect_SignAncestor(*args)

Bases: OCC.Core.IFSelect.IFSelect_SignType

Parameters

nopk – default value is Standard_False :type nopk: bool :rtype: None

static DownCast(t)

property thisown

The membership flag

class IFSelect_SignCategory(*args)

Bases: OCC.Core.IFSelect.IFSelect_Signature

• Returns a SignCategory

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_SignCounter(*args)

Bases: OCC.Core.IFSelect.IFSelect_SignatureList

• Creates a SignCounter, without proper Signature If <withmap> is True (default), added entities are counted only if they are not yet recorded in the map Map control can be set off if the input garantees uniqueness of data <withlist> is transmitted to SignatureList (option to list entities, not only to count them).

  param withmap

  default value is Standard_True

  type withmap

  bool

  param withlist

  default value is Standard_False

  type withlist

  bool

  rtype

  None* Creates a SignCounter, with a predefined Signature Other arguments as for Create without Signature.

  param matcher

  type matcher

  IFSelect_Signature

  param withmap

  default value is Standard_True

  type withmap

  bool

  param withlist

  default value is Standard_False

  type withlist

  bool

  rtype

  None

AddEntity()

• Adds an entity by considering its signature, which is given by call to method AddSign Returns True if added, False if already in the map (and map control status set)

  param ent

  type ent

  Standard_Transient

  param model

  type model

  Interface_InterfaceModel

  rtype

  bool

AddFromSelection()

• Adds the result determined by a Selection from a Graph Remarkdoes not impact at all data from SetSelection & Co

  param sel

  type sel

  IFSelect_Selection

  param G

  type G

  Interface_Graph

  rtype

  None

AddList()

• Adds a list of entities by adding each of the items

  param list

  type list

  TColStd_HSequenceOfTransient

  param model

  type model

  Interface_InterfaceModel

  rtype

  None

AddModel()

• Adds all the entities contained in a Model

  param model

  type model

  Interface_InterfaceModel

  rtype

  None

AddSign()

• Adds an entity (already filtered by Map) with its signature. This signature can be computed with the containing model. Its value is provided by the object Signature given at start, if no Signature is defined, it does nothing. //! Can be redefined (in this case, see also Sign)

  param ent

  type ent

  Standard_Transient

  param model

  type model

  Interface_InterfaceModel

  rtype

  void

AddWithGraph()

• Adds a list of entities in the context given by the graph Default just call basic AddList Can be redefined to get a signature computed with the graph

  param list

  type list

  TColStd_HSequenceOfTransient

  param graph

  type graph

  Interface_Graph

  rtype

  void

ComputeSelected()

• Computes from the selection result, if selection is active (mode 2). If selection is not defined (mode 0) or is inhibited (mode 1) does nothing. Returns True if computation is done (or optimised), False else This method is called by ComputeCounter from WorkSession //! If <forced> is True, recomputes systematically Else (D), if the counter was not cleared and if the former computed result started from the same total size of Graph and same count of selected entitiescomputation is not redone unless <forced> is given as True

  param G

  type G

  Interface_Graph

  param forced

  default value is Standard_False

  type forced

  bool

  rtype

  bool

ComputedSign()

• Applies AddWithGraph on one entity, and returns the Signature Value which has been recorded To do this, Add is called with SignOnly Mode True during the call, the returned value is LastValue

  param ent

  type ent

  Standard_Transient

  param G

  type G

  Interface_Graph

  rtype

  char *

static DownCast(t)

SelMode()

• Returns the mode of working with the selection

  rtype

  int

Selection()

• Returns the selection, or a null Handle

  rtype

  opencascade::handle<IFSelect_Selection>

SetMap()

• Changes the control status. The map is not cleared, simply its use changes

  param withmap

  type withmap

  bool

  rtype

  None

SetSelMode()

• Changes the mode of working with the selection-1 just clears optimisation data and nothing else 0 clears it 1 inhibits it for computing (but no clearing) 2 sets it active for computing Default at creation is 0, after SetSelection (not null) is 2

  param selmode

  type selmode

  int

  rtype

  None

SetSelection()

• Sets a Selection as inputthis causes content to be cleared then the Selection to be ready to compute (but not immediatly)

  param sel

  type sel

  IFSelect_Selection

  rtype

  None

Sign()

• Determines and returns the value of the signature for an entity as an HAsciiString. This method works exactly as AddSign, which is optimized //! Can be redefined, accorded with AddSign

  param ent

  type ent

  Standard_Transient

  param model

  type model

  Interface_InterfaceModel

  rtype

  opencascade::handle<TCollection_HAsciiString>

Signature()

• Returns the Signature used to count entities. It can be null.

  rtype

  opencascade::handle<IFSelect_Signature>

property thisown

The membership flag

class IFSelect_SignMultiple(*args)

Bases: OCC.Core.IFSelect.IFSelect_Signature

• Creates an empty SignMultiple with a Name This name should take expected tabulations into account

  param name

  type name

  char *

  rtype

  None

Add()

• Adds a Signature. Width, if given, gives the tabulation If <maxi> is True, it is a forced tabulation (overlength is replaced by a final dot) If <maxi> is False, just 3 blanks follow an overlength

  param subsign

  type subsign

  IFSelect_Signature

  param width

  default value is 0

  type width

  int

  param maxi

  default value is Standard_False

  type maxi

  bool

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_SignType(*args)

Bases: OCC.Core.IFSelect.IFSelect_Signature

• Returns a SignType <nopk> false (D)complete dynamic type (name = Dynamic Type) <nopk> trueclass type without pk (name = Class Type)

  param nopk

  default value is Standard_False

  type nopk

  bool

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class IFSelect_SignValidity(*args)

Bases: OCC.Core.IFSelect.IFSelect_Signature

• Returns a SignValidity

  rtype

  None

static CVal()

• Returns the Signature for a Transient object, as a validity deducted from data (reports) stored in the model. Class method, can be called by any one

  param ent

  type ent

  Standard_Transient

  param model

  type model

  Interface_InterfaceModel

  rtype

  char *

static DownCast(t)

property thisown

The membership flag

class IFSelect_Signature(*args, **kwargs)

Bases: OCC.Core.Interface.Interface_SignType

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

AddCase()

• Adds a possible case To be called when creating, IF the list of possible cases for Value is known when starting For instance, for CDL types, rather do not fill this, but for a specific enumeration (such as a status), can be used

  param acase

  type acase

  char *

  rtype

  None

CaseList()

• Returns the predefined list of possible cases, filled by AddCase Null Handle if no predefined list (hence, to be counted) Useful to filter on really possible vase, for instance, or for a help

  rtype

  opencascade::handle<TColStd_HSequenceOfAsciiString>

static DownCast(t)

static IntValue()

• This procedure converts an Integer to a CString It is a convenient way when the value of a signature has the form of a simple integer value The value is to be used immediately (one buffer only, no copy)

  param val

  type val

  int

  rtype

  char *

IsIntCase()

• Tells if this Signature gives integer values and returns values from SetIntCase if True

  param hasmin

  type hasmin

  bool

  param valmin

  type valmin

  int

  param hasmax

  type hasmax

  bool

  param valmax

  type valmax

  int

  rtype

  bool

Label()

• The label of a Signature uses its name as follow‘Signature<name>’

  rtype

  TCollection_AsciiString

static MatchValue()

• Default procedure to tell if a value <val> matches a text with a criterium <exact>. <exact> = True requires equality, else only contained (no reg-exp)

  param val

  type val

  char *

  param text

  type text

  TCollection_AsciiString

  param exact

  type exact

  bool

  rtype

  bool

Matches()

• Tells if the value for <ent> in <model> matches a text, with a criterium <exact>. The default definition calls MatchValue Can be redefined

  param ent

  type ent

  Standard_Transient

  param model

  type model

  Interface_InterfaceModel

  param text

  type text

  TCollection_AsciiString

  param exact

  type exact

  bool

  rtype

  bool

SetIntCase()

• Sets the information data to tell ‘integer cases’ with possible min and max values To be called when creating

  param hasmin

  type hasmin

  bool

  param valmin

  type valmin

  int

  param hasmax

  type hasmax

  bool

  param valmax

  type valmax

  int

  rtype

  None

property thisown

The membership flag

class IFSelect_SignatureList(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates a SignatureList. If <withlist> is True, entities will be not only counted per signature, but also listed.

  param withlist

  default value is Standard_False

  type withlist

  bool

  rtype

  None

Add()

• Adds an entity with its signature, i.e.- counts an item more for <sign> - if record-list status is set, records the entity Accepts a null entity (the signature is then for the global model). But if the string is empty, counts a Null item. //! If SignOnly Mode is set, this work is replaced by just setting LastValue

  param ent

  type ent

  Standard_Transient

  param sign

  type sign

  char *

  rtype

  None

Clear()

Return type

void

static DownCast(t)

Entities()

• Returns the list of entities attached to a signature It is empty if <sign> has not been recorded It is a Null Handle if the list of entities is not known

  param sign

  type sign

  char *

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

GetModeSignOnly(IFSelect_SignatureList self) → Standard_Boolean

HasEntities()

• Returns True if the list of Entities is aknowledged, else the method Entities will always return a Null Handle

  rtype

  bool

Init()

• Aknowledges the list in once. Name identifies the Signature

  param name

  type name

  char *

  param count

  type count

  NCollection_IndexedDataMap<TCollection_AsciiString, int>

  param list

  type list

  Standard_Transient

  param nbnuls

  type nbnuls

  int

  rtype

  None

LastValue()

• Returns the last value recorded by Add (only if SignMode set) Cleared by Clear or Init

  rtype

  char *

List()

• Returns the list of signatures, as a sequence of strings (but without their respective counts). It is ordered. By default, for all the signatures. If <root> is given non empty, for the signatures which begin by <root>

  param root

  default value is

  type root

  char *

  rtype

  opencascade::handle<TColStd_HSequenceOfHAsciiString>

Name()

• Returns the recorded Name. Remarkdefault is ‘…’ (no SetName called)

  rtype

  char *

NbNulls()

• Returns the count of null entities

  rtype

  int

NbTimes()

• Returns the number of times a signature was counted, 0 if it has not been recorded at all

  param sign

  type sign

  char *

  rtype

  int

PrintCount()

• Prints the counts of items (not the list)

  param S

  type S

  Message_Messenger

  rtype

  void

PrintList()

• Prints the lists of items, if they are present (else, prints a message ‘no list available’) Uses <model> to determine for each entity to be listed, its number, and its specific identifier (by PrintLabel) <mod> gives a mode for printing- CountByItemjust count (as PrintCount) - ShortByItemminimum i.e. count plus 5 first entity numbers - ShortByItem(D) complete list of entity numbers (0: ‘Global’) - EntitiesByItemlist of (entity number/PrintLabel from the model) other modes are ignored

  param S

  type S

  Message_Messenger

  param model

  type model

  Interface_InterfaceModel

  param mod

  default value is IFSelect_ListByItem

  type mod

  IFSelect_PrintCount

  rtype

  void

PrintSum()

• Prints a summary Item which has the greatest count of entities For items which are numeric valuestheir count, maximum, minimum values, cumul, average

  param S

  type S

  Message_Messenger

  rtype

  void

SetList()

• Changes the record-list status. The list is not cleared but its use changes

  param withlist

  type withlist

  bool

  rtype

  None

SetModeSignOnly(IFSelect_SignatureList self, Standard_Boolean value)

SetName()

• Defines a name for a SignatureList (used to print it)

  param name

  type name

  char *

  rtype

  None

property thisown

The membership flag

class IFSelect_TSeqOfDispatch(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class IFSelect_TSeqOfSelection(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class IFSelect_TransformStandard(*args)

Bases: OCC.Core.IFSelect.IFSelect_Transformer

• Creates a TransformStandard, option StandardCopy, no Modifier

  rtype

  None

AddModifier()

• Adds a Modifier to the list- <atnum> = 0 (default)at the end of the list - <atnum> > 0at rank <atnum> Returns True if done, False if <atnum> is out of range

  param modif

  type modif

  IFSelect_Modifier

  param atnum

  default value is 0

  type atnum

  int

  rtype

  bool

ApplyModifiers()

• Applies the modifiers sequencially. For each one, prepares required data (if a Selection is associated as a filter). For the option OnTheSpot, it determines if the graph may be changed and updates <newmod> if required If a Modifier causes an error (check ‘HasFailed’), ApplyModifier stopsthe following Modifiers are ignored

  param G

  type G

  Interface_Graph

  param protocol

  type protocol

  Interface_Protocol

  param TC

  type TC

  Interface_CopyTool

  param checks

  type checks

  Interface_CheckIterator

  param newmod

  type newmod

  Interface_InterfaceModel

  rtype

  bool

Copy()

• This the first operation. It calls StandardCopy or OnTheSpot according the option

  param G

  type G

  Interface_Graph

  param TC

  type TC

  Interface_CopyTool

  param newmod

  type newmod

  Interface_InterfaceModel

  rtype

  None

CopyOption()

• Returns the Copy option

  rtype

  bool

static DownCast(t)

Modifier()

• Returns a Modifier given its rank in the list

  param num

  type num

  int

  rtype

  opencascade::handle<IFSelect_Modifier>

ModifierRank()

• Returns the rank of a Modifier in the list, 0 if unknown

  param modif

  type modif

  IFSelect_Modifier

  rtype

  int

NbModifiers()

• Returns the count of recorded Modifiers

  rtype

  int

OnTheSpot()

• This is the OnTheSpot actioneach entity is bound with … itself. The produced model is the same as the starting one.

  param G

  type G

  Interface_Graph

  param TC

  type TC

  Interface_CopyTool

  param newmod

  type newmod

  Interface_InterfaceModel

  rtype

  None

RemoveModifier()

• Removes a Modifier from the list Returns True if done, False if <modif> not in the list

  param modif

  type modif

  IFSelect_Modifier

  rtype

  bool* Removes a Modifier from the list, given its rank Returns True if done, False if <num> is out of range

  param num

  type num

  int

  rtype

  bool

Selection()

• Returns the Selection, Null by default

  rtype

  opencascade::handle<IFSelect_Selection>

SetCopyOption()

• Sets the Copy option to a new value- True for StandardCopy - False for OnTheSpot

  param option

  type option

  bool

  rtype

  None

SetSelection()

• Sets a Selection (or unsets if Null) This Selection then defines the list of entities on which the Modifiers will be applied If it is set, it has priority on Selections of Modifiers Else, for each Modifier its Selection is evaluated By default, all the Model is taken

  param sel

  type sel

  IFSelect_Selection

  rtype

  None

StandardCopy()

• This is the standard action of Copyits takes into account only the remaining entities (noted by Graph Status positive) and their proper dependances of course. Produces a new model.

  param G

  type G

  Interface_Graph

  param TC

  type TC

  Interface_CopyTool

  param newmod

  type newmod

  Interface_InterfaceModel

  rtype

  None

property thisown

The membership flag

class IFSelect_Transformer(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

ChangeProtocol()

• This methods allows to declare that the Protocol applied to the new Model has changed. It applies to the last call to Perform. //! Returns True if the Protocol has changed, False else. The provided default keeps the starting Protocol. This method should be redefined as required by the effect of Perform.

  param newproto

  type newproto

  Interface_Protocol

  rtype

  bool

static DownCast(t)

Label()

• Returns a text which defines the way a Transformer works (to identify the transformation it performs)

  rtype

  TCollection_AsciiString

Perform()

• Performs a Transformation (defined by each sub-class)<G> gives the input data (especially the starting model) and can be used for queries (by Selections, etc…) <protocol> allows to work with General Services as necessary (it applies to input data) If the change corresponds to a conversion to a new protocol, see also the method ChangeProtocol <checks> stores produced checks messages if any <newmod> gives the result of the transformation- if it is Null (i.e. has not been affected), the transformation has been made on the spot, it is assumed to cause no change to the graph of dependances - if it equates the starting Model, it has been transformed on the spot (possibiliy some entities were replaced inside it) - if it is new, it corresponds to a new data set which replaces the starting one //! <self> is mutable to allow results for ChangeProtocol to be memorized if needed, and to store informations useful for the method Updated //! Returns True if Done, False if an Error occuredin this case, if a new data set has been produced, the transformation is ignored, else data may be corrupted.

  param G

  type G

  Interface_Graph

  param protocol

  type protocol

  Interface_Protocol

  param checks

  type checks

  Interface_CheckIterator

  param newmod

  type newmod

  Interface_InterfaceModel

  rtype

  bool

Updated()

• This method allows to know what happened to a starting entity after the last Perform. If <entfrom> (from starting model) has one and only one known item which corresponds in the new produced model, this method must return True and fill the argument <entto>. Else, it returns False.

  param entfrom

  type entfrom

  Standard_Transient

  param entto

  type entto

  Standard_Transient

  rtype

  bool

property thisown

The membership flag

class IFSelect_WorkLibrary(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

CopyModel()

• Performs the copy of entities from an original model to a new one. It must also copy headers if any. Returns True when done. The provided default works by copying the individual entities designated in the list, by using the general service class CopyTool. It can be redefined for a norm which, either implements Copy by another way (do not forget to Bind each copied result with its original entity in TC) and returns True, or does not know how to copy and returns False

  param original

  type original

  Interface_InterfaceModel

  param newmodel

  type newmodel

  Interface_InterfaceModel

  param list

  type list

  Interface_EntityIterator

  param TC

  type TC

  Interface_CopyTool

  rtype

  bool

static DownCast(t)

DumpEntity()

• Gives the way of dumping an entity under a form comprehensive for each norm. <model> helps to identify, number … entities. <level> is to be interpreted for each norm (because of the formats which can be very different)

  param model

  type model

  Interface_InterfaceModel

  param protocol

  type protocol

  Interface_Protocol

  param entity

  type entity

  Standard_Transient

  param S

  type S

  Message_Messenger

  param level

  type level

  int

  rtype

  void* Calls deferred DumpEntity with the recorded default level

  param model

  type model

  Interface_InterfaceModel

  param protocol

  type protocol

  Interface_Protocol

  param entity

  type entity

  Standard_Transient

  param S

  type S

  Message_Messenger

  rtype

  None

DumpHelp()

• Returns the help line recorded for <level>, or an empty string

  param level

  type level

  int

  rtype

  char *

DumpLevels()

• Returns the recorded default and maximum dump levels If none was recorded, max is returned negative, def as zero

  param def

  type def

  int

  param max

  type max

  int

  rtype

  None

ReadFile()

• Gives the way to Read a File and transfer it to a Model <mod> is the resulting Model, which has to be created by this method. In case of error, <mod> must be returned Null Return value is a status with free values. Simply, 0 is for ‘Execution OK’ The Protocol can be used to work (e.g. create the Model, read and recognize the Entities)

  param name

  type name

  char *

  param model

  type model

  Interface_InterfaceModel

  param protocol

  type protocol

  Interface_Protocol

  rtype

  int

SetDumpHelp()

• Records a short line of help for a level (0 - max)

  param level

  type level

  int

  param help

  type help

  char *

  rtype

  None

SetDumpLevels()

• Records a default level and a maximum value for level level for DumpEntity can go between 0 and <max> default value will be <def>

  param def

  type def

  int

  param max

  type max

  int

  rtype

  None

WriteFile()

• Gives the way to Write a File from a Model. <ctx> contains all necessary informationsthe model, the protocol, the file name, and the list of File Modifiers to be applied, also with restricted list of selected entities for each one, if required. In return, it brings the produced check-list //! The WorkLibrary has to query <applied> to get then run the ContextWrite by looping like this (example)for (numap = 1; numap <= ctx.NbModifiers(); numap ++) { ctx.SetModifier (numap); cast ctx.FileModifier() to specific type -> variable filemod if (!filemod.IsNull()) filemod->Perform (ctx,writer); filemod then works with ctx. It can, either act on the model itself (for instance on its header), or iterate on selected entities (Start/Next/More/Value) it can call AddFail or AddWarning, as necessary }

  param ctx

  type ctx

  IFSelect_ContextWrite

  rtype

  bool

property thisown

The membership flag

class IFSelect_WorkSession(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates a Work Session It provides default, empty ShareOut and ModelCopier, which can be replaced (if required, should be done just after creation).

  rtype

  None

AddItem()

• Adds an Item and returns its attached Ident. Does nothing if <item> is already recorded (and returns its attached Ident) <active> if True commands call to SetActive (see below) Remarkthe determined Ident is used if <item> is a Dispatch, to fill the ShareOut

  param item

  type item

  Standard_Transient

  param active

  default value is Standard_True

  type active

  bool

  rtype

  int

AddNamedItem()

• Adds an Item with an attached Name. If the Name is already known in the WorkSession, the older item losts it Returns Ident if Done, 0 else, i.e. if <item> is null If <name> is empty, works as AddItem (i.e. with no name) If <item> is already known but with no attached Name, this method tries to attached a Name to it <active> if True commands call to SetActive (see below)

  param name

  type name

  char *

  param item

  type item

  Standard_Transient

  param active

  default value is Standard_True

  type active

  bool

  rtype

  int

AppliedDispatches()

• Returns the ordered list of dispatches stored by the ShareOut

  rtype

  opencascade::handle<TColStd_HSequenceOfInteger>

BeginSentFiles()

• Commands file sending to clear the list of already sent files, commands to record a new one if <record> is True This list is managed by the ModelCopier when SendSplit is called It allows a global exploitation of the set of sent files

  param record

  type record

  bool

  rtype

  None

CategoryName()

• Returns the Category Name determined for an entity it is computed by the class Category Remarkan unknown entity gives an empty string

  param ent

  type ent

  Standard_Transient

  rtype

  char *

CategoryNumber()

• Returns the Category Number determined for an entity it is computed by the class Category An unknown entity (number 0) gives a value -1

  param ent

  type ent

  Standard_Transient

  rtype

  int

ChangeModifierRank()

• Changes the Rank of a Modifier in the SessionModel Modifiers if <formodel> is True, File Modifiers else the Modifier n0 <before> is put to n0 <after> Return True if Done, False if <before> or <after> out of range

  param formodel

  type formodel

  bool

  param before

  type before

  int

  param after

  type after

  int

  rtype

  bool

CheckOne()

• Returns a Check for a single entity, under the form of a CheckIterator (this gives only one form for the user) if <ent> is Null or equates the current Model, it gives the Global Check, else the Check for the given entity <complete> as for ModelCheckList

  param ent

  type ent

  Standard_Transient

  param complete

  default value is Standard_True

  type complete

  bool

  rtype

  Interface_CheckIterator

ClearData()

• Clears recorded data (not the items) according mode1all DataModel, Graph, CheckList, + ClearData 4 2Graph and CheckList (they will then be recomputed later) 3CheckList (it will be recomputed by ComputeCheck) 4just content of SelectPointed and Counters Plus 0does nothing but called by SetModel ClearData is virtual, hence it can be redefined to clear other data of a specialised Work Session

  param mode

  type mode

  int

  rtype

  void

ClearFile()

• Erases all stored data from the File Evaluation (i.e. ALL former naming informations are lost)

  rtype

  None

ClearFinalModifiers()

• Removes all the Modifiers active in the ModelCopierthey become inactive and they are removed from the Session

  rtype

  None

ClearItems()

• Clears all the recorded ItemsSelections, Dispatches, Modifiers, and Strings & IntParams, with their Idents & Names. Remark that if a Model has been loaded, it is not cleared.

  rtype

  None

ClearShareOut()

• Clears the list of Dispatches recorded by the ShareOut if <only> disp is True, tha’s all. Else, clears also the lists of Modifiers recorded by the ShareOut

  param onlydisp

  type onlydisp

  bool

  rtype

  None

CombineAdd()

• Adds an input selection to a SelectCombine (Union or Inters.). Returns new count of inputs for this SelectCombine if Done or 0 if <sel> is not kind of SelectCombine, or if <seladd> or <sel> is not in the WorkSession By default, adding is done at the end of the list Else, it is an insertion to rank <atnum> (usefull for Un-ReDo)

  param selcomb

  type selcomb

  IFSelect_Selection

  param seladd

  type seladd

  IFSelect_Selection

  param atnum

  default value is 0

  type atnum

  int

  rtype

  int

CombineRemove()

• Removes an input selection from a SelectCombine (Union or Intersection). Returns True if done, False if <selcomb> is not kind of SelectCombine or <selrem> is not source of <selcomb>

  param selcomb

  type selcomb

  IFSelect_Selection

  param selrem

  type selrem

  IFSelect_Selection

  rtype

  bool

ComputeCheck()

• Computes the CheckList for the Model currently loaded It can then be used for displays, querries … Returns True if OK, False else (i.e. no Protocol set, or Model absent). If <enforce> is False, works only if not already done or if a new Model has been loaded from last call. Remarkcomputation is enforced by every call to SetModel or RunTransformer

  param enforce

  default value is Standard_False

  type enforce

  bool

  rtype

  bool

ComputeCounter()

• Computes the content of a SignCounter when it is defined with a Selection, then returns True Returns False if the SignCounter is not defined with a Selection, or if its Selection Mode is inhibited <forced> to work around optimisations

  param counter

  type counter

  IFSelect_SignCounter

  param forced

  default value is Standard_False

  type forced

  bool

  rtype

  bool

ComputeCounterFromList()

• Computes the content of a SignCounter from an input list If <list> is Null, uses internal definition of the Countera Selection, else the whole Model (recomputation forced) If <clear> is True (D), starts from scratch Else, cumulates computations

  param counter

  type counter

  IFSelect_SignCounter

  param list

  type list

  TColStd_HSequenceOfTransient

  param clear

  default value is Standard_True

  type clear

  bool

  rtype

  bool

ComputeGraph()

• Computes the Graph used for Selections, Displays … If a HGraph is already set, with same model as given by method Model, does nothing. Else, computes a new Graph. If <enforce> is given True, computes a new Graph anyway. Remark that a call to ClearGraph will cause ComputeGraph to really compute a new Graph Returns True if Graph is OK, False else (i.e. if no Protocol is set, or if Model is absent or empty).

  param enforce

  default value is Standard_False

  type enforce

  bool

  rtype

  bool

DefaultFileRoot()

• Returns the defined Default File Root. It is used for Dispatches which have no specific root attached. Null Handle if not defined

  rtype

  opencascade::handle<TCollection_HAsciiString>

Dispatch()

• Returns a Dispatch, given its Ident in the Session Null result if <id> is not suitable for a Dispatch (undefined, or defined for another kind of variable)

  param id

  type id

  int

  rtype

  opencascade::handle<IFSelect_Dispatch>

DispatchRank()

• Returns the rank of a Dispatch in the ShareOut, or 0 if <disp> is not in the ShareOut or not in the WorkSession

  param disp

  type disp

  IFSelect_Dispatch

  rtype

  int

static DownCast(t)

DumpEntity()

• Dumps a starting entity according to the current norm. To do this, it calls DumpEntity from WorkLibrary. <level> is to be interpreted for each normsee specific classes of WorkLibrary for it. Generally, 0 if for very basic (only type …), greater values give more and more details.

  param ent

  type ent

  Standard_Transient

  param level

  type level

  int

  param S

  type S

  Message_Messenger

  rtype

  None

DumpModel()

• Lists the content of the Input Model (if there is one) According level0 -> gives only count of Entities and Roots 1 -> Lists also Roots; 2 -> Lists all Entities (by TraceType) 3 -> Performs a call to CheckList (Fails) and lists the result 4 -> as 3 but all CheckList (Fails + Warnings) 5,6,7as 3 but resp. Count,List,Labels by Fail 8,9,10as 4 but resp. Count,List,Labels by message

  param level

  type level

  int

  param S

  type S

  Message_Messenger

  rtype

  None

DumpSelection()

• Lists a Selection and its Sources (see SelectionIterator), given its rank in the list

  param sel

  type sel

  IFSelect_Selection

  rtype

  None

DumpShare()

• Dumps contents of the ShareOut (on ‘cout’)

  rtype

  None

EntityLabel()

• Returns the label for <ent>, as the Model does If <ent> is not in the Model or if no Model is loaded, a Null Handle is returned

  param ent

  type ent

  Standard_Transient

  rtype

  opencascade::handle<TCollection_HAsciiString>

EntityName()

• Returns the Name of an Entity This Name is computed by the general service Name Returns a Null Handle if fails

  param ent

  type ent

  Standard_Transient

  rtype

  opencascade::handle<TCollection_HAsciiString>

EvalSelection()

• Evaluates the effect of a Selection applied on the input Model Returned Result remains empty if no input Model has been set

  param sel

  type sel

  IFSelect_Selection

  rtype

  Interface_EntityIterator

EvalSplit()

• Returns an Evaluation of the whole ShareOut definitioni.e. how the entities of the starting model are forecast to be sent to various fileslist of packets according the dispatches, effective lists of roots for each packet (which determine the content of the corresponding file); plus evaluation of which entities areforgotten (sent into no file), duplicated (sent into more than one file), sent into a given file. See the class PacketList for more details.

  rtype

  opencascade::handle<IFSelect_PacketList>

EvaluateComplete()

• Displays the effect of applying the ShareOut on the input Model. <mode> = 0 (default)displays only roots for each packet, <mode> = 1displays all entities for each packet, plus duplicated entities <mode> = 2same as <mode> = 1, plus displays forgotten entities (which are in no packet at all)

  param mode

  default value is 0

  type mode

  int

  rtype

  None

EvaluateDispatch()

• Displays the result of applying a Dispatch on the input Model (also shows Remainder if there is) <mode> = 0 (default), displays nothing else <mode> = 1displays also duplicated entities (because of this dispatch) <mode> = 2displays the entities of the starting Model which are not taken by this dispatch (forgotten entities) <mode> = 3displays both duplicated and forgotten entities RemarkEvaluateComplete displays these data evaluated for for all the dispatches, if there are several

  param disp

  type disp

  IFSelect_Dispatch

  param mode

  default value is 0

  type mode

  int

  rtype

  None

EvaluateFile()

• Performs and stores a File Evaluation. The Results are a List of produced Models and a List of names (Strings), in parallel Fills LastRunCheckList

  rtype

  None

EvaluateSelection()

• Displays the list of Entities selected by a Selection (i.e. the result of EvalSelection).

  param sel

  type sel

  IFSelect_Selection

  rtype

  None

FileExtension()

• Returns the defined File Extension. Null Handle if not defined

  rtype

  opencascade::handle<TCollection_HAsciiString>

FileModel()

• Returns a Model, given its rank in the Evaluation List

  param num

  type num

  int

  rtype

  opencascade::handle<Interface_InterfaceModel>

FileName()

• Returns the name of a file corresponding to a produced Model, given its rank in the Evaluation List

  param num

  type num

  int

  rtype

  TCollection_AsciiString

FilePrefix()

• Returns the defined File Prefix. Null Handle if not defined

  rtype

  opencascade::handle<TCollection_HAsciiString>

FileRoot()

• Returns the File Root defined for a Dispatch. Null if no Root Name is defined for it (hence, no File will be produced)

  param disp

  type disp

  IFSelect_Dispatch

  rtype

  opencascade::handle<TCollection_HAsciiString>

FinalModifierIdents()

• Fills a Sequence with a list of Idents, those attached to the Modifiers applied to final sending. Model Modifiers if <formodel> is True, File Modifiers else This list is given in the order in which they will be applied (which takes into account the Changes to Modifier Ranks)

  param formodel

  type formodel

  bool

  rtype

  opencascade::handle<TColStd_HSequenceOfInteger>

GeneralModifier()

• Returns a Modifier, given its Ident in the Session Null result if <id> is not suitable for a Modifier (undefined, or defined for another kind of variable)

  param id

  type id

  int

  rtype

  opencascade::handle<IFSelect_GeneralModifier>

GetModeStat()

• Return value of mode defining of filling selection during loading

  rtype

  bool

GiveFileComplete()

• Completes a file name as required, with Prefix and Extension (if defined; for a non-defined item, completes nothing)

  param file

  type file

  char *

  rtype

  char *

GiveFileRoot()

• Extracts File Root Name from a given complete file name (uses OSD_Path)

  param file

  type file

  char *

  rtype

  char *

GiveList()

• Determines a list of entities from an object<obj> already HSequenceOfTransientreturned itself <obj> Selectionits Result of Evaluation is returned <obj> an entity of the Modela HSequence which contains it else, an empty HSequence <obj> the Model it selfALL its content (not only the roots)

  param obj

  type obj

  Standard_Transient

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>* Computes a List of entities from two alphanums, first and second, as follows : if <first> is a Number or Label of an entity : this entity if <first> is a list of Numbers/Labels : the list of entities if <first> is the name of a Selection in <WS>, and <second> not defined, the standard result of this Selection else, let’s consider ‘first second’ : this whole phrase is splitted by blanks, as follows (RECURSIVE CALL) : - the leftest term is the final selection - the other terms define the result of the selection - and so on (the ‘leftest minus one’ is a selection, of which the input is given by the remaining …)

  param first

  type first

  char *

  param second

  default value is

  type second

  char *

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

GiveListCombined()

• Combines two lists and returns the result, according to mode<mode> < 0entities in <l1> AND NOT in <l2> <mode> = 0entities in <l1> AND in <l2> <mode> > 0entities in <l1> OR in <l2>

  param l1

  type l1

  TColStd_HSequenceOfTransient

  param l2

  type l2

  TColStd_HSequenceOfTransient

  param mode

  type mode

  int

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

GiveListFromList()

• Computes a List of entities from the model as follows <first> beeing a Selection or a combination of Selections, <ent> beeing an entity or a list of entities (as a HSequenceOfTransient)the standard result of this selection applied to this list if <ent> is Null, the standard definition of the selection is used (which contains a default input selection) if <selname> is erroneous, a null handle is returned //! REMARKselname is processed as <first second> of preceeding GiveList

  param selname

  type selname

  char *

  param ent

  type ent

  Standard_Transient

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

GiveSelection()

• Returns a Selection from a Name- the name of a Selectionthis Selection - the name of a Signature + criteria between (..)a new Selection from this Signature - an entity or a list of entitiesa new SelectPointed Else, returns a Null Handle

  param selname

  type selname

  char *

  rtype

  opencascade::handle<IFSelect_Selection>

Graph()

• Returns the Computed Graph, for Read only

  rtype

  Interface_Graph

HGraph()

• Returns the Computed Graph as HGraph (Null Handle if not set)

  rtype

  opencascade::handle<Interface_HGraph>

HasModel()

• Returns True is a Model has been set

  rtype

  bool

HasName()

• Returns True if an Item of the WorkSession has an attached Name

  param item

  type item

  Standard_Transient

  rtype

  bool

IntParam()

• Returns an IntParam, given its Ident in the Session Null result if <id> is not suitable for an IntParam (undefined, or defined for another kind of variable)

  param id

  type id

  int

  rtype

  opencascade::handle<IFSelect_IntParam>

IntValue()

• Returns Integer Value of an IntParam

  param it

  type it

  IFSelect_IntParam

  rtype

  int

IsLoaded()

• Returns True if a Model is defined and really loaded (not empty), a Protocol is set and a Graph has been computed. In this case, the WorkSession can start to work

  rtype

  bool

IsReversedSelectExtract()

• Returns True if <sel> a Reversed SelectExtract, False else

  param sel

  type sel

  IFSelect_Selection

  rtype

  bool

Item()

• Returns an Item, given its Ident. Returns a Null Handle if no Item corresponds to this Ident.

  param id

  type id

  int

  rtype

  opencascade::handle<Standard_Transient>

ItemIdent()

• Returns the Ident attached to an Item in the WorkSession, or Zero if it is unknown

  param item

  type item

  Standard_Transient

  rtype

  int

ItemIdents()

• Fills a Sequence with the List of Idents attached to the Items of which Type complies with (IsKind) <type> (alphabetic order) Remark<type> = TYPE(Standard_Transient) gives all the Idents which are suitable in the WorkSession

  param type

  type type

  Standard_Type

  rtype

  opencascade::handle<TColStd_HSequenceOfInteger>

ItemLabel()

• Returns a Label which illustrates the content of an Item, given its Ident. This Label is- for a Text Parameter, ‘Text:<text value>’ - for an Integer Parameter, ‘Integer:<integer value>’ - for a Selection, a Dispatch or a Modifier, its Label (see these classes) - for any other kind of Variable, its cdl type

  param id

  type id

  int

  rtype

  opencascade::handle<TCollection_HAsciiString>

ItemNames()

• Fills a Sequence with the list of the Names attached to Items of which Type complies with (IsKind) <type> (alphabetic order) Remark<type> = TYPE(Standard_Transient) gives all the Names

  param type

  type type

  Standard_Type

  rtype

  opencascade::handle<TColStd_HSequenceOfHAsciiString>

ItemNamesForLabel()

• Fills a Sequence with the NAMES of the control items, of which the label matches <label> (contain it)see NextIdentForLabel Search mode is fixed to ‘contained’ If <label> is empty, returns all Names

  param label

  type label

  char *

  rtype

  opencascade::handle<TColStd_HSequenceOfHAsciiString>

ItemSelection()

• Returns the Selection of a Dispatch or a GeneralModifier. Returns a Null Handle if none is defined or <item> not good type

  param item

  type item

  Standard_Transient

  rtype

  opencascade::handle<IFSelect_Selection>

LastRunCheckList()

• Returns the Check List produced by the last execution of eitherEvaluateFile(for Split), SendSplit, SendAll, SendSelected, RunTransformer-RunModifier Cleared by SetModel or ClearData(1) The field is protected, hence a specialized WorkSession may fill it

  rtype

  Interface_CheckIterator

ListEntities()

• Internal method which displays an EntityIterator <mode> 0 gives short display (only entity numbers) 1 gives a more complete trace (1 line per Entity) (can be used each time a trace has to be output from a list) 2 gives a form suitable for givelist(n1,n2,n3…)

  param iter

  type iter

  Interface_EntityIterator

  param mode

  type mode

  int

  rtype

  None

ListFinalModifiers()

• Lists the Modifiers of the session (for each one, displays its Label). Listing is done following Ranks (Modifiers are invoked following their ranks) Model Modifiers if <formodel> is True, File Modifiers else

  param formodel

  type formodel

  bool

  rtype

  None

ListItems()

• Lists the Labels of all Items of the WorkSession If <label> is defined, lists labels which contain it

  param label

  default value is

  type label

  char *

  rtype

  None

LoadedFile()

• Returns the filename used to load current model empty if unknown

  rtype

  char *

MaxIdent()

• Returns the Maximum Value for an Item Identifier. It can be greater to the count of known Items, because some can have been removed

  rtype

  int

MaxSendingCount()

• Returns the greater count of different files in which any of the starting entities could be sent. Before any file output, this count is 0. Ideal count is 1. More than 1 means that duplications occur.

  rtype

  int

Model()

• Returns the Model of the Work Session (Null Handle if none) should be C++return const &

  rtype

  opencascade::handle<Interface_InterfaceModel>

ModelCheckList()

• Returns the Check List for the Model currently loaded<complete> = Truecomplete (syntactic & semantic messages), computed if not yet done <complete> = Falseonly syntactic (check file form)

  param complete

  default value is Standard_True

  type complete

  bool

  rtype

  Interface_CheckIterator

ModelCopier()

• Gives access to the complete ModelCopier

  rtype

  opencascade::handle<IFSelect_ModelCopier>

ModelModifier()

• Returns a Model Modifier, given its Ident in the Session, i.e. typed as a Modifier (not simply a GeneralModifier) Null result if <id> is not suitable for a Modifier (undefined, or defined for another kind of variable)

  param id

  type id

  int

  rtype

  opencascade::handle<IFSelect_Modifier>

ModifierRank()

• Returns the Rank of a Modifier given its Ident. Model or File Modifier according its type (ModelModifier or not) Remember that Modifiers are applied sequencially following their Rankfirst Model Modifiers then File Modifiers Rank is given by rank of call to AddItem and can be changed by ChangeModifierRank

  param item

  type item

  IFSelect_GeneralModifier

  rtype

  int

Name()

• Returns the Name attached to an Item as a Variable of this WorkSession. If <item> is Null or not recorded, returns an empty string.

  param item

  type item

  Standard_Transient

  rtype

  opencascade::handle<TCollection_HAsciiString>

NameIdent()

• Returns the Ident attached to a Name, 0 if name not recorded

  param name

  type name

  char *

  rtype

  int

NamedItem()

• Returns the Item which corresponds to a Variable, given its Name (whatever the type of this Item). Returns a Null Handle if this Name is not recorded

  param name

  type name

  char *

  rtype

  opencascade::handle<Standard_Transient>* Same as above, but <name> is given through a Handle Especially Usefull with methods SelectionNames, etc…

  param name

  type name

  TCollection_HAsciiString

  rtype

  opencascade::handle<Standard_Transient>

NbFiles()

• Returns the count of produced Models

  rtype

  int

NbFinalModifiers()

• Returns the count of Modifiers applied to final sending Model Modifiers if <formodel> is True, File Modifiers else (i.e. Modifiers which apply once the Models have been filled)

  param formodel

  type formodel

  bool

  rtype

  int

NbSources()

• Returns the count of Input Selections known for a Selection, or 0 if <sel> not in the WorkSession. This count is one for a SelectDeduct / SelectExtract kind, two for SelectControl kind, variable for a SelectCombine (Union/Intersection), zero else

  param sel

  type sel

  IFSelect_Selection

  rtype

  int

NbStartingEntities()

• Returns the count of Entities stored in the Model, or 0

  rtype

  int

NewIntParam()

• Creates a new IntParam. A Name can be set (Optional) Returns the created IntParam, or a Null Handle in case of Failure (see AddItem/AddNamedItem)

  param name

  default value is

  type name

  char *

  rtype

  opencascade::handle<IFSelect_IntParam>

NewParamFromStatic()

• Creates a parameter as being bound to a Static If the Static is Integer, this creates an IntParam bound to it by its name. Else this creates a String which is the value of the Static. Returns a null handle if <statname> is unknown as a Static

  param statname

  type statname

  char *

  param name

  default value is

  type name

  char *

  rtype

  opencascade::handle<Standard_Transient>

NewSelectPointed()

• Creates a new Selection, of type SelectPointed, its content starts with <list>. A name must be given (can be empty)

  param list

  type list

  TColStd_HSequenceOfTransient

  param name

  type name

  char *

  rtype

  opencascade::handle<IFSelect_Selection>

NewTextParam()

• Creates a new (empty) TextParam. A Name can be set (Optional) Returns the created TextParam (as an HAsciiString), or a Null Handle in case of Failure (see AddItem/AddNamedItem)

  param name

  default value is

  type name

  char *

  rtype

  opencascade::handle<TCollection_HAsciiString>

NewTransformStandard()

• Creates and returns a TransformStandard, empty, with its Copy Option (True = Copy, False = On the Spot) and an optional name. To a TransformStandard, the method SetAppliedModifier applies

  param copy

  type copy

  bool

  param name

  default value is

  type name

  char *

  rtype

  opencascade::handle<IFSelect_Transformer>

NextIdentForLabel()

• For query by Label with possible iterations Searches the Ident of which Item has a Label which matches a given one, the search starts from an initial Ident. Returns the first found Ident which follows <id>, or ZERO //! The search must start with <id> = 0, it returns the next Ident which matches. To iterate, call again this method which this returned value as <id>. Once an Ident has been returned, the Item can be obtained by the method Item //! <mode> precises the required matching mode- 0 (Default)<label> must match exactly with the Item Label - 1<label> must match the exact beginning (the end is free) - 2<label> must be at least once wherever in the Item Label - other values are ignored

  param label

  type label

  char *

  param id

  type id

  int

  param mode

  default value is 0

  type mode

  int

  rtype

  int

NumberFromLabel()

• From a given label in Model, returns the corresponding number Starts from first entity by Default, may start after a given numberthis number may be given negative, its absolute value is then considered. Hence a loop on NumberFromLabel may be programmed (stop test isreturned value positive or null) //! Returns 0 if not found, < 0 if more than one found (first found in negative). If <val> just gives an integer value, returns it

  param val

  type val

  char *

  param afternum

  default value is 0

  type afternum

  int

  rtype

  int

PrintCheckList()

• Prints a CheckIterator to the current Trace File, controlled with the current Model complete or fails only, according to <failsonly> <mode> defines the mode of printing 0sequential, according entities; else with a CheckCounter 1according messages, count of entities 2id but with list of entities, designated by their numbers 3as 2 but with labels of entities

  param checklist

  type checklist

  Interface_CheckIterator

  param failsonly

  type failsonly

  bool

  param mode

  type mode

  IFSelect_PrintCount

  rtype

  None

PrintEntityStatus()

• Prints main informations about an entityits number, type, validity (and checks if any), category, shareds and sharings.. mutable because it can recompute checks as necessary

  param ent

  type ent

  Standard_Transient

  param S

  type S

  Message_Messenger

  rtype

  None

PrintSignatureList()

• Prints a SignatureList to the current Trace File, controlled with the current Model <mode> defines the mode of printing (see SignatureList)

  param signlist

  type signlist

  IFSelect_SignatureList

  param mode

  type mode

  IFSelect_PrintCount

  rtype

  None

Protocol()

• Returns the Protocol. Null Handle if not yet set should be C++return const &

  rtype

  opencascade::handle<Interface_Protocol>

QueryCheckList()

• Loads data from a check iterator to query status on it

  param chl

  type chl

  Interface_CheckIterator

  rtype

  None

QueryCheckStatus()

• Determines check status for an entity regarding last call to QueryCheckList-1<ent> unknown in the model, ignored 0no check at all, immediate or inherited thru Graph 1immediate warning (no fail), no inherited check 2immediate fail, no inherited check +10idem but some inherited warning (no fail) +20idem but some inherited fail

  param ent

  type ent

  Standard_Transient

  rtype

  int

QueryParent()

• Determines if <entdad> is parent of <entson> (in the graph), returns-1 if no; 0 if <entdad> = <entson> 1 if immediate parent, > 1 if parent, gives count of steps

  param entdad

  type entdad

  Standard_Transient

  param entson

  type entson

  Standard_Transient

  rtype

  int

ReadFile()

• Reads a file with the WorkLibrary (sets Model and LoadedFile) Returns a integer status which can beRetDone if OK, RetVoid if no Protocol not defined, RetError for file not found, RetFail if fail during read

  param filename

  type filename

  char *

  rtype

  IFSelect_ReturnStatus

RemoveItem()

• Removes an Item given its Ident. Returns False if <id> is attached to no Item in the WorkSession. For a Named Item, also removes its Name.

  param item

  type item

  Standard_Transient

  rtype

  bool

RemoveName()

• Removes a Name without removing the Item Returns True if Done, False else (Name not recorded)

  param name

  type name

  char *

  rtype

  bool

RemoveNamedItem()

• Removes an Item from the Session, given its Name Returns True if Done, False else (Name not recorded) (Applies only on Item which are Named)

  param name

  type name

  char *

  rtype

  bool

ResetAppliedModifier()

• Resets a GeneralModifier to be applied Returns True if done, False if <modif> was not applied

  param modif

  type modif

  IFSelect_GeneralModifier

  rtype

  bool

ResetItemSelection()

• Resets input Selection which was set by SetItemSelection Same conditions as for SetItemSelection Returns True if done, False if <item> is not in the WorkSession

  param item

  type item

  Standard_Transient

  rtype

  bool

RunModifier()

• Runs a Modifier on Starting Model. It can modify entities, or add new ones. But the Model or the Protocol is unchanged. The Modifier is applied on each entity of the Model. See also RunModifierSelected Fills LastRunCheckList //! <copy>if True, a new data set is produced which brings the modifications (Model + its Entities) if False, data are modified on the spot //! It works through a TransformStandard defined with <modif> Returned status as RunTransformer0 nothing done, >0 OK, <0 problem, but only between -3 and 3 (protocol unchanged) Remark<copy> True will give <effect> = 3 or -3

  param modif

  type modif

  IFSelect_Modifier

  param copy

  type copy

  bool

  rtype

  int

RunModifierSelected()

• Acts as RunModifier, but the Modifier is applied on the list determined by a Selection, rather than on the whole Model If the selection is a null handle, the whole model is taken

  param modif

  type modif

  IFSelect_Modifier

  param sel

  type sel

  IFSelect_Selection

  param copy

  type copy

  bool

  rtype

  int

RunTransformer()

• Runs a Transformer on starting Model, which can then be edited or replaced by a new one. The Protocol can also be changed. Fills LastRunCheckList //! Returned status is 0 if nothing done (<transf> or model undefined), positive if OK, negative else0Nothing done 1OK, edition on the spot with no change to the graph of dependances (purely local) 2OK, model edited on the spot (graph recomputed, may have changed), protocol unchanged 3OK, new model produced, same protocol 4OK, model edited on the spot (graph recomputed), but protocol has changed 5OK, new model produced, protocol has changed -1Error on the spot (slight changes), data may be corrupted (remarkcorruption should not be profound) -2Error on edition the spot, data may be corrupted (checking them is recommanded) -3Error with a new data set, transformation ignored -4OK as 4, but graph of dependances count not be recomputed (the former one is kept)check the protocol

  param transf

  type transf

  IFSelect_Transformer

  rtype

  int

Selection()

• Returns a Selection, given its Ident in the Session Null result if <id> is not suitable for a Selection (undefined, or defined for another kind of variable)

  param id

  type id

  int

  rtype

  opencascade::handle<IFSelect_Selection>

SelectionResult()

• Returns the result of a Selection, computed by EvalSelection (see above) under the form of a HSequence (hence, it can be used by a frontal-engine logic). It can be empty Returns a Null Handle if <sel> is not in the WorkSession

  param sel

  type sel

  IFSelect_Selection

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

SelectionResultFromList()

• Returns the result of a Selection, by forcing its input with a given list <list> (unless <list> is Null). RULES<list> applies only for a SelectDeduct kind Selectionits Input is consideredif it is a SelectDeduct kind Selection, its Input is considered, etc… until an Input is not a Deduct/Extractits result is replaced by <list> and all the chain of deductions is applied

  param sel

  type sel

  IFSelect_Selection

  param list

  type list

  TColStd_HSequenceOfTransient

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

SendAll()

• Sends the starting Model into one file, without splitting, managing remaining data or anything else. <computegraph> true commands the Graph to be recomputed before sendingrequired when a Model is filled in several steps //! The Model and File Modifiers recorded to be applied on sending files are. Returns a status of executionDone if OK, Void if no data available, Error if errors occured (work library is not defined), errors during translation Fail if exception during translation is raised Stop if no disk space or disk, file is write protected Fills LastRunCheckList

  param filename

  type filename

  char *

  param computegraph

  default value is Standard_False

  type computegraph

  bool

  rtype

  IFSelect_ReturnStatus

SendSelected()

• Sends a part of the starting Model into one file, without splitting. But remaining data are managed. <computegraph> true commands the Graph to be recomputed before sendingrequired when a Model is filled in several steps //! The Model and File Modifiers recorded to be applied on sending files are. Returns a statusDone if OK, Fail if error during send, ErrorWorkLibrary not defined, Voidselection list empty Fills LastRunCheckList

  param filename

  type filename

  char *

  param sel

  type sel

  IFSelect_Selection

  param computegraph

  default value is Standard_False

  type computegraph

  bool

  rtype

  IFSelect_ReturnStatus

SendSplit()

• Performs creation of derived files from the input Model Takes its data (sub-models and names), from result EvaluateFile if active, else by dynamic Evaluation (not stored) After SendSplit, result of EvaluateFile is Cleared Fills LastRunCheckList //! Works with the WorkLibrary which acts on specific type of Model and can work with File Modifiers (managed by the Model Copier) and a ModelCopier, which can work with Model Modifiers Returns False if, either WorkLibrary has failed on at least one sub-file, or the Work Session is badly conditionned (no Model defined, or FileNaming not in phase with ShareOut)

  rtype

  bool

SentFiles()

• Returns the list of recorded sent files, or a Null Handle is recording has not been enabled

  rtype

  opencascade::handle<TColStd_HSequenceOfHAsciiString>

SentList()

• Returns the list of Entities sent in files, accourding the count of files each one has been sent (these counts are reset by SetModel or SetRemaining(Forget) ) stored in Graph Status <count> = -1 (default) is for ENtities sent at least once <count> = 0 is for the Remaining List (entities not yet sent) <count> = 1 is for entities sent in one and only one file (the ideal case) Remaining Data are computed on each Sending/Copying output files (see methods EvaluateFile and SendSplit) Graph Status is 0 for Remaining Entity, <count> for Sent into <count> files This status is set to 0 (not yet sent) for all by SetModel and by SetRemaining(mode=Forget,Display)

  param count

  default value is -1

  type count

  int

  rtype

  Interface_EntityIterator

SetActive()

• Following the type of <item>- DispatchAdds or Removes it in the ShareOut & FileNaming - GeneralModifierAdds or Removes it for final sending (i.e. in the ModelCopier) Returns True if it did something, False else (state unchanged)

  param item

  type item

  Standard_Transient

  param mode

  type mode

  bool

  rtype

  bool

SetAppliedModifier()

• Sets a GeneralModifier to be applied to an item- item = ShareOutapplies for final sending (all dispatches) - item is a Dispatchapplies for this dispatch only Returns True if done, False if <modif> or <item> not in <self>

  param modif

  type modif

  IFSelect_GeneralModifier

  param item

  type item

  Standard_Transient

  rtype

  bool

SetControl()

• Sets an Input Selection, Main if <formain> is True, Second else (as <sc>) to a SelectControl (as <sel>). Returns True if Done, False if <sel> is not a SelectControl, or <sc> or <sel> is not in the WorkSession

  param sel

  type sel

  IFSelect_Selection

  param sc

  type sc

  IFSelect_Selection

  param formain

  default value is Standard_True

  type formain

  bool

  rtype

  bool

SetDefaultFileRoot()

• Defines a Default File Root Name. Clears it is <name> = ‘’ Returns True if OK, False if <name> already set for a Dispatch

  param name

  type name

  char *

  rtype

  bool

SetFileExtension()

• Defines a File Extension

  param name

  type name

  char *

  rtype

  None

SetFilePrefix()

• Defines a File Prefix

  param name

  type name

  char *

  rtype

  None

SetFileRoot()

• Defines a Root for a Dispatch If <name> is empty, clears Root Name This has as effect to inhibit the production of File by <disp> Returns False if <disp> is not in the WorkSession or if a root name is already defined for it

  param disp

  type disp

  IFSelect_Dispatch

  param name

  type name

  char *

  rtype

  bool

SetInputSelection()

• Sets an Input Selection (as <input>) to a SelectExtract or a SelectDeduct (as <sel>). Returns True if Done, False if <sel> is neither a SelectExtract nor a SelectDeduct, or not in the WorkSession

  param sel

  type sel

  IFSelect_Selection

  param input

  type input

  IFSelect_Selection

  rtype

  bool

SetIntValue()

• Changes the Integer Value of an IntParam Returns True if Done, False if <it> is not in the WorkSession

  param it

  type it

  IFSelect_IntParam

  param val

  type val

  int

  rtype

  bool

SetItemSelection()

• Sets a Selection as input for an item, according its typeif <item> is a Dispatchas Final Selection if <item> is a GeneralModifier (i.e. any kind of Modifier)as Selection used to filter entities to modify <sel> Null causes this Selection to be nullified Returns False if <item> is not of a suitable type, or <item> or <sel> is not in the WorkSession

  param item

  type item

  Standard_Transient

  param sel

  type sel

  IFSelect_Selection

  rtype

  bool

SetLibrary()

• Sets a WorkLibrary, which will be used to Read and Write Files

  param theLib

  type theLib

  IFSelect_WorkLibrary

  rtype

  None

SetLoadedFile()

• Stores the filename used for read for setting the model It is cleared by SetModel and ClearData(1)

  param theFileName

  type theFileName

  char *

  rtype

  None

SetModeStat()

• Set value of mode responsible for precence of selections after loading If mode set to true that different selections will be accessible after loading else selections will be not accessible after loading( for economy memory in applicatios)

  param theMode

  type theMode

  bool

  rtype

  None

SetModel()

• Sets a Model as inputthis will be the Model from which the ShareOut will work if <clearpointed> is True (default) all SelectPointed items are cleared, else they must be managed by the caller RemarkSetModel clears the Graph, recomputes it if a Protocol is set and if the Model is not empty, of course

  param model

  type model

  Interface_InterfaceModel

  param clearpointed

  default value is Standard_True

  type clearpointed

  bool

  rtype

  None

SetModelContent()

• Defines a new content from the former one If <keep> is True, it is given by entities selected by Selection <sel> (and all shared entities) Else, it is given by all the former content but entities selected by the Selection <sel> (and properly shared ones) Returns True if done. Returns False if the selected list (from <sel>) is empty, hence nothing is done

  param sel

  type sel

  IFSelect_Selection

  param keep

  type keep

  bool

  rtype

  bool

SetModelCopier()

• Sets a new ModelCopier. Fills Items which its content

  param copier

  type copier

  IFSelect_ModelCopier

  rtype

  None

SetParams()

• Sets a list of Parameters, i.e. TypedValue, to be handled through an Editor The two lists are parallel, if <params> is longer than <uses>, surnumeral parameters are for general use //! EditForms are created to handle these parameters (list, edit) on the basis of a ParamEditor xst-params-edit //! A use number dispatches the parameter to a given EditForm EditForms are defined as follows Name Use Means xst-params all All Parameters (complete list) xst-params-general 1 Generals xst-params-load 2 LoadFile (no Transfer) xst-params-send 3 SendFile (Write, no Transfer) xst-params-split 4 Split xst-param-read 5 Transfer on Reading xst-param-write 6 Transfer on Writing

  param params

  type params

  Standard_Transient

  param uselist

  type uselist

  NCollection_Vector<int>

  rtype

  None

SetProtocol()

• Sets a Protocol, which will be used to determine Graphs, to Read and to Write Files

  param protocol

  type protocol

  Interface_Protocol

  rtype

  None

SetRemaining()

• Processes Remaining data (after having sent files), modeForgetforget remaining info (i.e. clear all ‘Sent’ status) Computecompute and keep remaining (does nothing ifremaining is empty or if no files has been sent) Displaydisplay entities recorded as remaining Undorestore former state of data (after Remaining(1) ) Returns True if OK, False else (i.e. mode = 2 and Remaining List is either empty or takes all the entities, or mode = 3 and no former computation of remaining data was done)

  param mode

  type mode

  IFSelect_RemainMode

  rtype

  bool

SetSelectPointed()

• Changes the content of a Selection of type SelectPointed According <mode>0 set <list> as new content (clear former) 1adds <list> to actual content -1removes <list> from actual content Returns True if done, False if <sel> is not a SelectPointed

  param sel

  type sel

  IFSelect_Selection

  param list

  type list

  TColStd_HSequenceOfTransient

  param mode

  type mode

  int

  rtype

  bool

SetShareOut()

• Sets a new ShareOut. Fills Items which its content Warningdata from the former ShareOut are lost

  param shareout

  type shareout

  IFSelect_ShareOut

  rtype

  None

SetSignType()

• Sets a specific Signature to be the SignType, i.e. the Signature which will determine TypeName from the Model (basic function). It is recorded in the GTool This Signature is also set as ‘xst-sign-type’ (reserved name)

  param signtype

  type signtype

  IFSelect_Signature

  rtype

  None

SetTextValue()

• Changes the Text Value of a TextParam (an HAsciiString) Returns True if Done, False if <it> is not in the WorkSession

  param par

  type par

  TCollection_HAsciiString

  param val

  type val

  char *

  rtype

  bool

ShareOut()

• Returns the ShareOut defined at creation time

  rtype

  opencascade::handle<IFSelect_ShareOut>

Shareds()

• Returns the list of entities shared by <ent> (can be empty) Returns a null Handle if <ent> is unknown

  param ent

  type ent

  Standard_Transient

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

Sharings()

• Returns the list of entities sharing <ent> (can be empty) Returns a null Handle if <ent> is unknown

  param ent

  type ent

  Standard_Transient

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

SignCounter()

• Returns a SignCounter from its ident in the Session Null result if <id> is not suitable for a SignCounter (undefined, or defined for another kind of variable)

  param id

  type id

  int

  rtype

  opencascade::handle<IFSelect_SignCounter>

SignType()

• Returns the current SignType

  rtype

  opencascade::handle<IFSelect_Signature>

SignValue()

• Returns the Value computed by a Signature for an Entity Returns an empty string if the entity does not belong to the loaded model

  param sign

  type sign

  IFSelect_Signature

  param ent

  type ent

  Standard_Transient

  rtype

  char *

Signature()

• Returns a Signature, given its Ident in the Session Null result if <id> is not suitable for a Signature (undefined, or defined for another kind of variable)

  param id

  type id

  int

  rtype

  opencascade::handle<IFSelect_Signature>

Source()

• Returns the <num>th Input Selection of a Selection (see NbSources). Returns a Null Handle if <sel> is not in the WorkSession or if <num> is out of the range <1-NbSources> To obtain more details, see the method Sources

  param sel

  type sel

  IFSelect_Selection

  param num

  default value is 1

  type num

  int

  rtype

  opencascade::handle<IFSelect_Selection>

Sources()

• Returns the Selections which are source of Selection, given its rank in the List of Selections (see SelectionIterator) Returned value is empty if <num> is out of range or if <sel> is not in the WorkSession

  param sel

  type sel

  IFSelect_Selection

  rtype

  IFSelect_SelectionIterator

StartingEntity()

• Returns an Entity stored in the Model of the WorkSession (Null Handle is no Model or num out of range)

  param num

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

StartingNumber()

• Returns the Number of an Entity in the Model (0 if no Model set or <ent> not in the Model)

  param ent

  type ent

  Standard_Transient

  rtype

  int

TextParam()

• Returns a TextParam, given its Ident in the Session Null result if <id> is not suitable for a TextParam (undefined, or defined for another kind of variable)

  param id

  type id

  int

  rtype

  opencascade::handle<TCollection_HAsciiString>

TextValue()

• Returns Text Value of a TextParam (a String) or an empty string if <it> is not in the WorkSession

  param par

  type par

  TCollection_HAsciiString

  rtype

  TCollection_AsciiString

ToggleSelectExtract()

• Toggles the Sense (Direct <-> Reversed) of a SelectExtract Returns True if Done, False if <sel> is not a SelectExtract or is not in the WorkSession

  param sel

  type sel

  IFSelect_Selection

  rtype

  bool

TraceDumpEntity()

• Dumps an entity from the current Model as inherited DumpEntity on currently defined Default Trace File (<level> interpreted according to the Norm, see WorkLibrary)

  param ent

  type ent

  Standard_Transient

  param level

  type level

  int

  rtype

  None

TraceDumpModel()

• Dumps the current Model (as inherited DumpModel), on currently defined Default Trace File (default is standard output)

  param mode

  type mode

  int

  rtype

  None

TraceStatics()

• Traces the Statics attached to a given use number If <use> is given positive (normal), the trace is embedded with a header and a trailer If <use> is negative, just values are printed (this allows to make compositions) Remarkuse number 5 commands use -2 to be traced Remarkuse numbers 4 and 6 command use -3 to be traced

  param use

  type use

  int

  param mode

  default value is 0

  type mode

  int

  rtype

  None

Transformer()

• Returns a Transformer, given its Ident in the Session Null result if <id> is not suitable for a Transformer (undefined, or defined for another kind of variable)

  param id

  type id

  int

  rtype

  opencascade::handle<IFSelect_Transformer>

UsesAppliedModifier()

• Returns the item on which a GeneralModifier is appliedthe ShareOut, or a given Dispatch Returns a Null Handle if <modif> is not applied

  param modif

  type modif

  IFSelect_GeneralModifier

  rtype

  opencascade::handle<Standard_Transient>

ValidityName()

• Returns the Validity Name determined for an entity it is computed by the class SignValidity Remarkan unknown entity gives an empty string

  param ent

  type ent

  Standard_Transient

  rtype

  char *

WorkLibrary()

• Returns the WorkLibrary. Null Handle if not yet set should be C++return const &

  rtype

  opencascade::handle<IFSelect_WorkLibrary>

WriteFile()

• Writes the current Interface Model globally to a File, and returns a write status which can beDone OK, Fail file could not be written, Error no norm is selected RemarkIt is a simple, one-file writing, other operations are available (such as splitting …) which calls SendAll

  param filename

  type filename

  char *

  rtype

  IFSelect_ReturnStatus* Writes a sub-part of the current Interface Model to a File, as defined by a Selection <sel>, recomputes the Graph, and returns a write status which can be : Done OK, Fail file could not be written, Error no norm is selected Remark : It is a simple, one-file writing, other operations are available (such as splitting …) which calls SendSelected

  param filename

  type filename

  char *

  param sel

  type sel

  IFSelect_Selection

  rtype

  IFSelect_ReturnStatus

property thisown

The membership flag

class SwigPyIterator(*args, **kwargs)

Bases: object

advance()

copy()

decr()

distance()

equal()

incr()

next()

previous()

property thisown

The membership flag

value()

class ifselect

Bases: object

static RestoreSession()

• Restore the state of a WorkSession from IFSelect, by using a SessionFile from IFSelect. Returns True if Done, False in case of Error on Writing. <file> gives the name of the File to be used (this avoids to export the class SessionFile).

  param WS

  type WS

  IFSelect_WorkSession

  param file

  type file

  char *

  rtype

  bool

static SaveSession()

• Saves the state of a WorkSession from IFSelect, by using a SessionFile from IFSelect. Returns True if Done, False in case of Error on Writing. <file> gives the name of the File to be produced (this avoids to export the class SessionFile).

  param WS

  type WS

  IFSelect_WorkSession

  param file

  type file

  char *

  rtype

  bool

property thisown

The membership flag