OCC.IFSelect module

class OCC.IFSelect.Handle_IFSelect_Act(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Activator

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_Activator(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_AppliedModifiers(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_BasicDumper(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SessionDumper

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_CheckCounter(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SignatureList

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_DispGlobal(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Dispatch

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_DispPerCount(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Dispatch

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_DispPerFiles(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Dispatch

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_DispPerOne(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Dispatch

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_DispPerSignature(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Dispatch

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_Dispatch(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_EditForm(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_Editor(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_GeneralModifier(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_GraphCounter(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SignCounter

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_HSeqOfSelection(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_IntParam(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_ListEditor(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_ModelCopier(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_ModifEditForm(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Modifier

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_ModifReorder(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Modifier

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_Modifier(*args)

Bases: OCC.IFSelect.Handle_IFSelect_GeneralModifier

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_PacketList(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_ParamEditor(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Editor

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectAnyList(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectDeduct

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectAnyType(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectExtract

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectBase(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Selection

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectCombine(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Selection

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectControl(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Selection

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectDeduct(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Selection

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectDiff(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectControl

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectEntityNumber(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectBase

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectErrorEntities(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectExtract

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectExplore(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectDeduct

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectExtract(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectDeduct

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectFlag(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectExtract

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectInList(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectAnyList

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectIncorrectEntities(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectFlag

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectIntersection(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectCombine

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectModelEntities(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectBase

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectModelRoots(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectBase

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectPointed(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectBase

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectRange(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectExtract

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectRootComps(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectExtract

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectRoots(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectExtract

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectSent(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectExtract

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectShared(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectDeduct

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectSharing(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectDeduct

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectSignature(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectExtract

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectSignedShared(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectExplore

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectSignedSharing(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectExplore

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectSuite(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectDeduct

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectType(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectAnyType

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectUnion(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectCombine

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SelectUnknownEntities(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SelectExtract

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_Selection(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SequenceNodeOfSequenceOfAppliedModifiers(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SequenceNodeOfSequenceOfGeneralModifier(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SequenceNodeOfSequenceOfInterfaceModel(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SequenceNodeOfTSeqOfDispatch(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SequenceNodeOfTSeqOfSelection(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SessionDumper(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SessionPilot(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Activator

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_ShareOut(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SignAncestor(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SignType

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SignCategory(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Signature

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SignCounter(*args)

Bases: OCC.IFSelect.Handle_IFSelect_SignatureList

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SignMultiple(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Signature

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SignType(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Signature

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SignValidity(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Signature

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_Signature(*args)

Bases: OCC.Interface.Handle_Interface_SignType

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_SignatureList(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_TransformStandard(*args)

Bases: OCC.IFSelect.Handle_IFSelect_Transformer

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_Transformer(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_WorkLibrary(*args)

Bases: OCC.Standard.Handle_Standard_Transient

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

The membership flag

class OCC.IFSelect.Handle_IFSelect_WorkSession(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

The membership flag

class OCC.IFSelect.IFSelect_Act(*args)

Bases: OCC.IFSelect.IFSelect_Activator

static AddFSet(*args)
  • Adds a function with its name and help : creates an Act then records it as function for XSET (i.e. to create control item)
Parameters:
  • name (char *) –
  • help (char *) –
  • func (IFSelect_ActFunc) –
Return type:

void

static AddFunc(*args)
  • Adds a function with its name and help : creates an Act then records it as normal function
Parameters:
  • name (char *) –
  • help (char *) –
  • func (IFSelect_ActFunc) –
Return type:

void

GetHandle()

IFSelect_Act_GetHandle(IFSelect_Act self) -> Handle_IFSelect_Act

static SetGroup(*args)
  • 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)
Parameters:
  • group (char *) –
  • file (char *) – default value is
Return type:

void

  • 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)
Parameters:
  • group (char *) –
  • file (char *) – default value is
Return type:

void

thisown

The membership flag

OCC.IFSelect.IFSelect_Act_AddFSet(*args)
  • Adds a function with its name and help : creates an Act then records it as function for XSET (i.e. to create control item)
Parameters:
  • name (char *) –
  • help (char *) –
  • func (IFSelect_ActFunc) –
Return type:

void

OCC.IFSelect.IFSelect_Act_AddFunc(*args)
  • Adds a function with its name and help : creates an Act then records it as normal function
Parameters:
  • name (char *) –
  • help (char *) –
  • func (IFSelect_ActFunc) –
Return type:

void

OCC.IFSelect.IFSelect_Act_SetGroup(*args)
  • 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)
Parameters:
  • group (char *) –
  • file (char *) – default value is
Return type:

void

  • 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)
Parameters:
  • group (char *) –
  • file (char *) – default value is
Return type:

void

class OCC.IFSelect.IFSelect_Activator(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

Add()
  • Allows a self-definition by an Activator of the Commands it processes, call the class method Adding (mode 0)
Parameters:
  • number (Standard_Integer) –
  • command (char *) –
Return type:

None

AddSet()
  • Same as Add but specifies that this command is candidate for xset (creation of items, xset : named items; mode 1)
Parameters:
  • number (Standard_Integer) –
  • command (char *) –
Return type:

None

static Adding(*args)
  • 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; 1 : for xset
Parameters:
  • actor (Handle_IFSelect_Activator &) –
  • number (Standard_Integer) –
  • command (char *) –
  • mode (Standard_Integer) –
Return type:

void

static Alias(*args)
  • Returns, in the current configuration, what alias has been recorded for <command> The returned string is empty if no alias is recorded
Parameters:command (char *) –
Return type:TCollection_AsciiString
static Commands(*args)
  • Returns, for a root of command title, the list of possible commands. <mode> : -1 (D) for all commands if <commands> is empty -1 + command : about a Group , >= 0 see Adding By default, it returns the whole list of known commands.
Parameters:
  • mode (Standard_Integer) – default value is - 1
  • command (char *) – default value is
Return type:

Handle_TColStd_HSequenceOfAsciiString

  • Returns, for a root of command title, the list of possible commands. <mode> : -1 (D) for all commands if <commands> is empty -1 + command : about a Group , >= 0 see Adding By default, it returns the whole list of known commands.
Parameters:
  • mode (Standard_Integer) – default value is - 1
  • command (char *) – default value is
Return type:

Handle_TColStd_HSequenceOfAsciiString

  • Returns, for a root of command title, the list of possible commands. <mode> : -1 (D) for all commands if <commands> is empty -1 + command : about a Group , >= 0 see Adding By default, it returns the whole list of known commands.
Parameters:
  • mode (Standard_Integer) – default value is - 1
  • command (char *) – default value is
Return type:

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 Returns : 0 for a void command (not to be recorded), 1 if execution OK, -1 if command incorrect, -2 if error on execution
Parameters:
  • number (Standard_Integer) –
  • pilot (Handle_IFSelect_SessionPilot &) –
Return type:

IFSelect_ReturnStatus

File()
Return type:char *
GetHandle()

IFSelect_Activator_GetHandle(IFSelect_Activator self) -> Handle_IFSelect_Activator

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)
Parameters:number (Standard_Integer) –
Return type:char *
static Mode(*args)
  • Returns mode recorded for a command. -1 if not found
Parameters:command (char *) –
Return type:int
static Remove(*args)
  • Removes a Command, if it is recorded (else, does nothing)
Parameters:command (char *) –
Return type:void
static Select(*args)
  • Selects, for a Command given by its title, an actor with its command number. Returns True if found, False else
Parameters:
  • command (char *) –
  • number (Standard_Integer &) –
  • actor (Handle_IFSelect_Activator &) –
Return type:

bool

static SetAlias(*args)
  • Records, for a configuration named <conf>, that the command <command> may be aliased by another command <alias> To be used by call to Alias (no automatic redirection) The configuration typically refers to a norm
Parameters:
  • conf (char *) –
  • command (char *) –
  • aliasname (char *) –
Return type:

void

static SetCurrentAlias(*args)
  • Sets <conf> as current configuration for aliases
Parameters:conf (char *) –
Return type:void
SetForGroup()
  • Group and SetGroup define a ‘Group of commands’ which correspond to an Activator. Default is ‘XSTEP’ Also a file may be attached
Parameters:
  • group (char *) –
  • file (char *) – default value is
Return type:

None

  • Group and SetGroup define a ‘Group of commands’ which correspond to an Activator. Default is ‘XSTEP’ Also a file may be attached
Parameters:
  • group (char *) –
  • file (char *) – default value is
Return type:

None

thisown

The membership flag

OCC.IFSelect.IFSelect_Activator_Adding(*args)
  • 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; 1 : for xset
Parameters:
  • actor (Handle_IFSelect_Activator &) –
  • number (Standard_Integer) –
  • command (char *) –
  • mode (Standard_Integer) –
Return type:

void

OCC.IFSelect.IFSelect_Activator_Alias(*args)
  • Returns, in the current configuration, what alias has been recorded for <command> The returned string is empty if no alias is recorded
Parameters:command (char *) –
Return type:TCollection_AsciiString
OCC.IFSelect.IFSelect_Activator_Commands(*args)
  • Returns, for a root of command title, the list of possible commands. <mode> : -1 (D) for all commands if <commands> is empty -1 + command : about a Group , >= 0 see Adding By default, it returns the whole list of known commands.
Parameters:
  • mode (Standard_Integer) – default value is - 1
  • command (char *) – default value is
Return type:

Handle_TColStd_HSequenceOfAsciiString

  • Returns, for a root of command title, the list of possible commands. <mode> : -1 (D) for all commands if <commands> is empty -1 + command : about a Group , >= 0 see Adding By default, it returns the whole list of known commands.
Parameters:
  • mode (Standard_Integer) – default value is - 1
  • command (char *) – default value is
Return type:

Handle_TColStd_HSequenceOfAsciiString

  • Returns, for a root of command title, the list of possible commands. <mode> : -1 (D) for all commands if <commands> is empty -1 + command : about a Group , >= 0 see Adding By default, it returns the whole list of known commands.
Parameters:
  • mode (Standard_Integer) – default value is - 1
  • command (char *) – default value is
Return type:

Handle_TColStd_HSequenceOfAsciiString

OCC.IFSelect.IFSelect_Activator_Mode(*args)
  • Returns mode recorded for a command. -1 if not found
Parameters:command (char *) –
Return type:int
OCC.IFSelect.IFSelect_Activator_Remove(*args)
  • Removes a Command, if it is recorded (else, does nothing)
Parameters:command (char *) –
Return type:void
OCC.IFSelect.IFSelect_Activator_Select(*args)
  • Selects, for a Command given by its title, an actor with its command number. Returns True if found, False else
Parameters:
  • command (char *) –
  • number (Standard_Integer &) –
  • actor (Handle_IFSelect_Activator &) –
Return type:

bool

OCC.IFSelect.IFSelect_Activator_SetAlias(*args)
  • Records, for a configuration named <conf>, that the command <command> may be aliased by another command <alias> To be used by call to Alias (no automatic redirection) The configuration typically refers to a norm
Parameters:
  • conf (char *) –
  • command (char *) –
  • aliasname (char *) –
Return type:

void

OCC.IFSelect.IFSelect_Activator_SetCurrentAlias(*args)
  • Sets <conf> as current configuration for aliases
Parameters:conf (char *) –
Return type:void
class OCC.IFSelect.IFSelect_AppliedModifiers(*args)

Bases: OCC.MMgt.MMgt_TShared

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
Parameters:modif (Handle_IFSelect_GeneralModifier &) –
Return type: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
Parameters:nument (Standard_Integer) –
Return type:bool
Count()
  • Returns the count of recorded modifiers
Return type:int
GetHandle()

IFSelect_AppliedModifiers_GetHandle(IFSelect_AppliedModifiers self) -> Handle_IFSelect_AppliedModifiers

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
Return type: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
Parameters:
  • num (Standard_Integer) –
  • modif (Handle_IFSelect_GeneralModifier &) –
  • entcount (Standard_Integer &) –
Return type:

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
Return type: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
Parameters:nument (Standard_Integer) –
Return type:int
thisown

The membership flag

class OCC.IFSelect.IFSelect_BasicDumper

Bases: OCC.IFSelect.IFSelect_SessionDumper

GetHandle()

IFSelect_BasicDumper_GetHandle(IFSelect_BasicDumper self) -> Handle_IFSelect_BasicDumper

thisown

The membership flag

class OCC.IFSelect.IFSelect_CheckCounter(*args)

Bases: OCC.IFSelect.IFSelect_SignatureList

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 variables : integers, reals, strings) If <failsonly> is True, only Fails are considered Remark : global messages are recorded with a Null entity
Parameters:
  • list (Interface_CheckIterator &) –
  • model (Handle_Interface_InterfaceModel &) –
  • original (bool) – default value is Standard_False
  • failsonly (bool) – default value is Standard_False
Return type:

None

  • 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 variables : integers, reals, strings) If <failsonly> is True, only Fails are considered Remark : global messages are recorded with a Null entity
Parameters:
  • list (Interface_CheckIterator &) –
  • model (Handle_Interface_InterfaceModel &) –
  • original (bool) – default value is Standard_False
  • failsonly (bool) – default value is Standard_False
Return type:

None

  • 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 variables : integers, reals, strings) If <failsonly> is True, only Fails are considered Remark : global messages are recorded with a Null entity
Parameters:
  • list (Interface_CheckIterator &) –
  • model (Handle_Interface_InterfaceModel &) –
  • original (bool) – default value is Standard_False
  • failsonly (bool) – default value is Standard_False
Return type:

None

GetHandle()

IFSelect_CheckCounter_GetHandle(IFSelect_CheckCounter self) -> Handle_IFSelect_CheckCounter

SetSignature()
  • Sets a specific signature Else, the current SignType (in the model) is used
Parameters:sign (Handle_MoniTool_SignText &) –
Return type:None
Signature()
  • Returns the Signature;
Return type:Handle_MoniTool_SignText
thisown

The membership flag

class OCC.IFSelect.IFSelect_ContextModif(*args)

Bases: object

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.
Parameters:check (Handle_Interface_Check &) –
Return type: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.
Parameters:
  • start (Handle_Standard_Transient &) –
  • mess (char *) –
  • orig (char *) – default value is
Return type:

None

  • 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.
Parameters:
  • start (Handle_Standard_Transient &) –
  • mess (char *) –
  • orig (char *) – default value is
Return type:

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.
Parameters:
  • start (Handle_Standard_Transient &) –
  • mess (char *) –
  • orig (char *) – default value is
Return type:

None

  • 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.
Parameters:
  • start (Handle_Standard_Transient &) –
  • mess (char *) –
  • orig (char *) – default value is
Return type:

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 = ...’)
Parameters:num (Standard_Integer) – default value is 0
Return type:Handle_Interface_Check
  • 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 = ...’)
Parameters:num (Standard_Integer) – default value is 0
Return type: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 = ...’)
Parameters:start (Handle_Standard_Transient &) –
Return type:Handle_Interface_Check
CheckList()
  • Returns the complete CheckList
Return type:Interface_CheckIterator
Control()
  • Returns the map for a direct use, if required
Return type:Handle_Interface_CopyControl
FileName()
  • Returns File Name (can be empty)
Return type:char *
HasFileName()
  • Returns True if a non empty file name has been defined
Return type:bool
IsForAll()
  • Returns True if no filter is defined : a Modifier has to work on all entities of the resulting (target) model
Return type:bool
IsForNone()
  • Returns True if Select has determined that a Modifier may not be run (filter defined and empty)
Return type:bool
IsSelected()
  • Returns True if a starting item has been transferred and selected
Parameters:ent (Handle_Standard_Transient &) –
Return type:bool
IsTransferred()
  • Returns True if a starting item has been transferred
Parameters:ent (Handle_Standard_Transient &) –
Return type:bool
More()
  • Returns True until the iteration has finished
Return type:bool
Next()
  • Advances the iteration
Return type:None
OriginalGraph()
  • Returns the original Graph (compared to OriginalModel, it gives more query capabilitites)
Return type:Interface_Graph
OriginalModel()
  • Returns the original model
Return type:Handle_Interface_InterfaceModel
Protocol()
  • Returns the Protocol (Null if not set)
Return type: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
Parameters:list (Interface_EntityIterator &) –
Return type:None
SelectedCount()
  • Returns the count of selected and transferred items
Return type:int
SelectedOriginal()
  • Returns the list of original selected items. See also the iteration
Return type:Interface_EntityIterator
SelectedResult()
  • Returns the list of resulting counterparts of selected items. See also the iteration
Return type:Interface_EntityIterator
SetProtocol()
  • Allows to transmit a Protocol as part of a ContextModif
Parameters:proto (Handle_Interface_Protocol &) –
Return type:None
Start()
  • Starts an iteration on selected items. It takes into account IsForAll/IsForNone, by really iterating on all selected items.
Return type: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
Parameters:mess (char *) – default value is
Return type:None
  • 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
Parameters:mess (char *) – default value is
Return type: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
Parameters:modif (Handle_IFSelect_GeneralModifier &) –
Return type:None
ValueOriginal()
  • Returns the current selected item in the original model
Return type:Handle_Standard_Transient
ValueResult()
  • Returns the result counterpart of current selected item (in the target model)
Return type:Handle_Standard_Transient
thisown

The membership flag

class OCC.IFSelect.IFSelect_ContextWrite(*args)

Bases: object

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.
Parameters:check (Handle_Interface_Check &) –
Return type: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.
Parameters:
  • start (Handle_Standard_Transient &) –
  • mess (char *) –
  • orig (char *) – default value is
Return type:

None

  • 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.
Parameters:
  • start (Handle_Standard_Transient &) –
  • mess (char *) –
  • orig (char *) – default value is
Return type:

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.
Parameters:
  • start (Handle_Standard_Transient &) –
  • mess (char *) –
  • orig (char *) – default value is
Return type:

None

  • 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.
Parameters:
  • start (Handle_Standard_Transient &) –
  • mess (char *) –
  • orig (char *) – default value is
Return type:

None

AppliedModifiers()
  • Returns the object AppliedModifiers
Return type: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 = ...’)
Parameters:num (Standard_Integer) – default value is 0
Return type:Handle_Interface_Check
  • 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 = ...’)
Parameters:num (Standard_Integer) – default value is 0
Return type: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 = ...’)
Parameters:start (Handle_Standard_Transient &) –
Return type:Handle_Interface_Check
CheckList()
  • Returns the complete CheckList
Return type:Interface_CheckIterator
FileModifier()
  • Returns the currently active File Modifier. Cast to be done Null if not properly set : must be test IsNull after casting
Return type:Handle_IFSelect_GeneralModifier
FileName()
  • Returns the File Name
Return type:char *
Graph()
  • Returns the Graph, either given when created, else created the first time it is queried
Return type: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
Return type:bool
IsForNone()
  • Returns True if no modifier is currently set
Return type:bool
Model()
  • Returns the Model
Return type:Handle_Interface_InterfaceModel
More()
  • Returns True until the iteration has finished
Return type:bool
NbEntities()
  • Returns the total count of selected entities
Return type:int
NbModifiers()
  • Returns the count of recorded File Modifiers
Return type:int
Next()
  • Advances the iteration
Return type:None
Protocol()
  • Returns the Protocol;
Return type: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
Parameters:numod (Standard_Integer) –
Return type:bool
Start()
  • Starts an iteration on selected items. It takes into account IsForAll/IsForNone, by really iterating on all selected items.
Return type:None
Value()
  • Returns the current selected entity in the model
Return type:Handle_Standard_Transient
thisown

The membership flag

class OCC.IFSelect.IFSelect_DispGlobal

Bases: OCC.IFSelect.IFSelect_Dispatch

GetHandle()

IFSelect_DispGlobal_GetHandle(IFSelect_DispGlobal self) -> Handle_IFSelect_DispGlobal

thisown

The membership flag

class OCC.IFSelect.IFSelect_DispPerCount

Bases: OCC.IFSelect.IFSelect_Dispatch

Count()
  • Returns the Count Parameter used for splitting
Return type:Handle_IFSelect_IntParam
CountValue()
  • Returns the effective value of the count parameter (if Count Parameter not Set or value not positive, returns 1)
Return type:int
GetHandle()

IFSelect_DispPerCount_GetHandle(IFSelect_DispPerCount self) -> Handle_IFSelect_DispPerCount

SetCount()
  • Sets a new Parameter for Count
Parameters:count (Handle_IFSelect_IntParam &) –
Return type:None
thisown

The membership flag

class OCC.IFSelect.IFSelect_DispPerFiles

Bases: OCC.IFSelect.IFSelect_Dispatch

Count()
  • Returns the Count Parameter used for splitting
Return type:Handle_IFSelect_IntParam
CountValue()
  • Returns the effective value of the count parameter (if Count Parameter not Set or value not positive, returns 1)
Return type:int
GetHandle()

IFSelect_DispPerFiles_GetHandle(IFSelect_DispPerFiles self) -> Handle_IFSelect_DispPerFiles

SetCount()
  • Sets a new Parameter for Count
Parameters:count (Handle_IFSelect_IntParam &) –
Return type:None
thisown

The membership flag

class OCC.IFSelect.IFSelect_DispPerOne

Bases: OCC.IFSelect.IFSelect_Dispatch

GetHandle()

IFSelect_DispPerOne_GetHandle(IFSelect_DispPerOne self) -> Handle_IFSelect_DispPerOne

thisown

The membership flag

class OCC.IFSelect.IFSelect_DispPerSignature

Bases: OCC.IFSelect.IFSelect_Dispatch

GetHandle()

IFSelect_DispPerSignature_GetHandle(IFSelect_DispPerSignature self) -> Handle_IFSelect_DispPerSignature

SetSignCounter()
  • Sets a SignCounter for sort Remark : it is set to record lists of entities, not only counts
Parameters:sign (Handle_IFSelect_SignCounter &) –
Return type:None
SignCounter()
  • Returns the SignCounter used for splitting
Return type:Handle_IFSelect_SignCounter
SignName()
  • Returns the name of the SignCounter, which caracterises the sorting criterium for this Dispatch
Return type:char *
thisown

The membership flag

class OCC.IFSelect.IFSelect_Dispatch(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

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)
Return type:bool
FinalSelection()
  • Returns the Final Selection of a Dispatch we ‘d like : C++ : return const &
Return type: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)
Parameters:G (Interface_Graph &) –
Return type:Interface_EntityIterator
GetHandle()

IFSelect_Dispatch_GetHandle(IFSelect_Dispatch self) -> Handle_IFSelect_Dispatch

HasRootName()
  • Returns True if a specific Root Name has been set (else, the Default Root Name has to be used)
Return type:bool
Label()
  • Returns a text which defines the way a Dispatch produces packets (which will become files) from its Input
Return type:TCollection_AsciiString
LimitedMax()
  • Returns True if a Dispatch generates a count of Packets always less than or equal to a maximum value : it 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)
Parameters:
  • nbent (Standard_Integer) –
  • max (Standard_Integer &) –
Return type:

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.
Parameters:G (Interface_Graph &) –
Return type: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
Parameters:
  • G (Interface_Graph &) –
  • packs (IFGraph_SubPartsIterator &) –
Return type:

void

PacketsCount()
  • Returns True if Count of Packets is actually known, and the value of the count in argument ‘count’. Returns False if this count is unknown. Input is given as a Graph. This method is intended to be quick (used for file names) hence if this count is long to compute (that is, as a result of complete evaluation made by method Packets), it is preferable to answer ‘unknown’ by returning False Default answer if False. Can be redefined.
Parameters:
  • G (Interface_Graph &) –
  • count (Standard_Integer &) –
Return type:

int

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).
Parameters:G (Interface_Graph &) –
Return type: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
Return type:Handle_TCollection_HAsciiString
Selections()
  • Returns the complete list of source Selections (starting from FinalSelection)
Return type:IFSelect_SelectionIterator
SetFinalSelection()
  • Stores (or Changes) the Final Selection for a Dispatch
Parameters:sel (Handle_IFSelect_Selection &) –
Return type: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)
Parameters:name (Handle_TCollection_HAsciiString &) –
Return type:None
thisown

The membership flag

class OCC.IFSelect.IFSelect_EditForm(*args)

Bases: OCC.MMgt.MMgt_TShared

Apply()
  • Applies modifications to own data Calls ApplyData then Clears Status according EditKeepStatus
Return type:bool
ApplyData()
  • Applies modifications to data Default uses Editor. Can be redefined
Parameters:
  • ent (Handle_Standard_Transient &) –
  • model (Handle_Interface_InterfaceModel &) –
Return type:

bool

ClearData()
Return type:None
ClearEdit()
  • Clears modification status : by default all, or one by its numbers (in the Editor)
Parameters:num (Standard_Integer) – default value is 0
Return type:None
  • Clears modification status : by default all, or one by its numbers (in the Editor)
Parameters:num (Standard_Integer) – default value is 0
Return type:None
EditedList()
  • Returns the Edited Value as a list If IsModified is False, returns OriginalValue Null with IsModified True : means that this value is not defined or has been removed For a single parameter, gives a Null Handle
Parameters:num (Standard_Integer) –
Return type: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 True : means that this value is not defined or has been removed It is for a single parameter. For a list, gives a Null Handle
Parameters:num (Standard_Integer) –
Return type:Handle_TCollection_HAsciiString
Editor()
Return type:Handle_IFSelect_Editor
Entity()
Return type:Handle_Standard_Transient
GetEditKeepStatus()

IFSelect_EditForm_GetEditKeepStatus(IFSelect_EditForm self) -> Standard_Boolean

GetHandle()

IFSelect_EditForm_GetHandle(IFSelect_EditForm self) -> Handle_IFSelect_EditForm

IsComplete()
  • Tells if an EditForm is complete or is an extract from Editor
Return type:bool
IsLoaded()
  • Tells if the EditForm is loaded now
Return type:bool
IsModified()
  • Tells if a Value (of the EditForm) is modified (directly or through touching by Update)
Parameters:num (Standard_Integer) –
Return type: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)
Parameters:num (Standard_Integer) –
Return type: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 ...
Parameters:num (Standard_Integer) –
Return type: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)
Parameters:
  • ent (Handle_Standard_Transient &) –
  • model (Handle_Interface_InterfaceModel &) –
Return type:

bool

  • Shortcut when both <ent> and <model> are not used (when the Editor works on fully static or global data)
Return type:bool
LoadDefault()
  • For a read-write undoable EditForm, loads original values from defaults stored in the Editor
Return type:None
LoadEntity()
  • Shortcut for LoadData when <model> is not used
Parameters:ent (Handle_Standard_Transient &) –
Return type:bool
LoadList()
  • Loads an original value as a list. Called by the Editor only
Parameters:
  • num (Standard_Integer) –
  • list (Handle_TColStd_HSequenceOfHAsciiString &) –
Return type:

None

LoadModel()
  • Shortcut for LoadData when only the model is concerned
Parameters:model (Handle_Interface_InterfaceModel &) –
Return type:bool
LoadValue()
  • Loads an original value (single). Called by the Editor only
Parameters:
  • num (Standard_Integer) –
  • val (Handle_TCollection_HAsciiString &) –
Return type:

None

Model()
Return type: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 Warning : Does not apply immediately : will be applied by the method Apply
Parameters:
  • num (Standard_Integer) –
  • newval (Handle_TCollection_HAsciiString &) –
  • enforce (bool) – default value is Standard_False
Return type:

bool

  • 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 Warning : Does not apply immediately : will be applied by the method Apply
Parameters:
  • num (Standard_Integer) –
  • newval (Handle_TCollection_HAsciiString &) –
  • enforce (bool) – default value is Standard_False
Return type:

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 Warning : Does not apply immediately : will be applied by the method Apply
Parameters:
  • num (Standard_Integer) –
  • edited (Handle_IFSelect_ListEditor &) –
  • enforce (bool) – default value is Standard_False
Return type:

bool

  • 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 Warning : Does not apply immediately : will be applied by the method Apply
Parameters:
  • num (Standard_Integer) –
  • edited (Handle_IFSelect_ListEditor &) –
  • enforce (bool) – default value is Standard_False
Return type:

bool

ModifyListValue()
  • As ModifyList but the new value is given as such Creates a ListEditor, Loads it, then calls ModifyList
Parameters:
  • num (Standard_Integer) –
  • list (Handle_TColStd_HSequenceOfHAsciiString &) –
  • enforce (bool) – default value is Standard_False
Return type:

bool

  • As ModifyList but the new value is given as such Creates a ListEditor, Loads it, then calls ModifyList
Parameters:
  • num (Standard_Integer) –
  • list (Handle_TColStd_HSequenceOfHAsciiString &) –
  • enforce (bool) – default value is Standard_False
Return type:

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)
Parameters:name (char *) –
Return type: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
Parameters:name (char *) –
Return type:int
NbValues()
  • Returns the count of values <editable> True : count 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> False : all the values from the Editor
Parameters:editable (bool) –
Return type: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,
Parameters:rank (Standard_Integer) –
Return type: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
Parameters:num (Standard_Integer) –
Return type: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
Parameters:num (Standard_Integer) –
Return type:Handle_TCollection_HAsciiString
PrintDefs()
  • Prints Definitions, relative to the Editor
Parameters:S (Handle_Message_Messenger &) –
Return type:None
PrintValues()
  • Prints Values, according to what and alsolist <names> True : prints Long Names; False : prints Short Names <what> < 0 : prints Original Values (+ flag Modified) <what> > 0 : prints Final Values (+flag Modified) <what> = 0 : prints Modified Values (Original + Edited) <alsolist> False (D) : lists are printed only as their count <alsolist> True : lists are printed for all their items
Parameters:
  • S (Handle_Message_Messenger &) –
  • what (Standard_Integer) –
  • names (bool) –
  • alsolist (bool) – default value is Standard_False
Return type:

None

  • Prints Values, according to what and alsolist <names> True : prints Long Names; False : prints Short Names <what> < 0 : prints Original Values (+ flag Modified) <what> > 0 : prints Final Values (+flag Modified) <what> = 0 : prints Modified Values (Original + Edited) <alsolist> False (D) : lists are printed only as their count <alsolist> True : lists are printed for all their items
Parameters:
  • S (Handle_Message_Messenger &) –
  • what (Standard_Integer) –
  • names (bool) –
  • alsolist (bool) – default value is Standard_False
Return type:

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
Parameters:number (Standard_Integer) –
Return type:int
Recognize()
  • Tells if this EditForm can work with its Editor and its actual Data (Entity and Model) Default uses Editor. Can be redefined
Return type:bool
SetData()
Parameters:
  • ent (Handle_Standard_Transient &) –
  • model (Handle_Interface_InterfaceModel &) –
Return type:

None

SetEditKeepStatus()

IFSelect_EditForm_SetEditKeepStatus(IFSelect_EditForm self, Standard_Boolean value)

SetEntity()
Parameters:ent (Handle_Standard_Transient &) –
Return type:None
SetModel()
Parameters:model (Handle_Interface_InterfaceModel &) –
Return type:None
TouchList()
  • Acts as Touch but for a list Does not work (returns False) if <num> is for a single param
Parameters:
  • num (Standard_Integer) –
  • newlist (Handle_TColStd_HSequenceOfHAsciiString &) –
Return type:

bool

Undo()
  • For an undoable EditForm, Applies ... origibal values ! and clears modified ones Can be run only once
Return type:bool
thisown

The membership flag

class OCC.IFSelect.IFSelect_Editor(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

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
Parameters:
  • form (Handle_IFSelect_EditForm &) –
  • ent (Handle_Standard_Transient &) –
  • model (Handle_Interface_InterfaceModel &) –
Return type:

bool

EditMode()
  • Returns the edit mode of a Value
Parameters:num (Standard_Integer) –
Return type:IFSelect_EditValue
Form()
  • Builds and Returns an EditForm, empty (no data yet) Can be redefined to return a specific type of EditForm
Parameters:
  • readonly (bool) –
  • undoable (bool) – default value is Standard_True
Return type:

Handle_IFSelect_EditForm

  • Builds and Returns an EditForm, empty (no data yet) Can be redefined to return a specific type of EditForm
Parameters:
  • readonly (bool) –
  • undoable (bool) – default value is Standard_True
Return type:

Handle_IFSelect_EditForm

GetHandle()

IFSelect_Editor_GetHandle(IFSelect_Editor self) -> Handle_IFSelect_Editor

IsList()
  • Tells if a parameter is a list
Parameters:num (Standard_Integer) –
Return type:bool
Label()
  • Returns the specific label
Return type: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
Parameters:num (Standard_Integer) –
Return type: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
Parameters:
  • form (Handle_IFSelect_EditForm &) –
  • num (Standard_Integer) –
Return type:

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
Parameters:
  • form (Handle_IFSelect_EditForm &) –
  • ent (Handle_Standard_Transient &) –
  • model (Handle_Interface_InterfaceModel &) –
Return type:

bool

MaxList()
  • Returns max length allowed for a list = 0 means : list with no limit < 0 means : not a list
Parameters:num (Standard_Integer) –
Return type:int
MaxNameLength()
  • Returns the MaxLength of, according to what : <what> = -1 : length of short names <what> = 0 : length of complete names <what> = 1 : length of values labels
Parameters:what (Standard_Integer) –
Return type:int
Name()
  • Returns the name of a Value (complete or short) from its ident Short Name can be empty
Parameters:
  • num (Standard_Integer) –
  • isshort (bool) – default value is Standard_False
Return type:

char *

  • Returns the name of a Value (complete or short) from its ident Short Name can be empty
Parameters:
  • num (Standard_Integer) –
  • isshort (bool) – default value is Standard_False
Return type:

char *

NameNumber()
  • Returns the number (ident) of a Value, from its name, short or complete. If not found, returns 0
Parameters:name (char *) –
Return type:int
NbValues()
  • Returns the count of Typed Values
Return type:int
PrintDefs()
Parameters:
  • S (Handle_Message_Messenger &) –
  • labels (bool) – default value is Standard_False
  • S
  • labels – default value is Standard_False
Return type:

None

Return type:

None

PrintNames()
Parameters:S (Handle_Message_Messenger &) –
Return type:None
Recognize()
  • Tells if this Editor can work on this EditForm and its content (model, entity ?)
Parameters:form (Handle_IFSelect_EditForm &) –
Return type:bool
SetList()
  • Sets a parameter to be a List max < 0 : not for a list (set when starting) max = 0 : list with no length limit (default for SetList) max > 0 : list limited to <max> items
Parameters:
  • num (Standard_Integer) –
  • max (Standard_Integer) – default value is 0
Return type:

None

  • Sets a parameter to be a List max < 0 : not for a list (set when starting) max = 0 : list with no length limit (default for SetList) max > 0 : list limited to <max> items
Parameters:
  • num (Standard_Integer) –
  • max (Standard_Integer) – default value is 0
Return type:

None

SetValue()
  • Sets a Typed Value for a given ident and short name, with an Edit Mode
Parameters:
  • num (Standard_Integer) –
  • typval (Handle_Interface_TypedValue &) –
  • shortname (char *) – default value is
  • accessmode (IFSelect_EditValue) – default value is IFSelect_Editable
Return type:

None

  • Sets a Typed Value for a given ident and short name, with an Edit Mode
Parameters:
  • num (Standard_Integer) –
  • typval (Handle_Interface_TypedValue &) –
  • shortname (char *) – default value is
  • accessmode (IFSelect_EditValue) – default value is IFSelect_Editable
Return type:

None

  • Sets a Typed Value for a given ident and short name, with an Edit Mode
Parameters:
  • num (Standard_Integer) –
  • typval (Handle_Interface_TypedValue &) –
  • shortname (char *) – default value is
  • accessmode (IFSelect_EditValue) – default value is IFSelect_Editable
Return type:

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)
Parameters:
  • form (Handle_IFSelect_EditForm &) –
  • num (Standard_Integer) –
Return type:

Handle_TCollection_HAsciiString

TypedValue()
  • Returns a Typed Value from its ident
Parameters:num (Standard_Integer) –
Return type:Handle_Interface_TypedValue
Update()
  • Updates the EditForm when a parameter is modified I.E. default does nothing, can be redefined, as follows : Returns 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
Parameters:
  • form (Handle_IFSelect_EditForm &) –
  • num (Standard_Integer) –
  • newval (Handle_TCollection_HAsciiString &) –
  • enforce (bool) –
Return type:

bool

UpdateList()
  • Acts as Update, but when the value is a list
Parameters:
  • form (Handle_IFSelect_EditForm &) –
  • num (Standard_Integer) –
  • newlist (Handle_TColStd_HSequenceOfHAsciiString &) –
  • enforce (bool) –
Return type:

bool

thisown

The membership flag

class OCC.IFSelect.IFSelect_Functions(*args, **kwargs)

Bases: object

static GiveDispatch(*args)
  • 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 brackets : ex.: 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
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • name (char *) –
  • mode (bool) – default value is Standard_True
Return type:

Handle_IFSelect_Dispatch

  • 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 brackets : ex.: 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
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • name (char *) –
  • mode (bool) – default value is Standard_True
Return type:

Handle_IFSelect_Dispatch

static GiveEntity(*args)
  • 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
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • name (char *) – default value is
Return type:

Handle_Standard_Transient

  • 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
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • name (char *) – default value is
Return type:

Handle_Standard_Transient

static GiveEntityNumber(*args)
  • Same as GetEntity, but returns the number in the model of the entity. Returns 0 for null handle
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • name (char *) – default value is
Return type:

int

  • Same as GetEntity, but returns the number in the model of the entity. Returns 0 for null handle
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • name (char *) – default value is
Return type:

int

static GiveList(*args)
  • Computes a List of entities from a WorkSession and two idents, first and second, as follows : if <first> is a Number or Label of an entity : this 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
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • first (char *) – default value is
  • second (char *) – default value is
Return type:

Handle_TColStd_HSequenceOfTransient

  • Computes a List of entities from a WorkSession and two idents, first and second, as follows : if <first> is a Number or Label of an entity : this 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
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • first (char *) – default value is
  • second (char *) – default value is
Return type:

Handle_TColStd_HSequenceOfTransient

  • Computes a List of entities from a WorkSession and two idents, first and second, as follows : if <first> is a Number or Label of an entity : this 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
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • first (char *) – default value is
  • second (char *) – default value is
Return type:

Handle_TColStd_HSequenceOfTransient

static Init()
  • Defines and loads all basic functions (as ActFunc)
Return type:void
thisown

The membership flag

OCC.IFSelect.IFSelect_Functions_GiveDispatch(*args)
  • 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 brackets : ex.: 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
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • name (char *) –
  • mode (bool) – default value is Standard_True
Return type:

Handle_IFSelect_Dispatch

  • 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 brackets : ex.: 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
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • name (char *) –
  • mode (bool) – default value is Standard_True
Return type:

Handle_IFSelect_Dispatch

OCC.IFSelect.IFSelect_Functions_GiveEntity(*args)
  • 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
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • name (char *) – default value is
Return type:

Handle_Standard_Transient

  • 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
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • name (char *) – default value is
Return type:

Handle_Standard_Transient

OCC.IFSelect.IFSelect_Functions_GiveEntityNumber(*args)
  • Same as GetEntity, but returns the number in the model of the entity. Returns 0 for null handle
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • name (char *) – default value is
Return type:

int

  • Same as GetEntity, but returns the number in the model of the entity. Returns 0 for null handle
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • name (char *) – default value is
Return type:

int

OCC.IFSelect.IFSelect_Functions_GiveList(*args)
  • Computes a List of entities from a WorkSession and two idents, first and second, as follows : if <first> is a Number or Label of an entity : this 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
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • first (char *) – default value is
  • second (char *) – default value is
Return type:

Handle_TColStd_HSequenceOfTransient

  • Computes a List of entities from a WorkSession and two idents, first and second, as follows : if <first> is a Number or Label of an entity : this 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
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • first (char *) – default value is
  • second (char *) – default value is
Return type:

Handle_TColStd_HSequenceOfTransient

  • Computes a List of entities from a WorkSession and two idents, first and second, as follows : if <first> is a Number or Label of an entity : this 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
Parameters:
  • WS (Handle_IFSelect_WorkSession &) –
  • first (char *) – default value is
  • second (char *) – default value is
Return type:

Handle_TColStd_HSequenceOfTransient

OCC.IFSelect.IFSelect_Functions_Init()
  • Defines and loads all basic functions (as ActFunc)
Return type:void
class OCC.IFSelect.IFSelect_GeneralModifier(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

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>
Parameters:disp (Handle_IFSelect_Dispatch &) –
Return type:bool
Dispatch()
  • Returns the Dispatch to be matched, Null if not set
Return type:Handle_IFSelect_Dispatch
GetHandle()

IFSelect_GeneralModifier_GetHandle(IFSelect_GeneralModifier self) -> Handle_IFSelect_GeneralModifier

HasSelection()
  • Returns True if a Selection is set as an additionnal criterium
Return type:bool
Label()
  • Returns a short text which defines the operation performed
Return type:TCollection_AsciiString
MayChangeGraph()
  • Returns True if this modifier may change the graph of dependences (aknowledged at creation time)
Return type:bool
ResetSelection()
  • Resets the Selection : this criterium is not longer active
Return type:None
Selection()
  • Returns the Selection, or a Null Handle if not set
Return type:Handle_IFSelect_Selection
SetDispatch()
  • Attaches to a Dispatch. If <disp> is Null, Resets it (to apply the Modifier on every Dispatch)
Parameters:disp (Handle_IFSelect_Dispatch &) –
Return type:None
SetSelection()
  • Sets a Selection : a Model is treated if it contains one or more Entities designated by the Selection
Parameters:sel (Handle_IFSelect_Selection &) –
Return type:None
thisown

The membership flag

class OCC.IFSelect.IFSelect_GraphCounter(*args)

Bases: OCC.IFSelect.IFSelect_SignCounter

Applied()
  • Returns the applied selection
Return type:Handle_IFSelect_SelectDeduct
GetHandle()

IFSelect_GraphCounter_GetHandle(IFSelect_GraphCounter self) -> Handle_IFSelect_GraphCounter

SetApplied()
  • Sets a new applied selection
Parameters:sel (Handle_IFSelect_SelectDeduct &) –
Return type:None
thisown

The membership flag

class OCC.IFSelect.IFSelect_HSeqOfSelection

Bases: OCC.MMgt.MMgt_TShared

Append()
Parameters:
  • anItem (Handle_IFSelect_Selection &) –
  • aSequence (Handle_IFSelect_HSeqOfSelection &) –
Return type:

None

Return type:

None

ChangeSequence()
Return type:IFSelect_TSeqOfSelection
ChangeValue()
Parameters:anIndex (Standard_Integer) –
Return type:Handle_IFSelect_Selection
Clear()
Return type:None
Exchange()
Parameters:
  • anIndex (Standard_Integer) –
  • anOtherIndex (Standard_Integer) –
Return type:

None

GetHandle()

IFSelect_HSeqOfSelection_GetHandle(IFSelect_HSeqOfSelection self) -> Handle_IFSelect_HSeqOfSelection

InsertAfter()
Parameters:
  • anIndex (Standard_Integer) –
  • anItem (Handle_IFSelect_Selection &) –
  • anIndex
  • aSequence (Handle_IFSelect_HSeqOfSelection &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • anIndex (Standard_Integer) –
  • anItem (Handle_IFSelect_Selection &) –
  • anIndex
  • aSequence (Handle_IFSelect_HSeqOfSelection &) –
Return type:

None

Return type:

None

IsEmpty()
Return type:bool
Length()
Return type:int
Prepend()
Parameters:
  • anItem (Handle_IFSelect_Selection &) –
  • aSequence (Handle_IFSelect_HSeqOfSelection &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • anIndex (Standard_Integer) –
  • fromIndex (Standard_Integer) –
  • toIndex (Standard_Integer) –
Return type:

None

Return type:

None

Reverse()
Return type:None
Sequence()
Return type:IFSelect_TSeqOfSelection
SetValue()
Parameters:
  • anIndex (Standard_Integer) –
  • anItem (Handle_IFSelect_Selection &) –
Return type:

None

ShallowCopy()
Return type:Handle_IFSelect_HSeqOfSelection
Split()
Parameters:anIndex (Standard_Integer) –
Return type:Handle_IFSelect_HSeqOfSelection
Value()
Parameters:anIndex (Standard_Integer) –
Return type:Handle_IFSelect_Selection
thisown

The membership flag

class OCC.IFSelect.IFSelect_IntParam

Bases: OCC.MMgt.MMgt_TShared

GetHandle()

IFSelect_IntParam_GetHandle(IFSelect_IntParam self) -> Handle_IFSelect_IntParam

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
Parameters:statname (char *) –
Return type: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
Parameters:val (Standard_Integer) –
Return type: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
Return type:int
thisown

The membership flag

class OCC.IFSelect.IFSelect_ListEditor(*args)

Bases: OCC.MMgt.MMgt_TShared

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
Parameters:
  • val (Handle_TCollection_HAsciiString &) –
  • atnum (Standard_Integer) – default value is 0
Return type:

bool

  • 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
Parameters:
  • val (Handle_TCollection_HAsciiString &) –
  • atnum (Standard_Integer) – default value is 0
Return type:

bool

ClearEdit()
  • Clears all editions already recorded
Return type:None
EditedValues()
  • Returns the result of the edition
Return type:Handle_TColStd_HSequenceOfHAsciiString
GetHandle()

IFSelect_ListEditor_GetHandle(IFSelect_ListEditor self) -> Handle_IFSelect_ListEditor

IsAdded()
  • Tells if a value (in edited list) has been added (new one)
Parameters:num (Standard_Integer) –
Return type:bool
IsChanged()
  • Tells if a value (in edited list) has been changed, i.e. either modified-value, or added
Parameters:num (Standard_Integer) –
Return type:bool
IsModified()
  • Tells if a value (in edited list) has been modified-value (not added)
Parameters:num (Standard_Integer) –
Return type:bool
IsTouched()
  • Tells if at least one edition (SetValue-AddValue-Remove) has been recorded
Return type: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 ...
Parameters:list (Handle_TColStd_HSequenceOfHAsciiString &) –
Return type:bool
LoadModel()
  • Loads a Model. It is used to check items of type Entity(Ident)
Parameters:model (Handle_Interface_InterfaceModel &) –
Return type:None
LoadValues()
  • Loads the original values for the list Remark : If its length is mor then MaxLength, editions remain allowed, except Add
Parameters:vals (Handle_TColStd_HSequenceOfHAsciiString &) –
Return type:None
NbValues()
  • Returns count of values, edited (D) or original
Parameters:edited (bool) – default value is Standard_True
Return type:int
  • Returns count of values, edited (D) or original
Parameters:edited (bool) – default value is Standard_True
Return type:int
OriginalValues()
  • Returns the value from which the edition started
Return type: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
Parameters:
  • num (Standard_Integer) – default value is 0
  • howmany (Standard_Integer) – default value is 1
Return type:

bool

  • 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
Parameters:
  • num (Standard_Integer) – default value is 0
  • howmany (Standard_Integer) – default value is 1
Return type:

bool

  • 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
Parameters:
  • num (Standard_Integer) – default value is 0
  • howmany (Standard_Integer) – default value is 1
Return type:

bool

SetTouched()
  • Declares this ListEditor to have been touched (whatever action)
Return type: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
Parameters:
  • num (Standard_Integer) –
  • val (Handle_TCollection_HAsciiString &) –
Return type:

bool

Value()
  • Returns a value given its rank. Edited (D) or Original A Null String means the value is cleared but not removed
Parameters:
  • num (Standard_Integer) –
  • edited (bool) – default value is Standard_True
Return type:

Handle_TCollection_HAsciiString

  • Returns a value given its rank. Edited (D) or Original A Null String means the value is cleared but not removed
Parameters:
  • num (Standard_Integer) –
  • edited (bool) – default value is Standard_True
Return type:

Handle_TCollection_HAsciiString

thisown

The membership flag

class OCC.IFSelect.IFSelect_ModelCopier

Bases: OCC.MMgt.MMgt_TShared

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
Parameters:
  • filename (TCollection_AsciiString &) –
  • content (Handle_Interface_InterfaceModel &) –
Return type:

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
Parameters:filename (char *) –
Return type:None
AppliedModifiers()
  • Returns the list of File Modifiers to be applied on a file when it will be sent, as computed by CopiedModel : If it is a null handle, no File Modifier has to be applied.
Parameters:num (Standard_Integer) –
Return type: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’
Parameters:
  • sho (Handle_IFSelect_ShareOut &) –
  • record (bool) –
Return type:

None

ClearAppliedModifiers()
  • Clears the list of File Modifiers to be applied on a file
Parameters:num (Standard_Integer) –
Return type: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 else : if <num> is out of range
Parameters:num (Standard_Integer) –
Return type:bool
ClearResult()
  • Clears the list of produced Models
Return type: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>.
Parameters:
  • G (Interface_Graph &) –
  • WL (Handle_IFSelect_WorkLibrary &) –
  • TC (Interface_CopyTool &) –
  • newmod (Handle_Interface_InterfaceModel &) –
Return type:

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
Parameters:
  • eval (IFSelect_ShareOutResult &) –
  • WL (Handle_IFSelect_WorkLibrary &) –
  • protocol (Handle_Interface_Protocol &) –
Return type:

Interface_CheckIterator

FileModel()
  • Returns the content of a file before sending, under the form of an InterfaceModel, given its rank
Parameters:num (Standard_Integer) –
Return type: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>
Parameters:num (Standard_Integer) –
Return type:TCollection_AsciiString
GetHandle()

IFSelect_ModelCopier_GetHandle(IFSelect_ModelCopier self) -> Handle_IFSelect_ModelCopier

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

bool

NbFiles()
  • Returns the count of Files produced, i.e. the count of Models memorized (produced by the mmethod Copy) with their file names
Return type:int
Send()
  • Performs the Copy Operations (which include the Modifications) and Sends the result on files, without memorizing it. (the memorized result is ignored : neither queried not filled)
Parameters:
  • eval (IFSelect_ShareOutResult &) –
  • WL (Handle_IFSelect_WorkLibrary &) –
  • protocol (Handle_Interface_Protocol &) –
Return type:

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
Parameters:
  • filename (char *) –
  • G (Interface_Graph &) –
  • WL (Handle_IFSelect_WorkLibrary &) –
  • protocol (Handle_Interface_Protocol &) –
Return type:

Interface_CheckIterator

SendCopied()
  • Sends the formerly defined results (see method Copy) to files, then clears it Remark : A Null File Name cause file to be not produced
Parameters:
  • WL (Handle_IFSelect_WorkLibrary &) –
  • protocol (Handle_Interface_Protocol &) –
Return type:

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
Parameters:
  • filename (char *) –
  • G (Interface_Graph &) –
  • WL (Handle_IFSelect_WorkLibrary &) –
  • protocol (Handle_Interface_Protocol &) –
  • iter (Interface_EntityIterator &) –
Return type:

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.
Return type:Handle_TColStd_HSequenceOfHAsciiString
SetAppliedModifiers()
  • Sets a list of File Modifiers to be applied on a file
Parameters:
  • num (Standard_Integer) –
  • applied (Handle_IFSelect_AppliedModifiers &) –
Return type:

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)
Parameters:CG (Interface_Graph &) –
Return type:bool
SetShareOut()
  • Sets the ShareOut, which is used to define Modifiers to apply
Parameters:sho (Handle_IFSelect_ShareOut &) –
Return type:None
thisown

The membership flag

class OCC.IFSelect.IFSelect_ModifEditForm(*args)

Bases: OCC.IFSelect.IFSelect_Modifier

EditForm()
  • Returns the EditForm
Return type:Handle_IFSelect_EditForm
GetHandle()

IFSelect_ModifEditForm_GetHandle(IFSelect_ModifEditForm self) -> Handle_IFSelect_ModifEditForm

thisown

The membership flag

class OCC.IFSelect.IFSelect_ModifReorder(*args)

Bases: OCC.IFSelect.IFSelect_Modifier

GetHandle()

IFSelect_ModifReorder_GetHandle(IFSelect_ModifReorder self) -> Handle_IFSelect_ModifReorder

thisown

The membership flag

class OCC.IFSelect.IFSelect_Modifier(*args, **kwargs)

Bases: OCC.IFSelect.IFSelect_GeneralModifier

GetHandle()

IFSelect_Modifier_GetHandle(IFSelect_Modifier self) -> Handle_IFSelect_Modifier

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
Parameters:
  • ctx (IFSelect_ContextModif &) –
  • target (Handle_Interface_InterfaceModel &) –
  • protocol (Handle_Interface_Protocol &) –
  • TC (Interface_CopyTool &) –
Return type:

void

thisown

The membership flag

class OCC.IFSelect.IFSelect_PacketList(*args)

Bases: OCC.MMgt.MMgt_TShared

Add()
  • Adds an entity from the Model into the current packet for Add
Parameters:ent (Handle_Standard_Transient &) –
Return type:None
AddList()
  • Adds an list of entities into the current packet for Add
Parameters:list (Handle_TColStd_HSequenceOfTransient &) –
Return type:None
AddPacket()
  • Declares a new Packet, ready to be filled The entities to be added will be added to this Packet
Return type:None
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)
Parameters:
  • count (Standard_Integer) –
  • andmore (bool) –
Return type:

Interface_EntityIterator

Entities()
  • Returns the content of a Packet given its rank Null Handle if <numpack> is out of range
Parameters:numpack (Standard_Integer) –
Return type:Interface_EntityIterator
GetHandle()

IFSelect_PacketList_GetHandle(IFSelect_PacketList self) -> Handle_IFSelect_PacketList

HighestDuplicationCount()
  • Returns the highest number of packets which know a same entity For no duplication, should be one
Return type:int
Model()
  • Returns the Model of reference
Return type:Handle_Interface_InterfaceModel
Name()
  • Returns the recorded name for a packet list
Return type: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
Parameters:
  • count (Standard_Integer) –
  • andmore (bool) –
Return type:

int

NbEntities()
  • Returns the count of entities in a Packet given its rank, or 0
Parameters:numpack (Standard_Integer) –
Return type:int
NbPackets()
  • Returns the count of non-empty packets
Return type:int
SetName()
  • Sets a name to a packet list : this makes easier a general routine to print it. Default is ‘Packets’
Parameters:name (char *) –
Return type:None
thisown

The membership flag

class OCC.IFSelect.IFSelect_ParamEditor(nbmax=100, label='')

Bases: OCC.IFSelect.IFSelect_Editor

AddConstantText()
  • Adds a Constant Text, it will be Read Only By default, its long name equates its shortname
Parameters:
  • val (char *) –
  • shortname (char *) –
  • completename (char *) – default value is
Return type:

None

  • Adds a Constant Text, it will be Read Only By default, its long name equates its shortname
Parameters:
  • val (char *) –
  • shortname (char *) –
  • completename (char *) – default value is
Return type:

None

AddValue()
  • Adds a TypedValue By default, its short name equates its complete name, it can be explicited
Parameters:
  • val (Handle_Interface_TypedValue &) –
  • shortname (char *) – default value is
Return type:

None

  • Adds a TypedValue By default, its short name equates its complete name, it can be explicited
Parameters:
  • val (Handle_Interface_TypedValue &) –
  • shortname (char *) – default value is
Return type:

None

GetHandle()

IFSelect_ParamEditor_GetHandle(IFSelect_ParamEditor self) -> Handle_IFSelect_ParamEditor

static StaticEditor(*args)
  • Returns a ParamEditor to work on the Static Parameters of which names are listed in <list> Null Handle if <list> is null or empty
Parameters:
  • list (Handle_TColStd_HSequenceOfHAsciiString &) –
  • label (char *) – default value is
Return type:

Handle_IFSelect_ParamEditor

  • Returns a ParamEditor to work on the Static Parameters of which names are listed in <list> Null Handle if <list> is null or empty
Parameters:
  • list (Handle_TColStd_HSequenceOfHAsciiString &) –
  • label (char *) – default value is
Return type:

Handle_IFSelect_ParamEditor

thisown

The membership flag

OCC.IFSelect.IFSelect_ParamEditor_StaticEditor(*args)
  • Returns a ParamEditor to work on the Static Parameters of which names are listed in <list> Null Handle if <list> is null or empty
Parameters:
  • list (Handle_TColStd_HSequenceOfHAsciiString &) –
  • label (char *) – default value is
Return type:

Handle_IFSelect_ParamEditor

  • Returns a ParamEditor to work on the Static Parameters of which names are listed in <list> Null Handle if <list> is null or empty
Parameters:
  • list (Handle_TColStd_HSequenceOfHAsciiString &) –
  • label (char *) – default value is
Return type:

Handle_IFSelect_ParamEditor

class OCC.IFSelect.IFSelect_SelectAnyList(*args, **kwargs)

Bases: OCC.IFSelect.IFSelect_SelectDeduct

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
Parameters:
  • n1 (Standard_Integer) –
  • n2 (Standard_Integer) –
  • ent (Handle_Standard_Transient &) –
  • res (Interface_EntityIterator &) –
Return type:

void

GetHandle()

IFSelect_SelectAnyList_GetHandle(IFSelect_SelectAnyList self) -> Handle_IFSelect_SelectAnyList

HasLower()
  • Returns True if a Lower limit is defined
Return type:bool
HasUpper()
  • Returns True if a Lower limit is defined
Return type: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)
Parameters:iter (Interface_EntityIterator &) –
Return type:void
ListLabel()
  • Returns the specific label for the list, which is included as a part of Label
Return type:TCollection_AsciiString
Lower()
  • Returns Lower limit (if there is; else, value is senseless)
Return type:Handle_IFSelect_IntParam
LowerValue()
  • Returns Integer Value of Lower Limit (0 if none)
Return type:int
NbItems()
  • Returns count of Items in the list in the Entity <ent> If <ent> has not required type, returned value must be Zero
Parameters:ent (Handle_Standard_Transient &) –
Return type:int
SetFrom()
  • Sets a Lower limit but no upper limit
Parameters:rankfrom (Handle_IFSelect_IntParam &) –
Return type:None
SetOne()
  • Sets a unique number (only one Entity will be sorted as True)
Parameters:rank (Handle_IFSelect_IntParam &) –
Return type:None
SetRange()
  • Sets a Range for numbers, with a lower and a upper limits
Parameters:
  • rankfrom (Handle_IFSelect_IntParam &) –
  • rankto (Handle_IFSelect_IntParam &) –
Return type:

None

SetUntil()
  • Sets an Upper limit but no lower limit (equivalent to lower 1)
Parameters:rankto (Handle_IFSelect_IntParam &) –
Return type:None
Upper()
  • Returns Upper limit (if there is; else, value is senseless)
Return type:Handle_IFSelect_IntParam
UpperValue()
  • Returns Integer Value of Upper Limit (0 if none)
Return type:int
thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectAnyType(*args, **kwargs)

Bases: OCC.IFSelect.IFSelect_SelectExtract

GetHandle()

IFSelect_SelectAnyType_GetHandle(IFSelect_SelectAnyType self) -> Handle_IFSelect_SelectAnyType

TypeForMatch()
  • Returns the Type which has to be matched for select
Return type:Handle_Standard_Type
thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectBase(*args, **kwargs)

Bases: OCC.IFSelect.IFSelect_Selection

GetHandle()

IFSelect_SelectBase_GetHandle(IFSelect_SelectBase self) -> Handle_IFSelect_SelectBase

thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectCombine(*args, **kwargs)

Bases: OCC.IFSelect.IFSelect_Selection

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 (InsertBefore : the new <atnum>th item of the list is <sel>)
Parameters:
  • sel (Handle_IFSelect_Selection &) –
  • atnum (Standard_Integer) – default value is 0
Return type:

None

  • 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 (InsertBefore : the new <atnum>th item of the list is <sel>)
Parameters:
  • sel (Handle_IFSelect_Selection &) –
  • atnum (Standard_Integer) – default value is 0
Return type:

None

GetHandle()

IFSelect_SelectCombine_GetHandle(IFSelect_SelectCombine self) -> Handle_IFSelect_SelectCombine

Input()
  • Returns an Input Selection, given its rank in the list
Parameters:num (Standard_Integer) –
Return type: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>
Parameters:sel (Handle_IFSelect_Selection &) –
Return type:int
NbInputs()
  • Returns the count of Input Selections
Return type:int
Remove()
  • Removes an input Selection. Returns True if Done, False, if <sel> is not an input for <self>
Parameters:sel (Handle_IFSelect_Selection &) –
Return type:bool
  • Removes an input Selection, given its rank in the list Returns True if Done, False if <num> is out of range
Parameters:num (Standard_Integer) –
Return type:bool
thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectControl(*args, **kwargs)

Bases: OCC.IFSelect.IFSelect_Selection

GetHandle()

IFSelect_SelectControl_GetHandle(IFSelect_SelectControl self) -> Handle_IFSelect_SelectControl

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
Return type:bool
MainInput()
  • Returns the Main Input Selection
Return type:Handle_IFSelect_Selection
SecondInput()
  • Returns the Control Input Selection, or a Null Handle
Return type:Handle_IFSelect_Selection
SetMainInput()
  • Sets a Selection to be the Main Input
Parameters:sel (Handle_IFSelect_Selection &) –
Return type:None
SetSecondInput()
  • Sets a Selection to be the Control Input
Parameters:sel (Handle_IFSelect_Selection &) –
Return type:None
thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectDeduct(*args, **kwargs)

Bases: OCC.IFSelect.IFSelect_Selection

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
Return type:Handle_IFSelect_SelectPointed
GetHandle()

IFSelect_SelectDeduct_GetHandle(IFSelect_SelectDeduct self) -> Handle_IFSelect_SelectDeduct

HasAlternate()
  • Tells if an Alternate List has been set, i.e. : the Alternate Definition is present and set
Return type:bool
HasInput()
  • Returns True if the Input Selection is defined, False else
Return type:bool
Input()
  • Returns the Input Selection
Return type: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
Parameters:G (Interface_Graph &) –
Return type:Interface_EntityIterator
SetInput()
  • Defines or Changes the Input Selection
Parameters:sel (Handle_IFSelect_Selection &) –
Return type:None
thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectDiff

Bases: OCC.IFSelect.IFSelect_SelectControl

GetHandle()

IFSelect_SelectDiff_GetHandle(IFSelect_SelectDiff self) -> Handle_IFSelect_SelectDiff

thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectEntityNumber

Bases: OCC.IFSelect.IFSelect_SelectBase

GetHandle()

IFSelect_SelectEntityNumber_GetHandle(IFSelect_SelectEntityNumber self) -> Handle_IFSelect_SelectEntityNumber

Number()
  • Returns specified Number (as a Parameter)
Return type:Handle_IFSelect_IntParam
SetNumber()
  • Sets Entity Number to be taken (initially, none is set : 0)
Parameters:num (Handle_IFSelect_IntParam &) –
Return type:None
thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectErrorEntities

Bases: OCC.IFSelect.IFSelect_SelectExtract

GetHandle()

IFSelect_SelectErrorEntities_GetHandle(IFSelect_SelectErrorEntities self) -> Handle_IFSelect_SelectErrorEntities

thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectExplore(*args, **kwargs)

Bases: OCC.IFSelect.IFSelect_SelectDeduct

Explore()
  • Analyses and, if required, Explores an entity, as follows : The 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 considered : If maximum level is attained, it is taken for result Else (or no max), each of its entity will be itself explored
Parameters:
  • level (Standard_Integer) –
  • ent (Handle_Standard_Transient &) –
  • G (Interface_Graph &) –
  • explored (Interface_EntityIterator &) –
Return type:

bool

ExploreLabel()
  • Returns a text defining the way of exploration
Return type:TCollection_AsciiString
GetHandle()

IFSelect_SelectExplore_GetHandle(IFSelect_SelectExplore self) -> Handle_IFSelect_SelectExplore

Level()
  • Returns the required exploring level
Return type:int
thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectExtract(*args, **kwargs)

Bases: OCC.IFSelect.IFSelect_SelectDeduct

ExtractLabel()
  • Returns a text defining the criterium for extraction
Return type:TCollection_AsciiString
GetHandle()

IFSelect_SelectExtract_GetHandle(IFSelect_SelectExtract self) -> Handle_IFSelect_SelectExtract

IsDirect()
  • Returns True if Sort criterium is Direct, False if Reverse
Return type:bool
SetDirect()
  • Sets Sort criterium sense to a new value (True : Direct , False : Reverse)
Parameters:direct (bool) –
Return type: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
Parameters:
  • rank (Standard_Integer) –
  • ent (Handle_Standard_Transient &) –
  • model (Handle_Interface_InterfaceModel &) –
Return type:

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)
Parameters:
  • rank (Standard_Integer) –
  • ent (Handle_Standard_Transient &) –
  • G (Interface_Graph &) –
Return type:

bool

thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectFlag(*args)

Bases: OCC.IFSelect.IFSelect_SelectExtract

FlagName()
  • Returns the name of the flag
Return type:char *
GetHandle()

IFSelect_SelectFlag_GetHandle(IFSelect_SelectFlag self) -> Handle_IFSelect_SelectFlag

thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectInList(*args, **kwargs)

Bases: OCC.IFSelect.IFSelect_SelectAnyList

GetHandle()

IFSelect_SelectInList_GetHandle(IFSelect_SelectInList self) -> Handle_IFSelect_SelectInList

ListedEntity()
  • Returns an Entity, given its rank in the list
Parameters:
  • num (Standard_Integer) –
  • ent (Handle_Standard_Transient &) –
Return type:

Handle_Standard_Transient

thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectIncorrectEntities

Bases: OCC.IFSelect.IFSelect_SelectFlag

GetHandle()

IFSelect_SelectIncorrectEntities_GetHandle(IFSelect_SelectIncorrectEntities self) -> Handle_IFSelect_SelectIncorrectEntities

thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectIntersection

Bases: OCC.IFSelect.IFSelect_SelectCombine

GetHandle()

IFSelect_SelectIntersection_GetHandle(IFSelect_SelectIntersection self) -> Handle_IFSelect_SelectIntersection

thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectModelEntities

Bases: OCC.IFSelect.IFSelect_SelectBase

GetHandle()

IFSelect_SelectModelEntities_GetHandle(IFSelect_SelectModelEntities self) -> Handle_IFSelect_SelectModelEntities

thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectModelRoots

Bases: OCC.IFSelect.IFSelect_SelectBase

GetHandle()

IFSelect_SelectModelRoots_GetHandle(IFSelect_SelectModelRoots self) -> Handle_IFSelect_SelectModelRoots

thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectPointed

Bases: OCC.IFSelect.IFSelect_SelectBase

Add()
  • Adds an item. Returns True if Done, False if <item> is already in the selected list
Parameters:item (Handle_Standard_Transient &) –
Return type:bool
AddList()
  • Adds all the items defined in a list. Returns True if at least one item has been added, False else
Parameters:list (Handle_TColStd_HSequenceOfTransient &) –
Return type:bool
Clear()
  • Clears the list of selected items Also says the list is unset All Add* methods and SetList say the list is set
Return type:None
GetHandle()

IFSelect_SelectPointed_GetHandle(IFSelect_SelectPointed self) -> Handle_IFSelect_SelectPointed

IsSet()
  • Tells if the list has been set. Even if empty
Return type:bool
Item()
  • Returns an item given its rank, or a Null Handle
Parameters:num (Standard_Integer) –
Return type:Handle_Standard_Transient
NbItems()
  • Returns the count of selected items
Return type:int
Rank()
  • Returns the rank of an item in the selected list, or 0.
Parameters:item (Handle_Standard_Transient &) –
Return type:int
Remove()
  • Removes an item. Returns True if Done, False if <item> was not in the selected list
Parameters:item (Handle_Standard_Transient &) –
Return type:bool
RemoveList()
  • Removes all the items defined in a list. Returns True if at least one item has been removed, False else
Parameters:list (Handle_TColStd_HSequenceOfTransient &) –
Return type:bool
SetEntity()
  • As SetList but with only one entity If <ent> is Null, the list is said as being set but is empty
Parameters:item (Handle_Standard_Transient &) –
Return type:None
SetList()
  • Sets a given list to define the list of selected items <list> can be empty or null : in 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
Parameters:list (Handle_TColStd_HSequenceOfTransient &) –
Return type:None
Toggle()
  • Toggles status of an item : adds it if not pointed or removes it if already pointed. Returns the new status (Pointed or not)
Parameters:item (Handle_Standard_Transient &) –
Return type:bool
ToggleList()
  • Toggles status of all the items defined in a list : adds it if not pointed or removes it if already pointed.
Parameters:list (Handle_TColStd_HSequenceOfTransient &) –
Return type:bool
Update()
  • Rebuilds the selected list. Any selected entity which has a bound result is replaced by this result, else it is removed.
Parameters:control (Handle_Interface_CopyControl &) –
Return type:None
  • Rebuilds the selected list, by querying a Transformer (same principle as from a CopyControl)
Parameters:trf (Handle_IFSelect_Transformer &) –
Return type:None
thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectRange

Bases: OCC.IFSelect.IFSelect_SelectExtract

GetHandle()

IFSelect_SelectRange_GetHandle(IFSelect_SelectRange self) -> Handle_IFSelect_SelectRange

HasLower()
  • Returns True if a Lower limit is defined
Return type:bool
HasUpper()
  • Returns True if a Lower limit is defined
Return type:bool
Lower()
  • Returns Lower limit (if there is; else, value is senseless)
Return type:Handle_IFSelect_IntParam
LowerValue()
  • Returns Value of Lower Limit (0 if none is defined)
Return type:int
SetFrom()
  • Sets a Lower limit but no upper limit
Parameters:rankfrom (Handle_IFSelect_IntParam &) –
Return type:None
SetOne()
  • Sets a unique number (only one Entity will be sorted as True)
Parameters:rank (Handle_IFSelect_IntParam &) –
Return type:None
SetRange()
  • Sets a Range for numbers, with a lower and a upper limits Error if rankto is lower then rankfrom
Parameters:
  • rankfrom (Handle_IFSelect_IntParam &) –
  • rankto (Handle_IFSelect_IntParam &) –
Return type:

None

SetUntil()
  • Sets an Upper limit but no lower limit (equivalent to lower 1)
Parameters:rankto (Handle_IFSelect_IntParam &) –
Return type:None
Upper()
  • Returns Upper limit (if there is; else, value is senseless)
Return type:Handle_IFSelect_IntParam
UpperValue()
  • Returns Value of Upper Limit (0 if none is defined)
Return type:int
thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectRootComps

Bases: OCC.IFSelect.IFSelect_SelectExtract

GetHandle()

IFSelect_SelectRootComps_GetHandle(IFSelect_SelectRootComps self) -> Handle_IFSelect_SelectRootComps

thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectRoots

Bases: OCC.IFSelect.IFSelect_SelectExtract

GetHandle()

IFSelect_SelectRoots_GetHandle(IFSelect_SelectRoots self) -> Handle_IFSelect_SelectRoots

thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectSent(*args)

Bases: OCC.IFSelect.IFSelect_SelectExtract

AtLeast()
  • Returns the <atleast> status, True for sending at least the sending count, False for sending exactly the sending count Remark : if SentCount is 0, AtLeast is ignored
Return type:bool
GetHandle()

IFSelect_SelectSent_GetHandle(IFSelect_SelectSent self) -> Handle_IFSelect_SelectSent

SentCount()
  • Returns the queried count of sending
Return type:int
thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectShared

Bases: OCC.IFSelect.IFSelect_SelectDeduct

GetHandle()

IFSelect_SelectShared_GetHandle(IFSelect_SelectShared self) -> Handle_IFSelect_SelectShared

thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectSharing

Bases: OCC.IFSelect.IFSelect_SelectDeduct

GetHandle()

IFSelect_SelectSharing_GetHandle(IFSelect_SelectSharing self) -> Handle_IFSelect_SelectSharing

thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectSignature(*args)

Bases: OCC.IFSelect.IFSelect_SelectExtract

Counter()
  • Returns the used SignCounter. Can be used as alternative for Signature
Return type:Handle_IFSelect_SignCounter
GetHandle()

IFSelect_SelectSignature_GetHandle(IFSelect_SelectSignature self) -> Handle_IFSelect_SelectSignature

IsExact()
  • Returns True if match must be exact
Return type:bool
Signature()
  • Returns the used Signature, then it is possible to access it, modify it as required. Can be null, hence see Counter
Return type:Handle_IFSelect_Signature
SignatureText()
  • Returns Text used to Sort Entity on its Signature or SignCounter
Return type:TCollection_AsciiString
thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectSignedShared(*args)

Bases: OCC.IFSelect.IFSelect_SelectExplore

GetHandle()

IFSelect_SelectSignedShared_GetHandle(IFSelect_SelectSignedShared self) -> Handle_IFSelect_SelectSignedShared

IsExact()
  • Returns True if match must be exact
Return type:bool
Signature()
  • Returns the used Signature, then it is possible to access it, modify it as required
Return type:Handle_IFSelect_Signature
SignatureText()
  • Returns Text used to Sort Entity on its Signature
Return type:TCollection_AsciiString
thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectSignedSharing(*args)

Bases: OCC.IFSelect.IFSelect_SelectExplore

GetHandle()

IFSelect_SelectSignedSharing_GetHandle(IFSelect_SelectSignedSharing self) -> Handle_IFSelect_SelectSignedSharing

IsExact()
  • Returns True if match must be exact
Return type:bool
Signature()
  • Returns the used Signature, then it is possible to access it, modify it as required
Return type:Handle_IFSelect_Signature
SignatureText()
  • Returns Text used to Sort Entity on its Signature
Return type:TCollection_AsciiString
thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectSuite

Bases: OCC.IFSelect.IFSelect_SelectDeduct

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
Parameters:item (Handle_IFSelect_Selection &) –
Return type:bool
AddNext()
  • Adds a new last item (prepends to the list) If <item> is null, does nothing
Parameters:item (Handle_IFSelect_SelectDeduct &) –
Return type:None
AddPrevious()
  • Adds a new first item (prepends to the list). The Input is not touched If <item> is null, does nothing
Parameters:item (Handle_IFSelect_SelectDeduct &) –
Return type:None
GetHandle()

IFSelect_SelectSuite_GetHandle(IFSelect_SelectSuite self) -> Handle_IFSelect_SelectSuite

Item()
  • Returns an item from its rank in the list (the Input is always apart)
Parameters:num (Standard_Integer) –
Return type:Handle_IFSelect_SelectDeduct
NbItems()
  • Returns the count of Items
Return type:int
SetLabel()
  • Sets a value for the Label
Parameters:lab (char *) –
Return type:None
thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectType(*args)

Bases: OCC.IFSelect.IFSelect_SelectAnyType

GetHandle()

IFSelect_SelectType_GetHandle(IFSelect_SelectType self) -> Handle_IFSelect_SelectType

SetType()
  • Sets a TYpe for filter
Parameters:atype (Handle_Standard_Type &) –
Return type:None
thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectUnion

Bases: OCC.IFSelect.IFSelect_SelectCombine

GetHandle()

IFSelect_SelectUnion_GetHandle(IFSelect_SelectUnion self) -> Handle_IFSelect_SelectUnion

thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectUnknownEntities

Bases: OCC.IFSelect.IFSelect_SelectExtract

GetHandle()

IFSelect_SelectUnknownEntities_GetHandle(IFSelect_SelectUnknownEntities self) -> Handle_IFSelect_SelectUnknownEntities

thisown

The membership flag

class OCC.IFSelect.IFSelect_Selection(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

CompleteResult()
  • Returns the list of entities involved by a Selection, i.e. UniqueResult plus the shared entities (directly or not)
Parameters:G (Interface_Graph &) –
Return type:Interface_EntityIterator
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
Parameters:iter (IFSelect_SelectionIterator &) –
Return type:void
GetHandle()

IFSelect_Selection_GetHandle(IFSelect_Selection self) -> Handle_IFSelect_Selection

Label()
  • Returns a text which defines the criterium applied by a Selection (can be used to be printed, displayed ...) Specific to each class
Return type: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
Parameters:G (Interface_Graph &) –
Return type: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.
Parameters:G (Interface_Graph &) –
Return type:Interface_EntityIterator
thisown

The membership flag

class OCC.IFSelect.IFSelect_SelectionIterator(*args)

Bases: object

AddFromIter()
  • Adds to an iterator the content of another one (each selection is present only once in the result)
Parameters:iter (IFSelect_SelectionIterator &) –
Return type:None
AddItem()
  • Adds a Selection to an iterator (if not yet noted)
Parameters:sel (Handle_IFSelect_Selection &) –
Return type:None
AddList()
  • Adds a list of Selections to an iterator (this list comes from the description of a Selection or a Dispatch, etc...)
Parameters:list (IFSelect_TSeqOfSelection &) –
Return type:None
More()
  • Returns True if there are more Selections to get
Return type:bool
Next()
  • Sets iterator to the next item
Return type:None
Value()
  • Returns the current Selction beeing iterated Error if count of Selection has been passed
Return type:Handle_IFSelect_Selection
thisown

The membership flag

class OCC.IFSelect.IFSelect_SequenceNodeOfSequenceOfAppliedModifiers(*args)

Bases: OCC.TCollection.TCollection_SeqNode

GetHandle()

IFSelect_SequenceNodeOfSequenceOfAppliedModifiers_GetHandle(IFSelect_SequenceNodeOfSequenceOfAppliedModifiers self) -> Handle_IFSelect_SequenceNodeOfSequenceOfAppliedModifiers

Value()
Return type:Handle_IFSelect_AppliedModifiers
thisown

The membership flag

class OCC.IFSelect.IFSelect_SequenceNodeOfSequenceOfGeneralModifier(*args)

Bases: OCC.TCollection.TCollection_SeqNode

GetHandle()

IFSelect_SequenceNodeOfSequenceOfGeneralModifier_GetHandle(IFSelect_SequenceNodeOfSequenceOfGeneralModifier self) -> Handle_IFSelect_SequenceNodeOfSequenceOfGeneralModifier

Value()
Return type:Handle_IFSelect_GeneralModifier
thisown

The membership flag

class OCC.IFSelect.IFSelect_SequenceNodeOfSequenceOfInterfaceModel(*args)

Bases: OCC.TCollection.TCollection_SeqNode

GetHandle()

IFSelect_SequenceNodeOfSequenceOfInterfaceModel_GetHandle(IFSelect_SequenceNodeOfSequenceOfInterfaceModel self) -> Handle_IFSelect_SequenceNodeOfSequenceOfInterfaceModel

Value()
Return type:Handle_Interface_InterfaceModel
thisown

The membership flag

class OCC.IFSelect.IFSelect_SequenceNodeOfTSeqOfDispatch(*args)

Bases: OCC.TCollection.TCollection_SeqNode

GetHandle()

IFSelect_SequenceNodeOfTSeqOfDispatch_GetHandle(IFSelect_SequenceNodeOfTSeqOfDispatch self) -> Handle_IFSelect_SequenceNodeOfTSeqOfDispatch

Value()
Return type:Handle_IFSelect_Dispatch
thisown

The membership flag

class OCC.IFSelect.IFSelect_SequenceNodeOfTSeqOfSelection(*args)

Bases: OCC.TCollection.TCollection_SeqNode

GetHandle()

IFSelect_SequenceNodeOfTSeqOfSelection_GetHandle(IFSelect_SequenceNodeOfTSeqOfSelection self) -> Handle_IFSelect_SequenceNodeOfTSeqOfSelection

Value()
Return type:Handle_IFSelect_Selection
thisown

The membership flag

class OCC.IFSelect.IFSelect_SequenceOfAppliedModifiers

Bases: OCC.TCollection.TCollection_BaseSequence

Append()
Parameters:
  • T (Handle_IFSelect_AppliedModifiers &) –
  • S (IFSelect_SequenceOfAppliedModifiers &) –
Return type:

None

Return type:

None

Assign()
Parameters:Other (IFSelect_SequenceOfAppliedModifiers &) –
Return type:IFSelect_SequenceOfAppliedModifiers
ChangeValue()
Parameters:Index (Standard_Integer) –
Return type:Handle_IFSelect_AppliedModifiers
Clear()
Return type:None
First()
Return type:Handle_IFSelect_AppliedModifiers
InsertAfter()
Parameters:
  • Index (Standard_Integer) –
  • T (Handle_IFSelect_AppliedModifiers &) –
  • Index
  • S (IFSelect_SequenceOfAppliedModifiers &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • Index (Standard_Integer) –
  • T (Handle_IFSelect_AppliedModifiers &) –
  • Index
  • S (IFSelect_SequenceOfAppliedModifiers &) –
Return type:

None

Return type:

None

Last()
Return type:Handle_IFSelect_AppliedModifiers
Prepend()
Parameters:
  • T (Handle_IFSelect_AppliedModifiers &) –
  • S (IFSelect_SequenceOfAppliedModifiers &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • Index (Standard_Integer) –
  • FromIndex (Standard_Integer) –
  • ToIndex (Standard_Integer) –
Return type:

None

Return type:

None

Set()
Parameters:Other (IFSelect_SequenceOfAppliedModifiers &) –
Return type:IFSelect_SequenceOfAppliedModifiers
SetValue()
Parameters:
  • Index (Standard_Integer) –
  • I (Handle_IFSelect_AppliedModifiers &) –
Return type:

None

Split()
Parameters:
  • Index (Standard_Integer) –
  • Sub (IFSelect_SequenceOfAppliedModifiers &) –
Return type:

None

Value()
Parameters:Index (Standard_Integer) –
Return type:Handle_IFSelect_AppliedModifiers
thisown

The membership flag

class OCC.IFSelect.IFSelect_SequenceOfGeneralModifier

Bases: OCC.TCollection.TCollection_BaseSequence

Append()
Parameters:
  • T (Handle_IFSelect_GeneralModifier &) –
  • S (IFSelect_SequenceOfGeneralModifier &) –
Return type:

None

Return type:

None

Assign()
Parameters:Other (IFSelect_SequenceOfGeneralModifier &) –
Return type:IFSelect_SequenceOfGeneralModifier
ChangeValue()
Parameters:Index (Standard_Integer) –
Return type:Handle_IFSelect_GeneralModifier
Clear()
Return type:None
First()
Return type:Handle_IFSelect_GeneralModifier
InsertAfter()
Parameters:
  • Index (Standard_Integer) –
  • T (Handle_IFSelect_GeneralModifier &) –
  • Index
  • S (IFSelect_SequenceOfGeneralModifier &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • Index (Standard_Integer) –
  • T (Handle_IFSelect_GeneralModifier &) –
  • Index
  • S (IFSelect_SequenceOfGeneralModifier &) –
Return type:

None

Return type:

None

Last()
Return type:Handle_IFSelect_GeneralModifier
Prepend()
Parameters:
  • T (Handle_IFSelect_GeneralModifier &) –
  • S (IFSelect_SequenceOfGeneralModifier &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • Index (Standard_Integer) –
  • FromIndex (Standard_Integer) –
  • ToIndex (Standard_Integer) –
Return type:

None

Return type:

None

Set()
Parameters:Other (IFSelect_SequenceOfGeneralModifier &) –
Return type:IFSelect_SequenceOfGeneralModifier
SetValue()
Parameters:
  • Index (Standard_Integer) –
  • I (Handle_IFSelect_GeneralModifier &) –
Return type:

None

Split()
Parameters:
  • Index (Standard_Integer) –
  • Sub (IFSelect_SequenceOfGeneralModifier &) –
Return type:

None

Value()
Parameters:Index (Standard_Integer) –
Return type:Handle_IFSelect_GeneralModifier
thisown

The membership flag

class OCC.IFSelect.IFSelect_SequenceOfInterfaceModel

Bases: OCC.TCollection.TCollection_BaseSequence

Append()
Parameters:
  • T (Handle_Interface_InterfaceModel &) –
  • S (IFSelect_SequenceOfInterfaceModel &) –
Return type:

None

Return type:

None

Assign()
Parameters:Other (IFSelect_SequenceOfInterfaceModel &) –
Return type:IFSelect_SequenceOfInterfaceModel
ChangeValue()
Parameters:Index (Standard_Integer) –
Return type:Handle_Interface_InterfaceModel
Clear()
Return type:None
First()
Return type:Handle_Interface_InterfaceModel
InsertAfter()
Parameters:
  • Index (Standard_Integer) –
  • T (Handle_Interface_InterfaceModel &) –
  • Index
  • S (IFSelect_SequenceOfInterfaceModel &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • Index (Standard_Integer) –
  • T (Handle_Interface_InterfaceModel &) –
  • Index
  • S (IFSelect_SequenceOfInterfaceModel &) –
Return type:

None

Return type:

None

Last()
Return type:Handle_Interface_InterfaceModel
Prepend()
Parameters:
  • T (Handle_Interface_InterfaceModel &) –
  • S (IFSelect_SequenceOfInterfaceModel &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • Index (Standard_Integer) –
  • FromIndex (Standard_Integer) –
  • ToIndex (Standard_Integer) –
Return type:

None

Return type:

None

Set()
Parameters:Other (IFSelect_SequenceOfInterfaceModel &) –
Return type:IFSelect_SequenceOfInterfaceModel
SetValue()
Parameters:
  • Index (Standard_Integer) –
  • I (Handle_Interface_InterfaceModel &) –
Return type:

None

Split()
Parameters:
  • Index (Standard_Integer) –
  • Sub (IFSelect_SequenceOfInterfaceModel &) –
Return type:

None

Value()
Parameters:Index (Standard_Integer) –
Return type:Handle_Interface_InterfaceModel
thisown

The membership flag

class OCC.IFSelect.IFSelect_SessionDumper(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

static First()
  • Returns the First item of the Library of Dumper. The Next ones are then obtained by Next on the returned items
Return type:Handle_IFSelect_SessionDumper
GetHandle()

IFSelect_SessionDumper_GetHandle(IFSelect_SessionDumper self) -> Handle_IFSelect_SessionDumper

Next()
  • Returns the Next SesionDumper in the Library. Returns a Null Handle at the End.
Return type: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 else : in that case, SessionFile will try another SessionDumper in the Library. ReadOwn can use these methods from SessionFile to access Own Parameters : NbOwnParams, IsVoid, IsText, TextValue, ItemValue
Parameters:
  • file (IFSelect_SessionFile &) –
  • type (TCollection_AsciiString &) –
  • item (Handle_Standard_Transient &) –
Return type:

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 else : in that case, SessionFile will try another SessionDumper in the Library. WriteOwn can use these methods from SessionFile : SendVoid, SendItem, SendText, and if necessary, WorkSession.
Parameters:
  • file (IFSelect_SessionFile &) –
  • item (Handle_Standard_Transient &) –
Return type:

bool

thisown

The membership flag

OCC.IFSelect.IFSelect_SessionDumper_First()
  • Returns the First item of the Library of Dumper. The Next ones are then obtained by Next on the returned items
Return type:Handle_IFSelect_SessionDumper
class OCC.IFSelect.IFSelect_SessionFile(*args)

Bases: object

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
Parameters:
  • item (Handle_Standard_Transient &) –
  • active (bool) – default value is Standard_True
Return type:

None

  • 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
Parameters:
  • item (Handle_Standard_Transient &) –
  • active (bool) – default value is Standard_True
Return type:

None

AddLine()
  • Adds a line to the list of recorded lines
Parameters:line (char *) –
Return type:None
ClearLines()
  • Clears the lines recorded whatever for writing or for reading
Return type:None
Destroy()
  • Specific Destructor (closes the File if not yet done)
Return type:None
IsDone()
  • Returns True if the last Read or Write operation has been corectly performed. ELse returns False.
Return type: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.
Parameters:num (Standard_Integer) –
Return type: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)
Parameters:num (Standard_Integer) –
Return type: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
Parameters:num (Standard_Integer) –
Return type:Handle_Standard_Transient
Line()
  • Returns a line given its rank in the list of recorded lines
Parameters:num (Standard_Integer) –
Return type:TCollection_AsciiString
NbLines()
  • Returns the count of recorded lines
Return type:int
NbParams()
  • During a Read operation, SessionFile processes sequencially the Items to read. For each one, it gives access to the list of its Parameters : they were defined by calls to SendVoid/SendParam/SendText during Writing the File. NbParams returns the count of Parameters for the line currently read.
Return type: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 cdl : pk_class) This basic description can be followed by the parameters which are used in the definition of the item.
Parameters:
  • ident (Standard_Integer) –
  • par (Handle_Standard_Transient &) –
Return type:

None

ParamValue()
  • Returns a Parameter (alphanumeric item of a line) as it has been read
Parameters:num (Standard_Integer) –
Return type:TCollection_AsciiString
Read()
  • Performs a Read Operation from a file to a WorkSession i.e. calls ReadFile, then ReadSession and ReadEnd Returned Value is : 0 for OK, -1 File could not be opened, >0 Error during Read (see WriteSession) IsDone can be called too (will return True for OK)
Parameters:filename (char *) –
Return type: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).
Return type: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
Parameters:name (char *) –
Return type:bool
ReadLine()
  • Reads a Line and splits it into a set of alphanumeric items, which can then be queried by NbParams/ParamValue ...
Return type: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
Parameters:item (Handle_Standard_Transient &) –
Return type: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 Remark : this 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)
Return type:int
RecognizeFile()
  • Recognizes the header line. returns True if OK, False else
Parameters:headerline (char *) –
Return type:bool
RemoveLastLine()
  • Removes the last line. Can be called recursively. Does nothing if the list is empty
Return type:None
SendItem()
  • During a Write action, commands to send the identification of a Parameter : if 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)
Parameters:par (Handle_Standard_Transient &) –
Return type:None
SendText()
  • During a Write action, commands to send a Text without interpretation. It will be sent as well
Parameters:text (char *) –
Return type: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 : $
Return type: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.
Parameters:lastgen (Standard_Integer) –
Return type: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
Parameters:mode (bool) –
Return type:None
SplitLine()
  • Internal routine which processes a line into words and prepares its exploration
Parameters:line (char *) –
Return type:None
TextValue()
  • Returns the content of a Text Parameter (without the quotes). Returns an empty string if the Parameter is not a Text.
Parameters:num (Standard_Integer) –
Return type:TCollection_AsciiString
WorkSession()
  • Returns the WorkSession on which a SessionFile works. Remark that it is returned as Immutable.
Return type:Handle_IFSelect_WorkSession
Write()
  • Performs a Write Operation from a WorkSession to a File i.e. calls WriteSession then WriteEnd, and WriteFile Returned Value is : 0 for OK, -1 File could not be created, >0 Error during Write (see WriteSession) IsDone can be called too (will return True for OK)
Parameters:filename (char *) –
Return type: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
Return type: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
Parameters:name (char *) –
Return type:bool
WriteLine()
  • Writes a line to the File. If <follow> is given, it is added at the following of the line. ‘
must be added for the end.
Parameters:
  • line (char *) –
  • follow (Standard_Character) – default value is 0
Return type:

None

  • Writes a line to the File. If <follow> is given, it is added at the following of the line. ‘
must be added for the end.
Parameters:
  • line (char *) –
  • follow (Standard_Character) – default value is 0
Return type:

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)
Parameters:item (Handle_Standard_Transient &) –
Return type: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 Remark : this excludes the reading of the last line, which is performed by WriteEnd Returns 0 if OK, status > 0 in case of error
Return type:int
thisown

The membership flag

class OCC.IFSelect.IFSelect_SessionPilot(prompt='')

Bases: OCC.IFSelect.IFSelect_Activator

Arg()
  • Returns a word given its rank, as a CString. As for Word, begins at 0 (the command name), etc...
Parameters:num (Standard_Integer) –
Return type:char *
Clear()
  • Clears the recorded informations (commands, objects)
Return type:None
Command()
  • Returns a recorded Command, given its rank (from 1)
Parameters:num (Standard_Integer) –
Return type:TCollection_AsciiString
CommandLine()
  • Returns the Command Line to be interpreted
Return type: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
Parameters:numarg (Standard_Integer) – default value is 0
Return type:char *
  • 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
Parameters:numarg (Standard_Integer) – default value is 0
Return type:char *
Execute()
  • Sets the Command then tries to execute it. Return value : same as for Perform
Parameters:command (TCollection_AsciiString &) –
Return type: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
Parameters:aliasname (TCollection_AsciiString &) –
Return type: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
Parameters:
  • counter (Handle_IFSelect_SignCounter &) –
  • numword (Standard_Integer) –
  • mode (IFSelect_PrintCount) – default value is IFSelect_CountByItem
Return type:

IFSelect_ReturnStatus

  • 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
Parameters:
  • counter (Handle_IFSelect_SignCounter &) –
  • numword (Standard_Integer) –
  • mode (IFSelect_PrintCount) – default value is IFSelect_CountByItem
Return type:

IFSelect_ReturnStatus

GetHandle()

IFSelect_SessionPilot_GetHandle(IFSelect_SessionPilot self) -> Handle_IFSelect_SessionPilot

Library()
  • Returns the WorKlibrary (Null if not set). WorkLibrary is used to Read and Write Files, according to the Norm
Return type:Handle_IFSelect_WorkLibrary
NbCommands()
  • Returns the count of recorded Commands
Return type:int
NbWords()
  • Returns the count of words of the Command Line, separated by blanks : 0 if empty, one if a command without args, else it gives the count of args minus one. Warning : limited to 10 (command title + 9 args)
Return type:int
Number()
  • Interprets a string value as an entity number : if it gives an integer, returns its value else, considers it as ENtityLabel (preferably case sensitive) in case of failure, returns 0
Parameters:val (char *) –
Return type:int
Perform()
  • Executes the Command, itself (for built-in commands, which have priority) or by using the list of Activators. The value returned is : RetVoid 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).
Return type: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 Do : RetEnd for normal end, RetFail if script could not be opened
Parameters:file (char *) – default value is
Return type:IFSelect_ReturnStatus
  • 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 Do : RetEnd for normal end, RetFail if script could not be opened
Parameters:file (char *) – default value is
Return type: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 Remark : it is nullified for each Perform
Parameters:item (Handle_Standard_Transient &) –
Return type:IFSelect_ReturnStatus
RecordMode()
  • Returns the Record Mode for Commands. Default is False.
Return type:bool
RecordedItem()
  • Returns the Transient Object which was recorded with the current Line Command. If none was, returns a Null Handle
Return type:Handle_Standard_Transient
RemoveWord()
  • Removes a word given its rank. Returns True if Done, False if <num> is out of range
Parameters:num (Standard_Integer) –
Return type:bool
Session()
  • Returns the WorkSession which is worked on
Return type:Handle_IFSelect_WorkSession
SetCommandLine()
  • Sets the value of the Command Line to be interpreted Also prepares the interpretation (splitting by blanks)
Parameters:command (TCollection_AsciiString &) –
Return type:None
SetLibrary()
  • Sets a WorkLibrary
Parameters:WL (Handle_IFSelect_WorkLibrary &) –
Return type:None
SetRecordMode()
  • Changes the RecordMode.
Parameters:mode (bool) –
Return type:None
SetSession()
  • Sets a WorkSession to be worked on
Parameters:WS (Handle_IFSelect_WorkSession &) –
Return type: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...
Parameters:num (Standard_Integer) –
Return type:TCollection_AsciiString
thisown

The membership flag

class OCC.IFSelect.IFSelect_ShareOut

Bases: OCC.MMgt.MMgt_TShared

AddDispatch()
  • Adds a Dispatch to the list
Parameters:disp (Handle_IFSelect_Dispatch &) –
Return type:None
AddModif()
  • Adds a Modifier to the list of Modifiers : Model Modifiers if <formodel> is True, File Modifiers else (internal).
Parameters:
  • modifier (Handle_IFSelect_GeneralModifier &) –
  • formodel (bool) –
  • atnum (Standard_Integer) – default value is 0
Return type:

None

  • Adds a Modifier to the list of Modifiers : Model Modifiers if <formodel> is True, File Modifiers else (internal).
Parameters:
  • modifier (Handle_IFSelect_GeneralModifier &) –
  • formodel (bool) –
  • atnum (Standard_Integer) – default value is 0
Return type:

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 Model : its criteria are checked and if they are OK, the method Perform of this Modifier is run.
Parameters:
  • modifier (Handle_IFSelect_GeneralModifier &) –
  • atnum (Standard_Integer) –
Return type:

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
Parameters:
  • modifier (Handle_IFSelect_GeneralModifier &) –
  • dispnum (Standard_Integer) –
  • atnum (Standard_Integer) –
Return type:

None

ChangeModifierRank()
  • Changes the rank of a modifier in the list : Model Modifiers if <formodel> is True, File Modifiers else from <before> to <after> Returns True if done, False else (before or after out of range)
Parameters:
  • formodel (bool) –
  • befor (Standard_Integer) –
  • after (Standard_Integer) –
Return type:

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
Parameters:onlydisp (bool) –
Return type: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)
Parameters:alsoname (bool) –
Return type:None
DefaultRootName()
  • Returns the Default Root Name. Can be empty.
Return type:Handle_TCollection_HAsciiString
Dispatch()
  • Returns a Dispatch, given its rank in the list
Parameters:num (Standard_Integer) –
Return type:Handle_IFSelect_Dispatch
DispatchRank()
  • Returns the Rank of a Dispatch, given its Value (Handle). Returns 0 if the Dispatch is unknown in the ShareOut
Parameters:disp (Handle_IFSelect_Dispatch &) –
Return type:int
Extension()
  • Returns the general Extension. Can be empty (not recommanded)
Return type: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, concatenated : General 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>
Parameters:
  • dnum (Standard_Integer) –
  • pnum (Standard_Integer) –
  • nbpack (Standard_Integer) – default value is 0
Return type:

TCollection_AsciiString

  • 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, concatenated : General 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>
Parameters:
  • dnum (Standard_Integer) –
  • pnum (Standard_Integer) –
  • nbpack (Standard_Integer) – default value is 0
Return type:

TCollection_AsciiString

GeneralModifier()
  • Returns a Modifier of the list, given its rank : Model Modifiers if <formodel> is True, File Modifiers else
Parameters:
  • formodel (bool) –
  • num (Standard_Integer) –
Return type:

Handle_IFSelect_GeneralModifier

GetHandle()

IFSelect_ShareOut_GetHandle(IFSelect_ShareOut self) -> Handle_IFSelect_ShareOut

HasRootName()
  • Returns True if the Dispatch of rank <num> has an attached Root Name. False else, or if num is out of range
Parameters:num (Standard_Integer) –
Return type:bool
LastRun()
  • Returns the rank of last run item (ClearResult resets it to 0)
Return type:int
ModelModifier()
  • Returns a Modifier of the list of Model Modifiers, duely casted
Parameters:num (Standard_Integer) –
Return type: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
Parameters:modifier (Handle_IFSelect_GeneralModifier &) –
Return type:int
NbDispatches()
  • Returns the count of Dispatches
Return type:int
NbModifiers()
  • Returns count of Modifiers (which apply to complete Models) : Model Modifiers if <formodel> is True, File Modifiers else
Parameters:formodel (bool) –
Return type:int
Prefix()
  • Returns the general Prefix. Can be empty.
Return type: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)
Parameters:rank (Standard_Integer) –
Return type: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.
Parameters:item (Handle_Standard_Transient &) –
Return type:bool
RemoveModifier()
  • Removes a Modifier, given it rank in the list : Model Modifiers if <formodel> is True, File Modifiers else Returns True if done, False if <num> is out of range
Parameters:
  • formodel (bool) –
  • num (Standard_Integer) –
Return type:

bool

RootName()
  • Returns the Root bound to a Dispatch, given its rank Returns a Null Handle if not defined
Parameters:num (Standard_Integer) –
Return type:Handle_TCollection_HAsciiString
RootNumber()
  • Returns an integer value about a given root name : - positive : it’s the rank of the Dispatch which has this name - null : this root name is unknown - negative (-1) : this root name is the default root name
Parameters:name (Handle_TCollection_HAsciiString &) –
Return type: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
Parameters:defrt (Handle_TCollection_HAsciiString &) –
Return type: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
Parameters:ext (Handle_TCollection_HAsciiString &) –
Return type:None
SetLastRun()
  • Records a new alue for the rank of last run item
Parameters:last (Standard_Integer) –
Return type: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
Parameters:pref (Handle_TCollection_HAsciiString &) –
Return type: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
Parameters:
  • num (Standard_Integer) –
  • name (Handle_TCollection_HAsciiString &) –
Return type:

bool

thisown

The membership flag

class OCC.IFSelect.IFSelect_ShareOutResult(*args)

Bases: object

Dispatch()
  • Returns the current Dispatch
Return type:Handle_IFSelect_Dispatch
DispatchRank()
  • Returns the Rank of the current Dispatch in the ShareOut Returns Zero if there is none (iteration finished)
Return type:int
Evaluate()
  • Evaluates the result of a ShareOut : determines 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.
Return type: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
Return type:TCollection_AsciiString
Graph()
  • Returns the Graph used to create theShareOutResult
Return type:Interface_Graph
More()
  • Returns True if there is more packets in the current Dispatch, else if there is more Dispatch in the ShareOut
Return type:bool
NbPackets()
  • Returns the total count of produced non empty packets (in out : calls Evaluate as necessary)
Return type:int
Next()
  • Passes to the next Packet in the current Dispatch, or if there is none, to the next Dispatch in the ShareOut
Return type:None
NextDispatch()
  • Passes to the next Dispatch, regardless about remaining packets
Return type:None
PacketContent()
  • Returns the complete content of the current Packet (i.e. with shared entities, which will also be put in the file)
Return type: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)
Return type: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 entity : this mode allows to evaluate duplications Remark that to send packets, iteration remains preferable (file names are managed)
Parameters:complete (bool) – default value is Standard_True
Return type:Handle_IFSelect_PacketList
  • 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 entity : this mode allows to evaluate duplications Remark that to send packets, iteration remains preferable (file names are managed)
Parameters:complete (bool) – default value is Standard_True
Return type:Handle_IFSelect_PacketList
PacketsInDispatch()
  • Returns Number (rank) of current Packet in current Dispatch, and total count of Packets in current Dispatch, as arguments
Parameters:
  • numpack (Standard_Integer &) –
  • nbpacks (Standard_Integer &) –
Return type:

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
Return type:None
Reset()
  • Erases computed data, in order to command a new Evaluation
Return type:None
ShareOut()
  • Returns the ShareOut used to create the ShareOutResult if creation from a Dispatch, returns a Null Handle
Return type:Handle_IFSelect_ShareOut
thisown

The membership flag

class OCC.IFSelect.IFSelect_SignAncestor(*args)

Bases: OCC.IFSelect.IFSelect_SignType

GetHandle()
thisown

The membership flag

class OCC.IFSelect.IFSelect_SignCategory

Bases: OCC.IFSelect.IFSelect_Signature

GetHandle()
thisown

The membership flag

class OCC.IFSelect.IFSelect_SignCounter(*args)

Bases: OCC.IFSelect.IFSelect_SignatureList

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)
Parameters:
  • ent (Handle_Standard_Transient &) –
  • model (Handle_Interface_InterfaceModel &) –
Return type:

bool

AddFromSelection()
  • Adds the result determined by a Selection from a Graph Remark : does not impact at all data from SetSelection & Co
Parameters:
  • sel (Handle_IFSelect_Selection &) –
  • G (Interface_Graph &) –
Return type:

None

AddList()
  • Adds a list of entities by adding each of the items
Parameters:
  • list (Handle_TColStd_HSequenceOfTransient &) –
  • model (Handle_Interface_InterfaceModel &) –
Return type:

None

AddModel()
  • Adds all the entities contained in a Model
Parameters:model (Handle_Interface_InterfaceModel &) –
Return type: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)
Parameters:
  • ent (Handle_Standard_Transient &) –
  • model (Handle_Interface_InterfaceModel &) –
Return type:

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
Parameters:
  • list (Handle_TColStd_HSequenceOfTransient &) –
  • graph (Interface_Graph &) –
Return type:

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 entities : computation is not redone unless <forced> is given as True
Parameters:
  • G (Interface_Graph &) –
  • forced (bool) – default value is Standard_False
Return type:

bool

  • 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 entities : computation is not redone unless <forced> is given as True
Parameters:
  • G (Interface_Graph &) –
  • forced (bool) – default value is Standard_False
Return type:

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
Parameters:
  • ent (Handle_Standard_Transient &) –
  • G (Interface_Graph &) –
Return type:

char *

GetHandle()

IFSelect_SignCounter_GetHandle(IFSelect_SignCounter self) -> Handle_IFSelect_SignCounter

SelMode()
  • Returns the mode of working with the selection
Return type:int
Selection()
  • Returns the selection, or a null Handle
Return type:Handle_IFSelect_Selection
SetMap()
  • Changes the control status. The map is not cleared, simply its use changes
Parameters:withmap (bool) –
Return type: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
Parameters:selmode (Standard_Integer) –
Return type:None
SetSelection()
  • Sets a Selection as input : this causes content to be cleared then the Selection to be ready to compute (but not immediatly)
Parameters:sel (Handle_IFSelect_Selection &) –
Return type: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
Parameters:
  • ent (Handle_Standard_Transient &) –
  • model (Handle_Interface_InterfaceModel &) –
Return type:

Handle_TCollection_HAsciiString

Signature()
  • Returns the Signature used to count entities. It can be null.
Return type:Handle_IFSelect_Signature
thisown

The membership flag

class OCC.IFSelect.IFSelect_SignMultiple(*args)

Bases: OCC.IFSelect.IFSelect_Signature

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
Parameters:
  • subsign (Handle_IFSelect_Signature &) –
  • width (Standard_Integer) – default value is 0
  • maxi (bool) – default value is Standard_False
Return type:

None

  • 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
Parameters:
  • subsign (Handle_IFSelect_Signature &) –
  • width (Standard_Integer) – default value is 0
  • maxi (bool) – default value is Standard_False
Return type:

None

  • 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
Parameters:
  • subsign (Handle_IFSelect_Signature &) –
  • width (Standard_Integer) – default value is 0
  • maxi (bool) – default value is Standard_False
Return type:

None

GetHandle()
thisown

The membership flag

class OCC.IFSelect.IFSelect_SignType(*args)

Bases: OCC.IFSelect.IFSelect_Signature

GetHandle()
thisown

The membership flag

class OCC.IFSelect.IFSelect_SignValidity

Bases: OCC.IFSelect.IFSelect_Signature

static CVal(*args)
  • 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
Parameters:
  • ent (Handle_Standard_Transient &) –
  • model (Handle_Interface_InterfaceModel &) –
Return type:

char *

GetHandle()
thisown

The membership flag

OCC.IFSelect.IFSelect_SignValidity_CVal(*args)
  • 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
Parameters:
  • ent (Handle_Standard_Transient &) –
  • model (Handle_Interface_InterfaceModel &) –
Return type:

char *

class OCC.IFSelect.IFSelect_Signature(*args, **kwargs)

Bases: OCC.Interface.Interface_SignType

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
Parameters:acase (char *) –
Return type: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
Return type:Handle_TColStd_HSequenceOfAsciiString
GetHandle()
static IntValue(*args)
  • 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)
Parameters:val (Standard_Integer) –
Return type:char *
IsIntCase()
  • Tells if this Signature gives integer values and returns values from SetIntCase if True
Parameters:
  • hasmin (bool) –
  • valmin (Standard_Integer &) –
  • hasmax (bool) –
  • valmax (Standard_Integer &) –
Return type:

bool

Label()
  • The label of a Signature uses its name as follow : ‘Signature : <name>’
Return type:TCollection_AsciiString
static MatchValue(*args)
  • 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)
Parameters:
  • val (char *) –
  • text (TCollection_AsciiString &) –
  • exact (bool) –
Return type:

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
Parameters:
  • ent (Handle_Standard_Transient &) –
  • model (Handle_Interface_InterfaceModel &) –
  • text (TCollection_AsciiString &) –
  • exact (bool) –
Return type:

bool

Name()
  • Returns an identification of the Signature (a word), given at initialization time Returns the Signature for a Transient object. It is specific of each sub-class of Signature. For a Null Handle, it should provide ‘’ It can work with the model which contains the entity
Return type:char *
SetIntCase()
  • Sets the information data to tell ‘integer cases’ with possible min and max values To be called when creating
Parameters:
  • hasmin (bool) –
  • valmin (Standard_Integer) –
  • hasmax (bool) –
  • valmax (Standard_Integer) –
Return type:

None

thisown

The membership flag

class OCC.IFSelect.IFSelect_SignatureList(*args)

Bases: OCC.MMgt.MMgt_TShared

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
Parameters:
  • ent (Handle_Standard_Transient &) –
  • sign (char *) –
Return type:

None

Clear()
Return type:void
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
Parameters:sign (char *) –
Return type:Handle_TColStd_HSequenceOfTransient
GetHandle()

IFSelect_SignatureList_GetHandle(IFSelect_SignatureList self) -> Handle_IFSelect_SignatureList

GetModeSignOnly()

IFSelect_SignatureList_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
Return type:bool
Init()
  • Aknowledges the list in once. Name identifies the Signature
Parameters:
  • name (char *) –
  • count (Handle_Dico_DictionaryOfInteger &) –
  • list (Handle_Dico_DictionaryOfTransient &) –
  • nbnuls (Standard_Integer) –
Return type:

None

LastValue()
  • Returns the last value recorded by Add (only if SignMode set) Cleared by Clear or Init
Return type: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>
Parameters:root (char *) – default value is
Return type:Handle_TColStd_HSequenceOfHAsciiString
  • 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>
Parameters:root (char *) – default value is
Return type:Handle_TColStd_HSequenceOfHAsciiString
Name()
  • Returns the recorded Name. Remark : default is ‘...’ (no SetName called)
Return type:char *
NbNulls()
  • Returns the count of null entities
Return type:int
NbTimes()
  • Returns the number of times a signature was counted, 0 if it has not been recorded at all
Parameters:sign (char *) –
Return type:int
PrintCount()
  • Prints the counts of items (not the list)
Parameters:S (Handle_Message_Messenger &) –
Return type: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 : - CountByItem : just count (as PrintCount) - ShortByItem : minimum i.e. count plus 5 first entity numbers - ShortByItem(D) complete list of entity numbers (0: ‘Global’) - EntitiesByItem : list of (entity number/PrintLabel from the model) other modes are ignored
Parameters:
  • S (Handle_Message_Messenger &) –
  • model (Handle_Interface_InterfaceModel &) –
  • mod (IFSelect_PrintCount) – default value is IFSelect_ListByItem
Return type:

void

  • 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 : - CountByItem : just count (as PrintCount) - ShortByItem : minimum i.e. count plus 5 first entity numbers - ShortByItem(D) complete list of entity numbers (0: ‘Global’) - EntitiesByItem : list of (entity number/PrintLabel from the model) other modes are ignored
Parameters:
  • S (Handle_Message_Messenger &) –
  • model (Handle_Interface_InterfaceModel &) –
  • mod (IFSelect_PrintCount) – default value is IFSelect_ListByItem
Return type:

void

PrintSum()
  • Prints a summary Item which has the greatest count of entities For items which are numeric values : their count, maximum, minimum values, cumul, average
Parameters:S (Handle_Message_Messenger &) –
Return type:void
SetList()
  • Changes the record-list status. The list is not cleared but its use changes
Parameters:withlist (bool) –
Return type:None
SetModeSignOnly()

IFSelect_SignatureList_SetModeSignOnly(IFSelect_SignatureList self, Standard_Boolean value)

SetName()
  • Defines a name for a SignatureList (used to print it)
Parameters:name (char *) –
Return type:None
thisown

The membership flag

OCC.IFSelect.IFSelect_Signature_IntValue(*args)
  • 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)
Parameters:val (Standard_Integer) –
Return type:char *
OCC.IFSelect.IFSelect_Signature_MatchValue(*args)
  • 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)
Parameters:
  • val (char *) –
  • text (TCollection_AsciiString &) –
  • exact (bool) –
Return type:

bool

class OCC.IFSelect.IFSelect_TSeqOfDispatch

Bases: OCC.TCollection.TCollection_BaseSequence

Append()
Parameters:
  • T (Handle_IFSelect_Dispatch &) –
  • S (IFSelect_TSeqOfDispatch &) –
Return type:

None

Return type:

None

Assign()
Parameters:Other (IFSelect_TSeqOfDispatch &) –
Return type:IFSelect_TSeqOfDispatch
ChangeValue()
Parameters:Index (Standard_Integer) –
Return type:Handle_IFSelect_Dispatch
Clear()
Return type:None
First()
Return type:Handle_IFSelect_Dispatch
InsertAfter()
Parameters:
  • Index (Standard_Integer) –
  • T (Handle_IFSelect_Dispatch &) –
  • Index
  • S (IFSelect_TSeqOfDispatch &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • Index (Standard_Integer) –
  • T (Handle_IFSelect_Dispatch &) –
  • Index
  • S (IFSelect_TSeqOfDispatch &) –
Return type:

None

Return type:

None

Last()
Return type:Handle_IFSelect_Dispatch
Prepend()
Parameters:
  • T (Handle_IFSelect_Dispatch &) –
  • S (IFSelect_TSeqOfDispatch &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • Index (Standard_Integer) –
  • FromIndex (Standard_Integer) –
  • ToIndex (Standard_Integer) –
Return type:

None

Return type:

None

Set()
Parameters:Other (IFSelect_TSeqOfDispatch &) –
Return type:IFSelect_TSeqOfDispatch
SetValue()
Parameters:
  • Index (Standard_Integer) –
  • I (Handle_IFSelect_Dispatch &) –
Return type:

None

Split()
Parameters:
  • Index (Standard_Integer) –
  • Sub (IFSelect_TSeqOfDispatch &) –
Return type:

None

Value()
Parameters:Index (Standard_Integer) –
Return type:Handle_IFSelect_Dispatch
thisown

The membership flag

class OCC.IFSelect.IFSelect_TSeqOfSelection

Bases: OCC.TCollection.TCollection_BaseSequence

Append()
Parameters:
  • T (Handle_IFSelect_Selection &) –
  • S (IFSelect_TSeqOfSelection &) –
Return type:

None

Return type:

None

Assign()
Parameters:Other (IFSelect_TSeqOfSelection &) –
Return type:IFSelect_TSeqOfSelection
ChangeValue()
Parameters:Index (Standard_Integer) –
Return type:Handle_IFSelect_Selection
Clear()
Return type:None
First()
Return type:Handle_IFSelect_Selection
InsertAfter()
Parameters:
  • Index (Standard_Integer) –
  • T (Handle_IFSelect_Selection &) –
  • Index
  • S (IFSelect_TSeqOfSelection &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • Index (Standard_Integer) –
  • T (Handle_IFSelect_Selection &) –
  • Index
  • S (IFSelect_TSeqOfSelection &) –
Return type:

None

Return type:

None

Last()
Return type:Handle_IFSelect_Selection
Prepend()
Parameters:
  • T (Handle_IFSelect_Selection &) –
  • S (IFSelect_TSeqOfSelection &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • Index (Standard_Integer) –
  • FromIndex (Standard_Integer) –
  • ToIndex (Standard_Integer) –
Return type:

None

Return type:

None

Set()
Parameters:Other (IFSelect_TSeqOfSelection &) –
Return type:IFSelect_TSeqOfSelection
SetValue()
Parameters:
  • Index (Standard_Integer) –
  • I (Handle_IFSelect_Selection &) –
Return type:

None

Split()
Parameters:
  • Index (Standard_Integer) –
  • Sub (IFSelect_TSeqOfSelection &) –
Return type:

None

Value()
Parameters:Index (Standard_Integer) –
Return type:Handle_IFSelect_Selection
thisown

The membership flag

class OCC.IFSelect.IFSelect_TransformStandard

Bases: OCC.IFSelect.IFSelect_Transformer

AddModifier()
  • Adds a Modifier to the list : - <atnum> = 0 (default) : at the end of the list - <atnum> > 0 : at rank <atnum> Returns True if done, False if <atnum> is out of range
Parameters:
  • modif (Handle_IFSelect_Modifier &) –
  • atnum (Standard_Integer) – default value is 0
Return type:

bool

  • Adds a Modifier to the list : - <atnum> = 0 (default) : at the end of the list - <atnum> > 0 : at rank <atnum> Returns True if done, False if <atnum> is out of range
Parameters:
  • modif (Handle_IFSelect_Modifier &) –
  • atnum (Standard_Integer) – default value is 0
Return type:

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 stops : the following Modifiers are ignored
Parameters:
  • G (Interface_Graph &) –
  • protocol (Handle_Interface_Protocol &) –
  • TC (Interface_CopyTool &) –
  • checks (Interface_CheckIterator &) –
  • newmod (Handle_Interface_InterfaceModel &) –
Return type:

bool

Copy()
  • This the first operation. It calls StandardCopy or OnTheSpot according the option
Parameters:
  • G (Interface_Graph &) –
  • TC (Interface_CopyTool &) –
  • newmod (Handle_Interface_InterfaceModel &) –
Return type:

None

CopyOption()
  • Returns the Copy option
Return type:bool
GetHandle()

IFSelect_TransformStandard_GetHandle(IFSelect_TransformStandard self) -> Handle_IFSelect_TransformStandard

Modifier()
  • Returns a Modifier given its rank in the list
Parameters:num (Standard_Integer) –
Return type:Handle_IFSelect_Modifier
ModifierRank()
  • Returns the rank of a Modifier in the list, 0 if unknown
Parameters:modif (Handle_IFSelect_Modifier &) –
Return type:int
NbModifiers()
  • Returns the count of recorded Modifiers
Return type:int
OnTheSpot()
  • This is the OnTheSpot action : each entity is bound with ... itself. The produced model is the same as the starting one.
Parameters:
  • G (Interface_Graph &) –
  • TC (Interface_CopyTool &) –
  • newmod (Handle_Interface_InterfaceModel &) –
Return type:

None

RemoveModifier()
  • Removes a Modifier from the list Returns True if done, False if <modif> not in the list
Parameters:modif (Handle_IFSelect_Modifier &) –
Return type:bool
  • Removes a Modifier from the list, given its rank Returns True if done, False if <num> is out of range
Parameters:num (Standard_Integer) –
Return type:bool
Selection()
  • Returns the Selection, Null by default
Return type:Handle_IFSelect_Selection
SetCopyOption()
  • Sets the Copy option to a new value : - True for StandardCopy - False for OnTheSpot
Parameters:option (bool) –
Return type: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
Parameters:sel (Handle_IFSelect_Selection &) –
Return type:None
StandardCopy()
  • This is the standard action of Copy : its takes into account only the remaining entities (noted by Graph Status positive) and their proper dependances of course. Produces a new model.
Parameters:
  • G (Interface_Graph &) –
  • TC (Interface_CopyTool &) –
  • newmod (Handle_Interface_InterfaceModel &) –
Return type:

None

thisown

The membership flag

class OCC.IFSelect.IFSelect_Transformer(*args, **kwargs)

Bases: OCC.MMgt.MMgt_TShared

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.
Parameters:newproto (Handle_Interface_Protocol &) –
Return type:bool
GetHandle()

IFSelect_Transformer_GetHandle(IFSelect_Transformer self) -> Handle_IFSelect_Transformer

Label()
  • Returns a text which defines the way a Transformer works (to identify the transformation it performs)
Return type: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 occured : in this case, if a new data set has been produced, the transformation is ignored, else data may be corrupted.
Parameters:
  • G (Interface_Graph &) –
  • protocol (Handle_Interface_Protocol &) –
  • checks (Interface_CheckIterator &) –
  • newmod (Handle_Interface_InterfaceModel &) –
Return type:

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.
Parameters:
  • entfrom (Handle_Standard_Transient &) –
  • entto (Handle_Standard_Transient &) –
Return type:

bool

thisown

The membership flag

class OCC.IFSelect.IFSelect_WorkLibrary(*args, **kwargs)

Bases: OCC.Standard.Standard_Transient

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
Parameters:
  • original (Handle_Interface_InterfaceModel &) –
  • newmodel (Handle_Interface_InterfaceModel &) –
  • list (Interface_EntityIterator &) –
  • TC (Interface_CopyTool &) –
Return type:

bool

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)
Parameters:
  • model (Handle_Interface_InterfaceModel &) –
  • protocol (Handle_Interface_Protocol &) –
  • entity (Handle_Standard_Transient &) –
  • S (Handle_Message_Messenger &) –
  • level (Standard_Integer) –
Return type:

void

  • Calls deferred DumpEntity with the recorded default level
Parameters:
  • model (Handle_Interface_InterfaceModel &) –
  • protocol (Handle_Interface_Protocol &) –
  • entity (Handle_Standard_Transient &) –
  • S (Handle_Message_Messenger &) –
Return type:

None

DumpHelp()
  • Returns the help line recorded for <level>, or an empty string
Parameters:level (Standard_Integer) –
Return type:char *
DumpLevels()
  • Returns the recorded default and maximum dump levels If none was recorded, max is returned negative, def as zero
Parameters:
  • def (Standard_Integer &) –
  • max (Standard_Integer &) –
Return type:

None

GetHandle()

IFSelect_WorkLibrary_GetHandle(IFSelect_WorkLibrary self) -> Handle_IFSelect_WorkLibrary

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)
Parameters:
  • name (char *) –
  • model (Handle_Interface_InterfaceModel &) –
  • protocol (Handle_Interface_Protocol &) –
Return type:

int

SetDumpHelp()
  • Records a short line of help for a level (0 - max)
Parameters:
  • level (Standard_Integer) –
  • help (char *) –
Return type:

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>
Parameters:
  • def (Standard_Integer) –
  • max (Standard_Integer) –
Return type:

None

WriteFile()
  • Gives the way to Write a File from a Model. <ctx> contains all necessary informations : the 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 }
Parameters:ctx (IFSelect_ContextWrite &) –
Return type:bool
thisown

The membership flag

class OCC.IFSelect.IFSelect_WorkSession

Bases: OCC.MMgt.MMgt_TShared

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) Remark : the determined Ident is used if <item> is a Dispatch, to fill the ShareOut
Parameters:
  • item (Handle_Standard_Transient &) –
  • active (bool) – default value is Standard_True
Return type:

int

  • 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) Remark : the determined Ident is used if <item> is a Dispatch, to fill the ShareOut
Parameters:
  • item (Handle_Standard_Transient &) –
  • active (bool) – default value is Standard_True
Return type:

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)
Parameters:
  • name (char *) –
  • item (Handle_Standard_Transient &) –
  • active (bool) – default value is Standard_True
Return type:

int

  • 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)
Parameters:
  • name (char *) –
  • item (Handle_Standard_Transient &) –
  • active (bool) – default value is Standard_True
Return type:

int

AppliedDispatches()
  • Returns the ordered list of dispatches stored by the ShareOut
Return type: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
Parameters:record (bool) –
Return type:None
CategoryName()
  • Returns the Category Name determined for an entity it is computed by the class Category Remark : an unknown entity gives an empty string
Parameters:ent (Handle_Standard_Transient &) –
Return type: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
Parameters:ent (Handle_Standard_Transient &) –
Return type:int
ChangeModifierRank()
  • Changes the Rank of a Modifier in the Session : Model 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
Parameters:
  • formodel (bool) –
  • before (Standard_Integer) –
  • after (Standard_Integer) –
Return type:

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
Parameters:
  • ent (Handle_Standard_Transient &) –
  • complete (bool) – default value is Standard_True
Return type:

Interface_CheckIterator

  • 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
Parameters:
  • ent (Handle_Standard_Transient &) –
  • complete (bool) – default value is Standard_True
Return type:

Interface_CheckIterator

ClearData()
  • Clears recorded data (not the items) according mode : 1 : all Data : Model, Graph, CheckList, + ClearData 4 2 : Graph and CheckList (they will then be recomputed later) 3 : CheckList (it will be recomputed by ComputeCheck) 4 : just content of SelectPointed and Counters Plus 0 : does nothing but called by SetModel ClearData is virtual, hence it can be redefined to clear other data of a specialised Work Session
Parameters:mode (Standard_Integer) –
Return type:void
ClearFile()
  • Erases all stored data from the File Evaluation (i.e. ALL former naming informations are lost)
Return type:None
ClearFinalModifiers()
  • Removes all the Modifiers active in the ModelCopier : they become inactive and they are removed from the Session
Return type:None
ClearItems()
  • Clears all the recorded Items : Selections, Dispatches, Modifiers, and Strings & IntParams, with their Idents & Names. Remark that if a Model has been loaded, it is not cleared.
Return type: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
Parameters:onlydisp (bool) –
Return type: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)
Parameters:
  • selcomb (Handle_IFSelect_Selection &) –
  • seladd (Handle_IFSelect_Selection &) –
  • atnum (Standard_Integer) – default value is 0
Return type:

int

  • 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)
Parameters:
  • selcomb (Handle_IFSelect_Selection &) –
  • seladd (Handle_IFSelect_Selection &) –
  • atnum (Standard_Integer) – default value is 0
Return type:

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>
Parameters:
  • selcomb (Handle_IFSelect_Selection &) –
  • selrem (Handle_IFSelect_Selection &) –
Return type:

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. Remark : computation is enforced by every call to SetModel or RunTransformer
Parameters:enforce (bool) – default value is Standard_False
Return type:bool
  • 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. Remark : computation is enforced by every call to SetModel or RunTransformer
Parameters:enforce (bool) – default value is Standard_False
Return type: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
Parameters:
  • counter (Handle_IFSelect_SignCounter &) –
  • forced (bool) – default value is Standard_False
Return type:

bool

  • 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
Parameters:
  • counter (Handle_IFSelect_SignCounter &) –
  • forced (bool) – default value is Standard_False
Return type:

bool

ComputeCounterFromList()
  • Computes the content of a SignCounter from an input list If <list> is Null, uses internal definition of the Counter : a Selection, else the whole Model (recomputation forced) If <clear> is True (D), starts from scratch Else, cumulates computations
Parameters:
  • counter (Handle_IFSelect_SignCounter &) –
  • list (Handle_TColStd_HSequenceOfTransient &) –
  • clear (bool) – default value is Standard_True
Return type:

bool

  • Computes the content of a SignCounter from an input list If <list> is Null, uses internal definition of the Counter : a Selection, else the whole Model (recomputation forced) If <clear> is True (D), starts from scratch Else, cumulates computations
Parameters:
  • counter (Handle_IFSelect_SignCounter &) –
  • list (Handle_TColStd_HSequenceOfTransient &) –
  • clear (bool) – default value is Standard_True
Return type:

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).
Parameters:enforce (bool) – default value is Standard_False
Return type:bool
  • 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).
Parameters:enforce (bool) – default value is Standard_False
Return type:bool
DefaultFileRoot()
  • Returns the defined Default File Root. It is used for Dispatches which have no specific root attached. Null Handle if not defined
Return type: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)
Parameters:id (Standard_Integer) –
Return type: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
Parameters:disp (Handle_IFSelect_Dispatch &) –
Return type:int
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 norm : see specific classes of WorkLibrary for it. Generally, 0 if for very basic (only type ...), greater values give more and more details.
Parameters:
  • ent (Handle_Standard_Transient &) –
  • level (Standard_Integer) –
  • S (Handle_Message_Messenger &) –
Return type:

None

DumpModel()
  • Lists the content of the Input Model (if there is one) According level : 0 -> 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,7 : as 3 but resp. Count,List,Labels by Fail 8,9,10 : as 4 but resp. Count,List,Labels by message
Parameters:
  • level (Standard_Integer) –
  • S (Handle_Message_Messenger &) –
Return type:

None

DumpSelection()
  • Lists a Selection and its Sources (see SelectionIterator), given its rank in the list
Parameters:sel (Handle_IFSelect_Selection &) –
Return type:None
DumpShare()
  • Dumps contents of the ShareOut (on ‘cout’)
Return type: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
Parameters:ent (Handle_Standard_Transient &) –
Return type: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
Parameters:ent (Handle_Standard_Transient &) –
Return type: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
Parameters:sel (Handle_IFSelect_Selection &) –
Return type:Interface_EntityIterator
EvalSplit()
  • Returns an Evaluation of the whole ShareOut definition : i.e. how the entities of the starting model are forecast to be sent to various files : list 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 are : forgotten (sent into no file), duplicated (sent into more than one file), sent into a given file. See the class PacketList for more details.
Return type: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> = 1 : displays all entities for each packet, plus duplicated entities <mode> = 2 : same as <mode> = 1, plus displays forgotten entities (which are in no packet at all)
Parameters:mode (Standard_Integer) – default value is 0
Return type:None
  • Displays the effect of applying the ShareOut on the input Model. <mode> = 0 (default) : displays only roots for each packet, <mode> = 1 : displays all entities for each packet, plus duplicated entities <mode> = 2 : same as <mode> = 1, plus displays forgotten entities (which are in no packet at all)
Parameters:mode (Standard_Integer) – default value is 0
Return type: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> = 1 : displays also duplicated entities (because of this dispatch) <mode> = 2 : displays the entities of the starting Model which are not taken by this dispatch (forgotten entities) <mode> = 3 : displays both duplicated and forgotten entities Remark : EvaluateComplete displays these data evaluated for for all the dispatches, if there are several
Parameters:
  • disp (Handle_IFSelect_Dispatch &) –
  • mode (Standard_Integer) – default value is 0
Return type:

None

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

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
Return type:None
EvaluateSelection()
  • Displays the list of Entities selected by a Selection (i.e. the result of EvalSelection).
Parameters:sel (Handle_IFSelect_Selection &) –
Return type:None
FileExtension()
  • Returns the defined File Extension. Null Handle if not defined
Return type:Handle_TCollection_HAsciiString
FileModel()
  • Returns a Model, given its rank in the Evaluation List
Parameters:num (Standard_Integer) –
Return type:Handle_Interface_InterfaceModel
FileName()
  • Returns the name of a file corresponding to a produced Model, given its rank in the Evaluation List
Parameters:num (Standard_Integer) –
Return type:TCollection_AsciiString
FilePrefix()
  • Returns the defined File Prefix. Null Handle if not defined
Return type: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)
Parameters:disp (Handle_IFSelect_Dispatch &) –
Return type: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)
Parameters:formodel (bool) –
Return type: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)
Parameters:id (Standard_Integer) –
Return type:Handle_IFSelect_GeneralModifier
GetHandle()

IFSelect_WorkSession_GetHandle(IFSelect_WorkSession self) -> Handle_IFSelect_WorkSession

GetModeStat()
  • Return value of mode defining of filling selection during loading
Return type:bool
GiveFileComplete()
  • Completes a file name as required, with Prefix and Extension (if defined; for a non-defined item, completes nothing)
Parameters:file (char *) –
Return type:char *
GiveFileRoot()
  • Extracts File Root Name from a given complete file name (uses OSD_Path)
Parameters:file (char *) –
Return type:char *
GiveList()
  • Determines a list of entities from an object : <obj> already HSequenceOfTransient : returned itself <obj> Selection : its Result of Evaluation is returned <obj> an entity of the Model : a HSequence which contains it else, an empty HSequence <obj> the Model it self : ALL its content (not only the roots)
Parameters:obj (Handle_Standard_Transient &) –
Return type: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 ...)
Parameters:
  • first (char *) –
  • second (char *) – default value is
Return type:

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 ...)
Parameters:
  • first (char *) –
  • second (char *) – default value is
Return type:

Handle_TColStd_HSequenceOfTransient

GiveListCombined()
  • Combines two lists and returns the result, according to mode : <mode> < 0 : entities in <l1> AND NOT in <l2> <mode> = 0 : entities in <l1> AND in <l2> <mode> > 0 : entities in <l1> OR in <l2>
Parameters:
  • l1 (Handle_TColStd_HSequenceOfTransient &) –
  • l2 (Handle_TColStd_HSequenceOfTransient &) –
  • mode (Standard_Integer) –
Return type:

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 REMARK : selname is processed as <first second> of preceeding GiveList
Parameters:
  • selname (char *) –
  • ent (Handle_Standard_Transient &) –
Return type:

Handle_TColStd_HSequenceOfTransient

GiveSelection()
  • Returns a Selection from a Name : - the name of a Selection : this Selection - the name of a Signature + criteria between (..) : a new Selection from this Signature - an entity or a list of entities : a new SelectPointed Else, returns a Null Handle
Parameters:selname (char *) –
Return type:Handle_IFSelect_Selection
Graph()
  • Returns the Computed Graph, for Read only
Return type:Interface_Graph
HGraph()
  • Returns the Computed Graph as HGraph (Null Handle if not set)
Return type:Handle_Interface_HGraph
HasModel()
  • Returns True is a Model has been set
Return type:bool
HasName()
  • Returns True if an Item of the WorkSession has an attached Name
Parameters:item (Handle_Standard_Transient &) –
Return type: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)
Parameters:id (Standard_Integer) –
Return type:Handle_IFSelect_IntParam
IntValue()
  • Returns Integer Value of an IntParam
Parameters:it (Handle_IFSelect_IntParam &) –
Return type: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
Return type:bool
IsReversedSelectExtract()
  • Returns True if <sel> a Reversed SelectExtract, False else
Parameters:sel (Handle_IFSelect_Selection &) –
Return type:bool
Item()
  • Returns an Item, given its Ident. Returns a Null Handle if no Item corresponds to this Ident.
Parameters:id (Standard_Integer) –
Return type:Handle_Standard_Transient
ItemIdent()
  • Returns the Ident attached to an Item in the WorkSession, or Zero if it is unknown
Parameters:item (Handle_Standard_Transient &) –
Return type: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
Parameters:type (Handle_Standard_Type &) –
Return type: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
Parameters:id (Standard_Integer) –
Return type: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
Parameters:type (Handle_Standard_Type &) –
Return type: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
Parameters:label (char *) –
Return type: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
Parameters:item (Handle_Standard_Transient &) –
Return type:Handle_IFSelect_Selection
LastRunCheckList()
  • Returns the Check List produced by the last execution of either : EvaluateFile(for Split), SendSplit, SendAll, SendSelected, RunTransformer-RunModifier Cleared by SetModel or ClearData(1) The field is protected, hence a specialized WorkSession may fill it
Return type: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...)
Parameters:
  • iter (Interface_EntityIterator &) –
  • mode (Standard_Integer) –
Return type:

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
Parameters:formodel (bool) –
Return type:None
ListItems()
  • Lists the Labels of all Items of the WorkSession If <label> is defined, lists labels which contain it
Parameters:label (char *) – default value is
Return type:None
  • Lists the Labels of all Items of the WorkSession If <label> is defined, lists labels which contain it
Parameters:label (char *) – default value is
Return type:None
LoadedFile()
  • Returns the filename used to load current model empty if unknown
Return type: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
Return type: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.
Return type:int
Model()
  • Returns the Model of the Work Session (Null Handle if none) should be C++ : return const &
Return type:Handle_Interface_InterfaceModel
ModelCheckList()
  • Returns the Check List for the Model currently loaded : <complete> = True : complete (syntactic & semantic messages), computed if not yet done <complete> = False : only syntactic (check file form)
Parameters:complete (bool) – default value is Standard_True
Return type:Interface_CheckIterator
  • Returns the Check List for the Model currently loaded : <complete> = True : complete (syntactic & semantic messages), computed if not yet done <complete> = False : only syntactic (check file form)
Parameters:complete (bool) – default value is Standard_True
Return type:Interface_CheckIterator
ModelCopier()
  • Gives access to the complete ModelCopier
Return type: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)
Parameters:id (Standard_Integer) –
Return type: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 Rank : first Model Modifiers then File Modifiers Rank is given by rank of call to AddItem and can be changed by ChangeModifierRank
Parameters:item (Handle_IFSelect_GeneralModifier &) –
Return type: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.
Parameters:item (Handle_Standard_Transient &) –
Return type:Handle_TCollection_HAsciiString
NameIdent()
  • Returns the Ident attached to a Name, 0 if name not recorded
Parameters:name (char *) –
Return type: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
Parameters:name (char *) –
Return type:Handle_Standard_Transient
  • Same as above, but <name> is given through a Handle Especially Usefull with methods SelectionNames, etc...
Parameters:name (Handle_TCollection_HAsciiString &) –
Return type:Handle_Standard_Transient
NbFiles()
  • Returns the count of produced Models
Return type: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)
Parameters:formodel (bool) –
Return type: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
Parameters:sel (Handle_IFSelect_Selection &) –
Return type:int
NbStartingEntities()
  • Returns the count of Entities stored in the Model, or 0
Return type: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)
Parameters:name (char *) – default value is
Return type:Handle_IFSelect_IntParam
  • 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)
Parameters:name (char *) – default value is
Return type: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
Parameters:
  • statname (char *) –
  • name (char *) – default value is
Return type:

Handle_Standard_Transient

  • 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
Parameters:
  • statname (char *) –
  • name (char *) – default value is
Return type:

Handle_Standard_Transient

NewSelectPointed()
  • Creates a new Selection, of type SelectPointed, its content starts with <list>. A name must be given (can be empty)
Parameters:
  • list (Handle_TColStd_HSequenceOfTransient &) –
  • name (char *) –
Return type:

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)
Parameters:name (char *) – default value is
Return type:Handle_TCollection_HAsciiString
  • 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)
Parameters:name (char *) – default value is
Return type: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
Parameters:
  • copy (bool) –
  • name (char *) – default value is
Return type:

Handle_IFSelect_Transformer

  • 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
Parameters:
  • copy (bool) –
  • name (char *) – default value is
Return type:

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
Parameters:
  • label (char *) –
  • id (Standard_Integer) –
  • mode (Standard_Integer) – default value is 0
Return type:

int

  • 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
Parameters:
  • label (char *) –
  • id (Standard_Integer) –
  • mode (Standard_Integer) – default value is 0
Return type:

int

NumberFromLabel()
  • From a given label in Model, returns the corresponding number Starts from first entity by Default, may start after a given number : this number may be given negative, its absolute value is then considered. Hence a loop on NumberFromLabel may be programmed (stop test is : returned 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
Parameters:
  • val (char *) –
  • afternum (Standard_Integer) – default value is 0
Return type:

int

  • From a given label in Model, returns the corresponding number Starts from first entity by Default, may start after a given number : this number may be given negative, its absolute value is then considered. Hence a loop on NumberFromLabel may be programmed (stop test is : returned 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
Parameters:
  • val (char *) –
  • afternum (Standard_Integer) – default value is 0
Return type:

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 0 : sequential, according entities; else with a CheckCounter 1 : according messages, count of entities 2 : id but with list of entities, designated by their numbers 3 : as 2 but with labels of entities
Parameters:
  • checklist (Interface_CheckIterator &) –
  • failsonly (bool) –
  • mode (IFSelect_PrintCount) –
Return type:

None

PrintEntityStatus()
  • Prints main informations about an entity : its number, type, validity (and checks if any), category, shareds and sharings.. mutable because it can recompute checks as necessary
Parameters:
  • ent (Handle_Standard_Transient &) –
  • S (Handle_Message_Messenger &) –
Return type:

None

PrintSignatureList()
  • Prints a SignatureList to the current Trace File, controlled with the current Model <mode> defines the mode of printing (see SignatureList)
Parameters:
  • signlist (Handle_IFSelect_SignatureList &) –
  • mode (IFSelect_PrintCount) –
Return type:

None

Protocol()
  • Returns the Protocol. Null Handle if not yet set should be C++ : return const &
Return type:Handle_Interface_Protocol
QueryCheckList()
  • Loads data from a check iterator to query status on it
Parameters:chl (Interface_CheckIterator &) –
Return type:None
QueryCheckStatus()
  • Determines check status for an entity regarding last call to QueryCheckList : -1 : <ent> unknown in the model, ignored 0 : no check at all, immediate or inherited thru Graph 1 : immediate warning (no fail), no inherited check 2 : immediate fail, no inherited check +10 : idem but some inherited warning (no fail) +20 : idem but some inherited fail
Parameters:ent (Handle_Standard_Transient &) –
Return type: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
Parameters:
  • entdad (Handle_Standard_Transient &) –
  • entson (Handle_Standard_Transient &) –
Return type:

int

ReadFile()
  • Reads a file with the WorkLibrary (sets Model and LoadedFile) Returns a integer status which can be : RetDone if OK, RetVoid if no Protocol not defined, RetError for file not found, RetFail if fail during read
Parameters:filename (char *) –
Return type: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.
Parameters:item (Handle_Standard_Transient &) –
Return type:bool
RemoveName()
  • Removes a Name without removing the Item Returns True if Done, False else (Name not recorded)
Parameters: