OCC.Core.Transfer module

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

class SwigPyIterator(*args, **kwargs)

Bases: object

advance()

copy()

decr()

distance()

equal()

incr()

next()

previous()

property thisown

The membership flag

value()

class Transfer_ActorDispatch(*args)

Bases: OCC.Core.Transfer.Transfer_ActorOfTransientProcess

• Creates an ActorDispatch from a Model. Works with a General Service Library, given as an Argument This causes TransferDispatch and its TransientProcess to be created, with default actor <self>

  param amodel

  type amodel

  Interface_InterfaceModel

  param lib

  type lib

  Interface_GeneralLib

  rtype

  None* Same as above, but Library is defined through a Protocol

  param amodel

  type amodel

  Interface_InterfaceModel

  param protocol

  type protocol

  Interface_Protocol

  rtype

  None* Same as above, but works with the Active Protocol

  param amodel

  type amodel

  Interface_InterfaceModel

  rtype

  None

AddActor()

• Utility which adds an actor to the default <self> (it calls SetActor from the TransientProcess)

  param actor

  type actor

  Transfer_ActorOfTransientProcess

  rtype

  None

static DownCast(t)

TransferDispatch()

• Returns the TransferDispatch, which does the work, records the intermediate data, etc… See TransferDispatch & CopyTool, to see the available methods

  rtype

  Transfer_TransferDispatch

property thisown

The membership flag

class Transfer_ActorOfFinderProcess(*args)

Bases: OCC.Core.Transfer.Transfer_ActorOfProcessForFinder

Return type

None

static DownCast(t)

GetModeTrans(Transfer_ActorOfFinderProcess self) → Standard_Integer

SetModeTrans(Transfer_ActorOfFinderProcess self, Standard_Integer value)

Transfer()

Parameters

start –

type start

Transfer_Finder

param TP

type TP

Transfer_FinderProcess

rtype

opencascade::handle<Transfer_Binder>

TransferTransient()

Parameters

start –

type start

Standard_Transient

param TP

type TP

Transfer_FinderProcess

rtype

opencascade::handle<Standard_Transient>

property thisown

The membership flag

class Transfer_ActorOfProcessForFinder(*args)

Bases: OCC.Core.Standard.Standard_Transient

Return type

None

static DownCast(t)

IsLast()

• Returns the Last status (see SetLast).

  rtype

  bool

Next()

• Returns the Actor defined as Next, or a Null Handle

  rtype

  opencascade::handle<Transfer_ActorOfProcessForFinder>

NullResult()

• Returns a Binder for No Result, i.e. a Null Handle

  rtype

  opencascade::handle<Transfer_Binder>

Recognize()

• Prerequesite for Transferthe method Transfer is called on a starting object only if Recognize has returned True on it This allows to define a list of Actors, each one processing a definite kind of data TransferProcess calls Recognize on each one before calling Transfer. But even if Recognize has returned True, Transfer can reject by returning a Null Binder (afterwards rejection), the next actor is then invoked //! The provided default returns True, can be redefined

  param start

  type start

  Transfer_Finder

  rtype

  bool

SetLast()

• If <mode> is True, commands an Actor to be set at the end of the list of Actors (see SetNext) If it is False (creation default), each add Actor is set at the beginning of the list This allows to define default Actors (which are Last)

  param mode

  default value is Standard_True

  type mode

  bool

  rtype

  None

SetNext()

• Defines a Next Actorit can then be asked to work if <self> produces no result for a given type of Object. If Next is already set and is not ‘Last’, calls SetNext on it. If Next defined and ‘Last’, the new actor is added before it in the list

  param next

  type next

  Transfer_ActorOfProcessForFinder

  rtype

  None

Transferring()

• Specific action of Transfer. The Result is stored in the returned Binder, or a Null Handle for ‘No result’ (Default defined as doing nothing; should be deffered) ‘mutable’ allows the Actor to record intermediate information, in addition to those of TransferProcess

  param start

  type start

  Transfer_Finder

  param TP

  type TP

  Transfer_ProcessForFinder

  rtype

  opencascade::handle<Transfer_Binder>

TransientResult()

• Prepares and Returns a Binder for a Transient Result Returns a Null Handle if <res> is itself Null

  param res

  type res

  Standard_Transient

  rtype

  opencascade::handle<Transfer_SimpleBinderOfTransient>

property thisown

The membership flag

class Transfer_ActorOfProcessForTransient(*args)

Bases: OCC.Core.Standard.Standard_Transient

Return type

None

static DownCast(t)

IsLast()

• Returns the Last status (see SetLast).

  rtype

  bool

Next()

• Returns the Actor defined as Next, or a Null Handle

  rtype

  opencascade::handle<Transfer_ActorOfProcessForTransient>

NullResult()

• Returns a Binder for No Result, i.e. a Null Handle

  rtype

  opencascade::handle<Transfer_Binder>

Recognize()

• Prerequesite for Transferthe method Transfer is called on a starting object only if Recognize has returned True on it This allows to define a list of Actors, each one processing a definite kind of data TransferProcess calls Recognize on each one before calling Transfer. But even if Recognize has returned True, Transfer can reject by returning a Null Binder (afterwards rejection), the next actor is then invoked //! The provided default returns True, can be redefined

  param start

  type start

  Standard_Transient

  rtype

  bool

SetLast()

• If <mode> is True, commands an Actor to be set at the end of the list of Actors (see SetNext) If it is False (creation default), each add Actor is set at the beginning of the list This allows to define default Actors (which are Last)

  param mode

  default value is Standard_True

  type mode

  bool

  rtype

  None

SetNext()

• Defines a Next Actorit can then be asked to work if <self> produces no result for a given type of Object. If Next is already set and is not ‘Last’, calls SetNext on it. If Next defined and ‘Last’, the new actor is added before it in the list

  param next

  type next

  Transfer_ActorOfProcessForTransient

  rtype

  None

Transferring()

• Specific action of Transfer. The Result is stored in the returned Binder, or a Null Handle for ‘No result’ (Default defined as doing nothing; should be deffered) ‘mutable’ allows the Actor to record intermediate information, in addition to those of TransferProcess

  param start

  type start

  Standard_Transient

  param TP

  type TP

  Transfer_ProcessForTransient

  rtype

  opencascade::handle<Transfer_Binder>

TransientResult()

• Prepares and Returns a Binder for a Transient Result Returns a Null Handle if <res> is itself Null

  param res

  type res

  Standard_Transient

  rtype

  opencascade::handle<Transfer_SimpleBinderOfTransient>

property thisown

The membership flag

class Transfer_ActorOfTransientProcess(*args)

Bases: OCC.Core.Transfer.Transfer_ActorOfProcessForTransient

Return type

None

static DownCast(t)

Transfer()

Parameters

start –

type start

Standard_Transient

param TP

type TP

Transfer_TransientProcess

rtype

opencascade::handle<Transfer_Binder>

TransferTransient()

Parameters

start –

type start

Standard_Transient

param TP

type TP

Transfer_TransientProcess

rtype

opencascade::handle<Standard_Transient>

property thisown

The membership flag

class Transfer_Binder(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

AddFail()

• Used to declare an individual transfer as beeing erroneous (Status is set to Void, StatusExec is set to Error, <errmess> is added to Check’s list of Fails) It is possible to record several messages of error //! It has same effect for TransferProcess as raising an exception during the operation of Transfer, except the Transfer tries to continue (as if ErrorHandle had been set)

  param mess

  type mess

  char *

  param orig

  default value is

  type orig

  char *

  rtype

  None

AddResult()

• Adds a next result (at the end of the list) Remarkthis information is not processed by Merge

  param next

  type next

  Transfer_Binder

  rtype

  None

AddWarning()

• Used to attach a Warning Message to an individual Transfer It has no effect on the Status

  param mess

  type mess

  char *

  param orig

  default value is

  type orig

  char *

  rtype

  None

CCheck()

• Returns Check which stores Fail messages, in order to modify it (adding messages, or replacing it)

  rtype

  opencascade::handle<Interface_Check>

Check()

• Returns Check which stores Fail messages Note that no Entity is associated in this Check

  rtype

  opencascade::handle<Interface_Check>

static DownCast(t)

HasResult()

• Returns True if a Result is available (StatusResult = Defined) A Unique Result will be gotten by Result (which must be defined in each sub-class according to result type) For a Multiple Result, see class MultipleBinder For other case, specific access has to be forecast

  rtype

  bool

IsMultiple()

• Returns True if a Binder has several results, either by itself or because it has next results Can be defined by sub-classes.

  rtype

  bool

Merge()

• Merges basic data (Check, ExecStatus) from another Binder but keeps its result. Used when a binder is replaced by another one, this allows to keep messages

  param other

  type other

  Transfer_Binder

  rtype

  None

NextResult()

• Returns the next result, Null if none

  rtype

  opencascade::handle<Transfer_Binder>

ResultType()

• Returns the Type which characterizes the Result (if known)

  rtype

  opencascade::handle<Standard_Type>

ResultTypeName()

• Returns the Name of the Type which characterizes the Result Can be returned even if ResultType itself is unknown

  rtype

  char *

SetAlreadyUsed()

• Declares that result is now used by another one, it means that it cannot be modified (by Rebind)

  rtype

  None

SetStatusExec()

• Modifies execution status; called by TransferProcess only (for StatusError, rather use SetError, below)

  param stat

  type stat

  Transfer_StatusExec

  rtype

  None

Status()

• Returns status, which can be Initial (not yet done), Made (a result is recorded, not yet shared), Used (it is shared and cannot be modified)

  rtype

  Transfer_StatusResult

StatusExec()

• Returns execution status

  rtype

  Transfer_StatusExec

property thisown

The membership flag

class Transfer_BinderOfTransientInteger(*args)

Bases: OCC.Core.Transfer.Transfer_SimpleBinderOfTransient

• Creates an empty BinderOfTransientInteger; Default value for the integer part is zero

  rtype

  None

static DownCast(t)

Integer()

• Returns the value set for the integer part

  rtype

  int

SetInteger()

• Sets a value for the integer part

  param value

  type value

  int

  rtype

  None

property thisown

The membership flag

class Transfer_DataInfo

Bases: object

static Type()

• Returns the Type attached to an object Here, the Dynamic Type of a Transient. Null Type if unknown

  param ent

  type ent

  Standard_Transient

  rtype

  opencascade::handle<Standard_Type>

static TypeName()

• Returns Type Name (string) Allows to name type of non-handled objects

  param ent

  type ent

  Standard_Transient

  rtype

  char *

property thisown

The membership flag

class Transfer_DispatchControl(*args)

Bases: OCC.Core.Interface.Interface_CopyControl

• Creates the DispatchControl, ready for use

  param model

  type model

  Interface_InterfaceModel

  param TP

  type TP

  Transfer_TransientProcess

  rtype

  None

static DownCast(t)

StartingModel()

• Returns the Model from which the transfer is to be done

  rtype

  opencascade::handle<Interface_InterfaceModel>

TransientProcess()

• Returns the content of the DispatchControlit can be used for a direct call, if the basic methods do not suffice

  rtype

  opencascade::handle<Transfer_TransientProcess>

property thisown

The membership flag

class Transfer_FindHasher

Bases: object

static HashCode()

• Returns hash code for the given finder, in the range [1, theUpperBound]. Asks the finder its hash code, then transforms it to be in the required range @param theFinder the finder which hash code is to be computed @param theUpperBound the upper bound of the range a computing hash code must be within returns a computed hash code, in the range [1, theUpperBound]

  param theFinder

  type theFinder

  Transfer_Finder

  param theUpperBound

  type theUpperBound

  int

  rtype

  int

static IsEqual()

• Returns True if two keys are the same. The test does not work on the Finders themselves but by calling their methods Equates

  param K1

  type K1

  Transfer_Finder

  param K2

  type K2

  Transfer_Finder

  rtype

  bool

property thisown

The membership flag

class Transfer_Finder(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

AttrList()

• Returns the exhaustive list of attributes

  rtype

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

Attribute()

• Returns an attribute from its name. Null Handle if not recorded (whatever Transient, Integer, Real …)

  param name

  type name

  char *

  rtype

  opencascade::handle<Standard_Transient>

AttributeType()

• Returns the type of an attributeParamInt , ParamReal , ParamText (String) , ParamIdent (any) or ParamVoid (not recorded)

  param name

  type name

  char *

  rtype

  Interface_ParamType

static DownCast(t)

Equates()

• Specific testof equallityto be defined by each sub-class, must be False if Finders have not the same true Type, else their contents must be compared

  param other

  type other

  Transfer_Finder

  rtype

  bool

GetAttribute()

• Returns an attribute from its name, filtered by a type If no attribute has this name, or if it is not kind of this type, <val> is Null and returned value is False Else, it is True

  param name

  type name

  char *

  param type

  type type

  Standard_Type

  param val

  type val

  Standard_Transient

  rtype

  bool

GetAttributes()

• Gets the list of attributes from <other>, by copying it By default, considers all the attributes from <other> If <fromname> is given, considers only the attributes with name beginning by <fromname> //! For each attribute, if <copied> is True (D), its value is also copied if it is a basic type (Integer,Real,String), else it remains shared between <other> and <self> //! These new attributes are added to the existing ones in <self>, in case of same name, they replace the existing ones

  param other

  type other

  Transfer_Finder

  param fromname

  default value is

  type fromname

  char *

  param copied

  default value is Standard_True

  type copied

  bool

  rtype

  None

GetHashCode()

• Returns the HashCode which has been stored by SetHashCode (remark that HashCode could be deferred then be defined by sub-classes, the result is the same)

  rtype

  int

GetIntegerAttribute()

• Returns an attribute from its name, as integer If no attribute has this name, or not an integer, <val> is 0 and returned value is False Else, it is True

  param name

  type name

  char *

  param val

  type val

  int

  rtype

  bool

GetRealAttribute()

• Returns an attribute from its name, as real If no attribute has this name, or not a real <val> is 0.0 and returned value is False Else, it is True

  param name

  type name

  char *

  param val

  type val

  float

  rtype

  bool

GetStringAttribute()

• Returns an attribute from its name, as String If no attribute has this name, or not a String <val> is 0.0 and returned value is False Else, it is True

  param name

  type name

  char *

  param val

  type val

  char *

  rtype

  bool

IntegerAttribute()

• Returns an integer attribute from its name. 0 if not recorded

  param name

  type name

  char *

  rtype

  int

RealAttribute()

• Returns a real attribute from its name. 0.0 if not recorded

  param name

  type name

  char *

  rtype

  float

RemoveAttribute()

• Removes an attribute Returns True when done, False if this attribute did not exist

  param name

  type name

  char *

  rtype

  bool

SameAttributes()

• Gets the list of attributes from <other>, as such, i.e. not copiedattributes are shared, any attribute edited, added, or removed in <other> is also in <self> and vice versa The former list of attributes of <self> is dropped

  param other

  type other

  Transfer_Finder

  rtype

  None

SetAttribute()

• Adds an attribute with a given name (replaces the former one with the same name if already exists)

  param name

  type name

  char *

  param val

  type val

  Standard_Transient

  rtype

  None

SetIntegerAttribute()

• Adds an integer value for an attribute

  param name

  type name

  char *

  param val

  type val

  int

  rtype

  None

SetRealAttribute()

• Adds a real value for an attribute

  param name

  type name

  char *

  param val

  type val

  float

  rtype

  None

SetStringAttribute()

• Adds a String value for an attribute

  param name

  type name

  char *

  param val

  type val

  char *

  rtype

  None

StringAttribute()

• Returns a String attribute from its name. ‘’ if not recorded

  param name

  type name

  char *

  rtype

  char *

ValueType()

• Returns the Type of the Value. By default, returns the DynamicType of <self>, but can be redefined

  rtype

  opencascade::handle<Standard_Type>

ValueTypeName()

• Returns the name of the Type of the Value. Default is name of ValueType, unless it is for a non-handled object

  rtype

  char *

property thisown

The membership flag

class Transfer_FinderProcess(*args)

Bases: object

• Sets FinderProcess at initial state, with an initial size

  param nb

  default value is 10000

  type nb

  int

  rtype

  None

static DownCast(t)

Model()

• Returns the Model which can be used for context

  rtype

  opencascade::handle<Interface_InterfaceModel>

NextMappedWithAttribute()

• In the list of mapped items (between 1 and NbMapped), searches for the first mapped item which follows <num0> (not included) and which has an attribute named <name> The considered Attributes are those brought by Finders,i.e. by Input data. While NextItemWithAttribute works on Result data (Binders) //! Hence, allows such an iteration //! for (num = FP->NextMappedWithAttribute(name,0); num > 0; num = FP->NextMappedWithAttribute(name,num) { .. process mapped item <num> }

  param name

  type name

  char *

  param num0

  type num0

  int

  rtype

  int

PrintStats()

• Prints statistics on a given output, according mode

  param mode

  type mode

  int

  param S

  type S

  Message_Messenger

  rtype

  None

PrintTrace()

• Specific printing to trace a Finder (by its method ValueType)

  param start

  type start

  Transfer_Finder

  param S

  type S

  Message_Messenger

  rtype

  void

SetModel()

• Sets an InterfaceModel, which can be used during transfer for instance if a context must be managed, it is in the Model

  param model

  type model

  Interface_InterfaceModel

  rtype

  None

TransientMapper()

• Returns a TransientMapper for a given Transient Object Either <obj> is already mapped, then its Mapper is returned Or it is not, then a new one is created then returned, BUT it is not mapped here (use Bind or FindElseBind to do this)

  param obj

  type obj

  Standard_Transient

  rtype

  opencascade::handle<Transfer_TransientMapper>

property thisown

The membership flag

class Transfer_HSequenceOfBinder(*args)

Bases: OCC.Core.Transfer.Transfer_SequenceOfBinder, OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Append()

ChangeSequence()

static DownCast(t)

Sequence()

property thisown

The membership flag

class Transfer_HSequenceOfFinder(*args)

Bases: OCC.Core.Transfer.Transfer_SequenceOfFinder, OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Append()

ChangeSequence()

static DownCast(t)

Sequence()

property thisown

The membership flag

class Transfer_IteratorOfProcessForFinder(*args)

Bases: OCC.Core.Transfer.Transfer_TransferIterator

• Creates an empty Iterator if withstarts is True, each Binder to be iterated will be associated to its corresponding Starting Object

  param withstarts

  type withstarts

  bool

  rtype

  None

Add()

• Adds a Binder to the iteration list (construction) with no corresponding Starting Object (note that Result is brought by Binder)

  param binder

  type binder

  Transfer_Binder

  rtype

  None* Adds a Binder to the iteration list, associated with its corresponding Starting Object ‘start’ Starting Object is ignored if not required at Creation time

  param binder

  type binder

  Transfer_Binder

  param start

  type start

  Transfer_Finder

  rtype

  None

Filter()

• After having added all items, keeps or rejects items which are attached to starting data given by <only> <keep> = True (D)keeps. <keep> = Falserejects Does nothing if <withstarts> was False

  param list

  type list

  Transfer_HSequenceOfFinder

  param keep

  default value is Standard_True

  type keep

  bool

  rtype

  None

HasStarting()

• Returns True if Starting Object is available (defined at Creation Time)

  rtype

  bool

Starting()

• Returns corresponding Starting Object

  rtype

  opencascade::handle<Transfer_Finder>

property thisown

The membership flag

class Transfer_IteratorOfProcessForTransient(*args)

Bases: OCC.Core.Transfer.Transfer_TransferIterator

• Creates an empty Iterator if withstarts is True, each Binder to be iterated will be associated to its corresponding Starting Object

  param withstarts

  type withstarts

  bool

  rtype

  None

Add()

• Adds a Binder to the iteration list (construction) with no corresponding Starting Object (note that Result is brought by Binder)

  param binder

  type binder

  Transfer_Binder

  rtype

  None* Adds a Binder to the iteration list, associated with its corresponding Starting Object ‘start’ Starting Object is ignored if not required at Creation time

  param binder

  type binder

  Transfer_Binder

  param start

  type start

  Standard_Transient

  rtype

  None

Filter()

• After having added all items, keeps or rejects items which are attached to starting data given by <only> <keep> = True (D)keeps. <keep> = Falserejects Does nothing if <withstarts> was False

  param list

  type list

  TColStd_HSequenceOfTransient

  param keep

  default value is Standard_True

  type keep

  bool

  rtype

  None

HasStarting()

• Returns True if Starting Object is available (defined at Creation Time)

  rtype

  bool

Starting()

• Returns corresponding Starting Object

  rtype

  opencascade::handle<Standard_Transient>

property thisown

The membership flag

class Transfer_MapContainer(*args)

Bases: OCC.Core.Standard.Standard_Transient

Return type

None

static DownCast(t)

GetMapObjects()

• Get map already translated geometry objects.

  rtype

  TColStd_DataMapOfTransientTransient

SetMapObjects()

• Set map already translated geometry objects.

  param theMapObjects

  type theMapObjects

  TColStd_DataMapOfTransientTransient

  rtype

  None

property thisown

The membership flag

class Transfer_MultipleBinder(*args)

Bases: OCC.Core.Transfer.Transfer_Binder

• normal standard constructor, creates an empty MultipleBinder

  rtype

  None

AddResult()

• Adds a new Item to the Multiple Result

  param res

  type res

  Standard_Transient

  rtype

  None

static DownCast(t)

MultipleResult()

• Returns the Multiple Result, if it is defined (at least one Item). Else, returns a Null Handle

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

NbResults()

• Returns the actual count of recorded (Transient) results

  rtype

  int

ResultValue()

• Returns the value of the recorded result n0 <num>

  param num

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

SetMultipleResult()

• Defines a Binding with a Multiple Result, given as a Sequence Error if a Unique Result has yet been defined

  param mulres

  type mulres

  TColStd_HSequenceOfTransient

  rtype

  None

property thisown

The membership flag

class Transfer_ProcessForTransient(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Sets TransferProcess at initial state. Gives an Initial size (indicative) for the Map when known (default is 10000). Sets default trace file as a printer and default trace level (see Message_TraceFile).

  param nb

  default value is 10000

  type nb

  int

  rtype

  None* Sets TransferProcess at initial state. Gives an Initial size (indicative) for the Map when known (default is 10000). Sets a specified printer.

  param printer

  type printer

  Message_Messenger

  param nb

  default value is 10000

  type nb

  int

  rtype

  None

AbnormalResult()

• Returns Binders which are neither ‘Done’ nor ‘Initial’, that is Error,Loop or Run (abnormal states at end of Transfer) Starting Objects are given in correspondance in the iterator

  rtype

  Transfer_IteratorOfProcessForTransient

Actor()

• Returns the defined Actor. Returns a Null Handle if not set.

  rtype

  opencascade::handle<Transfer_ActorOfProcessForTransient>

AddError()

• (other name of AddFail, maintained for compatibility)

  param start

  type start

  Standard_Transient

  param mess

  type mess

  char *

  param orig

  default value is

  type orig

  char *

  rtype

  None

AddFail()

• Adds an Error message to a starting entity (to the check of its Binder of category 0, as a Fail)

  param start

  type start

  Standard_Transient

  param mess

  type mess

  char *

  param orig

  default value is

  type orig

  char *

  rtype

  None* Adds an Error Message to a starting entity from the definition of a Msg (Original+Value)

  param start

  type start

  Standard_Transient

  param amsg

  type amsg

  Message_Msg

  rtype

  None

AddMultiple()

• Adds an item to a list of results bound to a starting object. Considers a category number, by default 0, for all results

  param start

  type start

  Standard_Transient

  param res

  type res

  Standard_Transient

  rtype

  None

AddWarning()

• Adds a Warning message to a starting entity (to the check of its Binder of category 0)

  param start

  type start

  Standard_Transient

  param mess

  type mess

  char *

  param orig

  default value is

  type orig

  char *

  rtype

  None* Adds a Warning Message to a starting entity from the definition of a Msg (Original+Value)

  param start

  type start

  Standard_Transient

  param amsg

  type amsg

  Message_Msg

  rtype

  None

Bind()

• Creates a Link a starting Object with a Binder. This Binder can either bring a Result (effective Binding) or none (it can be set laterpre-binding). Considers a category number, by default 0

  param start

  type start

  Standard_Transient

  param binder

  type binder

  Transfer_Binder

  rtype

  None

BindMultiple()

• Prepares an object <start> to be bound with several results. If no Binder is yet attached to <obj>, a MultipleBinder is created, empty. If a Binder is already set, it must accept Multiple Binding. Considers a category number, by default 0

  param start

  type start

  Standard_Transient

  rtype

  None

BindTransient()

• Binds a starting object with a Transient Result. Uses a SimpleBinderOfTransient to work. If there is already one but with no Result set, sets its Result. Considers a category number, by default 0

  param start

  type start

  Standard_Transient

  param res

  type res

  Standard_Transient

  rtype

  None

Check()

• Returns the Check attached to a starting entity. If <start> is unknown, returns an empty Check Adds a case name to a starting entity Adds a case value to a starting entity Returns the complete case list for an entity. Null Handle if empty In the list of mapped items (between 1 and NbMapped), searches for the first item which follows <num0>(not included) and which has an attribute named <name> Attributes are brought by Binders Hence, allows such an iteration //! for (num = TP->NextItemWithAttribute(name,0); num > 0; num = TP->NextItemWithAttribute(name,num) { .. process mapped item <num> } Returns the type of an Attribute attached to binders If this name gives no Attribute, returns ParamVoid If this name gives several different types, returns ParamMisc Else, returns the effective type (ParamInteger, ParamReal, ParamIdent, or ParamText) Returns the list of recorded Attribute Names, as a Dictionary of Integereach value gives the count of items which bring this attribute name By default, considers all the attribute names If <rootname> is given, considers only the attribute names which begin by <rootname>

  param start

  type start

  Standard_Transient

  rtype

  opencascade::handle<Interface_Check>

CheckList()

• Returns a CheckList as a list of Checkeach one is for a starting entity which have either check (warning or fail) messages are attached, or are in abnormal statethat case gives a specific message If <erronly> is True, checks with Warnings only are ignored

  param erronly

  type erronly

  bool

  rtype

  Interface_CheckIterator

CheckListOne()

• Returns a CheckList for one starting object <level> interpreted as by ResultOne If <erronly> is True, checks with Warnings only are ignored

  param start

  type start

  Standard_Transient

  param level

  type level

  int

  param erronly

  type erronly

  bool

  rtype

  Interface_CheckIterator

CheckNum()

• Computes a number to be associated to a starting object in a check or a check-list By default, returns 0; can be redefined

  param start

  type start

  Standard_Transient

  rtype

  int

Clean()

• Rebuilds the Map and the roots to really remove Unbound items Because Unbind keeps the entity in place, even if not bound Hence, working by checking new items is meaningless if a formerly unbound item is rebound

  rtype

  None

Clear()

• Resets a TransferProcess as ready for a completely new work. Clears general data (roots) and the Map

  rtype

  None

CompleteResult()

• Returns, as an Iterator, the entire log of transfer (list of created objects and Binders which can bring errors) If withstart is given True, Starting Objets are also returned

  param withstart

  default value is Standard_False

  type withstart

  bool

  rtype

  Transfer_IteratorOfProcessForTransient

static DownCast(t)

Find()

• Returns the Binder which is linked with a starting Object It can either bring a Result (Transfer done) or none (for a pre-binding). If no Binder is linked with <start>, returns a Null Handle Considers a category number, by default 0

  param start

  type start

  Standard_Transient

  rtype

  opencascade::handle<Transfer_Binder>

FindElseBind()

• Returns a Binder for a starting entity, as followsTries to Find the already bound one If none found, creates a VoidBinder and Binds it

  param start

  type start

  Standard_Transient

  rtype

  opencascade::handle<Transfer_Binder>

FindTransient()

• Returns the Result of the Transfer of an object <start> as a Transient Result. Returns a Null Handle if there is no Transient Result Considers a category number, by default 0 WarningSupposes that Binding is done with a SimpleBinderOfTransient

  param start

  type start

  Standard_Transient

  rtype

  opencascade::handle<Standard_Transient>

FindTypedTransient()

• Searches for a transient result attached to a starting object, according to its type, by criterium IsKind(atype) //! In case of multiple result, explores the list and gives in <val> the first transient result IsKind(atype) Returns True and fills <val> if found Else, returns False (<val> is not touched, not even nullified) //! This syntactic form avoids to do DownCastif a result is found with the good type, it is loaded in <val> and can be immediately used, well initialised

  param start

  type start

  Standard_Transient

  param atype

  type atype

  Standard_Type

  param val

  type val

  Standard_Transient

  rtype

  bool

GetProgress()

• Gets Progress indicator

  rtype

  opencascade::handle<Message_ProgressIndicator>

GetTypedTransient()

• Searches for a transient result recorded in a Binder, whatever this Binder is recorded or not in <self> //! This is strictly equivalent to the class method GetTypedResult from class SimpleBinderOfTransient, but is just lighter to call //! Apart from this, works as FindTypedTransient

  param binder

  type binder

  Transfer_Binder

  param atype

  type atype

  Standard_Type

  param val

  type val

  Standard_Transient

  rtype

  bool

IsAlreadyUsed()

• Returns True if the result of the transfer of an object is already used in other ones. If it is, Rebind cannot change it. Considers a category number, by default 0

  param start

  type start

  Standard_Transient

  rtype

  bool

IsBound()

• Returns True if a Result (whatever its form) is Bound with a starting Object. I.e., if a Binder with a Result set, is linked with it Considers a category number, by default 0

  param start

  type start

  Standard_Transient

  rtype

  bool

IsCheckListEmpty()

• Returns True if no check message is attached to a starting object. <level> interpreted as by ResultOne If <erronly> is True, checks with Warnings only are ignored

  param start

  type start

  Standard_Transient

  param level

  type level

  int

  param erronly

  type erronly

  bool

  rtype

  bool

IsLooping()

• Returns True if we are surely in a DeadLoop. Evaluation is not exact, it is a ‘majorant’ which must be computed fast. This ‘majorant’ is<alevel> greater than NbMapped.

  param alevel

  type alevel

  int

  rtype

  bool

MapIndex()

• Returns the Index value bound to a Starting Object, 0 if none

  param start

  type start

  Standard_Transient

  rtype

  int

MapItem()

• Returns the Binder bound to an Index Considers a category number, by default 0

  param num

  type num

  int

  rtype

  opencascade::handle<Transfer_Binder>

Mapped()

• Returns the Starting Object bound to an Index,

  param num

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

Mend()

Parameters

start –

type start

Standard_Transient

param pref

default value is

type pref

char *

rtype

None

Messenger()

• Returns Messenger used for outputting messages. The returned object is guaranteed to be non-null; default is Message::Messenger().

  rtype

  opencascade::handle<Message_Messenger>

NbMapped()

• Returns the maximum possible value for Map Index (no result can be bound with a value greater than it)

  rtype

  int

NbRoots()

• Returns the count of recorded Roots

  rtype

  int

NestingLevel()

• Returns Nesting Level of Transfers (managed by methods TranscriptWith & Co). Starts to zero. If no automatic Transfer is used, it remains to zero. Zero means Root Level.

  rtype

  int

PrintTrace()

• Prints a short information on a starting object. By default prints its Dynamic Type. Can be redefined

  param start

  type start

  Standard_Transient

  param S

  type S

  Message_Messenger

  rtype

  void

Rebind()

• Changes the Binder linked with a starting Object for its unitary transfer. This it can be useful when the exact form of the result is known once the transfer is widely engaged. This can be done only on first transfer. Considers a category number, by default 0

  param start

  type start

  Standard_Transient

  param binder

  type binder

  Transfer_Binder

  rtype

  None

Recognize()

• Tells if <start> has been recognized as good candidate for Transfer. i.e. queries the Actor and its Nexts

  param start

  type start

  Standard_Transient

  rtype

  bool

RemoveResult()

• Removes Results attached to (== Unbinds) a given object and, according <level><level> = 0only it <level> = 1it plus its immediately owned sub-results(scope) <level> = 2it plus all its owned sub-results(scope)

  param start

  type start

  Standard_Transient

  param level

  type level

  int

  param compute

  default value is Standard_True

  type compute

  bool

  rtype

  None

ResetNestingLevel()

• Resets Nesting Level of Transfers to Zero (Root Level), whatever its current value.

  rtype

  None

Resize()

• Resizes the Map as required (if a new reliable value has been determined). Acts only if <nb> is greater than actual NbMapped

  param nb

  type nb

  int

  rtype

  None

ResultOne()

• Returns, as an Iterator, the log of transfer for one object <level> = 0this object only and if <start> is a scope owner (else, <level> is ignored)<level> = 1object plus its immediate scoped ones <level> = 2object plus all its scoped ones

  param start

  type start

  Standard_Transient

  param level

  type level

  int

  param withstart

  default value is Standard_False

  type withstart

  bool

  rtype

  Transfer_IteratorOfProcessForTransient

Root()

• Returns a Root Entity given its number in the list (1-NbRoots)

  param num

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

RootIndex()

• Returns the index in the list of roots for a starting item, or 0 if it is not recorded as a root

  param start

  type start

  Standard_Transient

  rtype

  int

RootItem()

• Returns the Binder bound with a Root Entity given its number Considers a category number, by default 0

  param num

  type num

  int

  rtype

  opencascade::handle<Transfer_Binder>

RootResult()

• Returns, as an iterator, the log of root transfer, i.e. the created objects and Binders bound to starting roots If withstart is given True, Starting Objets are also returned

  param withstart

  default value is Standard_False

  type withstart

  bool

  rtype

  Transfer_IteratorOfProcessForTransient

SendFail()

• New name for AddFail (Msg)

  param start

  type start

  Standard_Transient

  param amsg

  type amsg

  Message_Msg

  rtype

  None

SendMsg()

• Adds an information message Trace is filled if trace level is at least 3

  param start

  type start

  Standard_Transient

  param amsg

  type amsg

  Message_Msg

  rtype

  None

SendWarning()

• New name for AddWarning (Msg)

  param start

  type start

  Standard_Transient

  param amsg

  type amsg

  Message_Msg

  rtype

  None

SetActor()

• Defines an Actor, which is used for automatic Transfer If already defined, the new Actor is cumulated (see SetNext from Actor)

  param actor

  type actor

  Transfer_ActorOfProcessForTransient

  rtype

  None

SetMessenger()

• Sets Messenger used for outputting messages.

  param messenger

  type messenger

  Message_Messenger

  rtype

  None

SetProgress()

• Sets Progress indicator

  param theProgress

  type theProgress

  Message_ProgressIndicator

  rtype

  None

SetRoot()

• Declares <obj> (and its Result) as Root. This status will be later exploited by RootResult, see below (Result can be produced at any time)

  param start

  type start

  Standard_Transient

  rtype

  None

SetRootManagement()

• Enable (if <stat> True) or Disables (if <stat> False) Root Management. If it is set, Transfers are considered as stacked (a first Transfer commands other Transfers, and so on) and the Transfers commanded by an external caller are ‘Root’. RemarkSetRoot can be called whatever this status, on every object. Default is set to True.

  param stat

  type stat

  bool

  rtype

  None

SetTraceLevel()

• Sets trace level used for outputting messages: <trace> = 0no trace at all <trace> = 1handled exceptions and calls to AddError <trace> = 2also calls to AddWarning <trace> = 3also traces new Roots (uses method ErrorTrace). Default is 1Errors traced

  param tracelev

  type tracelev

  int

  rtype

  None

StartTrace()

• Method called when trace is asked Calls PrintTrace to display information relevant for starting objects (which can be redefined) <level> is Nesting Level of Transfer (0 = root) <mode> controls the way the trace is done0 neutral, 1 for Error, 2 for Warning message, 3 for new Root

  param binder

  type binder

  Transfer_Binder

  param start

  type start

  Standard_Transient

  param level

  type level

  int

  param mode

  type mode

  int

  rtype

  None

TraceLevel()

• Returns trace level used for outputting messages.

  rtype

  int

Transfer()

• Same as Transferring but does not return the Binder. Simply returns True in case of success (for user call)

  param start

  type start

  Standard_Transient

  rtype

  bool

Transferring()

• Performs the Transfer of a Starting Object, by calling the method TransferProduct (see below). Mapping and Roots are managednothing is done if a Result is already Bound, an exception is raised in case of error.

  param start

  type start

  Standard_Transient

  rtype

  opencascade::handle<Transfer_Binder>

Unbind()

• Removes the Binder linked with a starting object If this Binder brings a non-empty Check, it is replaced by a VoidBinder. Also removes from the list of Roots as required. Returns True if done, False if <start> was not bound Considers a category number, by default 0

  param start

  type start

  Standard_Transient

  rtype

  bool

property thisown

The membership flag

class Transfer_ResultFromModel(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates a ResultFromModel, empty

  rtype

  None

CheckList()

• Returns the check-list of this set of results <erronly> trueonly fails are considered <level> = 0considers only main binder <level> = 1considers main binder plus immediate subs <level> = 2 (D)considers all checks

  param erronly

  type erronly

  bool

  param level

  default value is 2

  type level

  int

  rtype

  Interface_CheckIterator

CheckStatus()

• Returns the check status with corresponds to the content of this ResultFromModel; considers all levels of transfer (worst status). Returns CheckAny if not yet computed Reads it from recorded status if already computed, else recomputes one

  rtype

  Interface_CheckStatus

CheckedList()

• Returns the list of starting entities to which a check status is attached. <check> = -2 , all entities whatever the check (see result) <check> = -1 , entities with no fail (warning allowed) <check> = 0 , entities with no check at all <check> = 1 , entities with warning but no fail <check> = 2 , entities with fail <result>if True, only entities with an attached result Remarkresult True and check=0 will give an empty list

  param check

  type check

  Interface_CheckStatus

  param result

  type result

  bool

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

ComputeCheckStatus()

• Computes and records check status (see CheckStatus) Does not computes it if already done and <enforce> False

  param enforce

  type enforce

  bool

  rtype

  Interface_CheckStatus

static DownCast(t)

FileName()

• Returns starting File Name (empty if not set)

  rtype

  char *

Fill()

• Fills from a TransientProcess, with the result attached to a starting entity. Considers its Model if it is set. This action produces a structured set of ResultFromTransient, considering scopes, starting by that of <ent>. If <ent> has no recorded result, it remains empty Returns True if a result is recorded, False else

  param TP

  type TP

  Transfer_TransientProcess

  param ent

  type ent

  Standard_Transient

  rtype

  bool

FillBack()

• Fills back a TransientProcess from the structured set of binders. Also sets the Model.

  param TP

  type TP

  Transfer_TransientProcess

  rtype

  None

HasResult()

• Returns True if a Result is recorded

  rtype

  bool

MainLabel()

• Returns the label in starting model attached to main entity (updated by Fill or SetMainResult, if Model is known)

  rtype

  char *

MainNumber()

• Returns the label in starting model attached to main entity

  rtype

  int

MainResult()

• Returns the main recorded ResultFromTransient, or a null

  rtype

  opencascade::handle<Transfer_ResultFromTransient>

Model()

• Returns starting Model (null if not set)

  rtype

  opencascade::handle<Interface_InterfaceModel>

ResultFromKey()

• Searches for a key (starting entity) and returns its result Returns a null handle if not found

  param start

  type start

  Standard_Transient

  rtype

  opencascade::handle<Transfer_ResultFromTransient>

Results()

• Internal method which returns the list of ResultFromTransient, according level (2:complete; 1:sub-level 1; 0:main only)

  param level

  type level

  int

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

SetFileName()

• Sets starting File Name

  param filename

  type filename

  char *

  rtype

  None

SetMainResult()

• Sets a new value for the main recorded ResultFromTransient

  param amain

  type amain

  Transfer_ResultFromTransient

  rtype

  None

SetModel()

• Sets starting Model

  param model

  type model

  Interface_InterfaceModel

  rtype

  None

Strip()

• Clears some data attached to binders used by TransientProcess, which become useless once the transfer has been done, by calling Strip on its ResultFromTransient //! mode = 0minimum, clears data remaining from TransferProcess mode = 10just keeps file name, label, check status …, and MainResult but only the result (Binder) mode = 11also clears MainResult (status and names remain)

  param mode

  type mode

  int

  rtype

  None

TransferredList()

• Returns the list of recorded starting entities, ending by the root. Entities with check but no transfer result are ignored <level> = 2 (D), considers the complete list <level> = 1 considers the main result plus immediate subs <level> = 0 just the main result

  param level

  default value is 2

  type level

  int

  rtype

  opencascade::handle<TColStd_HSequenceOfTransient>

property thisown

The membership flag

class Transfer_ResultFromTransient(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates a ResultFromTransient, empty

  rtype

  None

AddSubResult()

• Adds a sub-result

  param sub

  type sub

  Transfer_ResultFromTransient

  rtype

  None

Binder()

• Returns the binder

  rtype

  opencascade::handle<Transfer_Binder>

Check()

• Returns the check (or an empty one if no binder)

  rtype

  opencascade::handle<Interface_Check>

CheckStatus()

• Returns the check status

  rtype

  Interface_CheckStatus

ClearSubs()

• Clears the list of (immediate) sub-results

  rtype

  None

static DownCast(t)

Fill()

• Fills from a TransientProcess, with the starting entity which must have been set before. It works with scopes, calls Fill on each of its sub-results

  param TP

  type TP

  Transfer_TransientProcess

  rtype

  None

FillBack()

• Fills back a TransientProcess with definition of a ResultFromTransient, respectfully to its structuration in scopes

  param TP

  type TP

  Transfer_TransientProcess

  rtype

  None

FillMap()

• This method is used by ResultFromModel to collate the list of ResultFromTransient, avoiding duplications with a map Remark<self> is already in the map and has not to be bound

  param map

  type map

  TColStd_IndexedMapOfTransient

  rtype

  None

HasResult()

• Returns True if a result is recorded

  rtype

  bool

NbSubResults()

• Returns the count of recorded sub-results

  rtype

  int

ResultFromKey()

• Returns the ResultFromTransient attached to a given starting entity (the key). Returns a null handle if not found

  param key

  type key

  Standard_Transient

  rtype

  opencascade::handle<Transfer_ResultFromTransient>

SetBinder()

• Sets Binder (for result plus individual check)

  param binder

  type binder

  Transfer_Binder

  rtype

  None

SetStart()

• Sets starting entity

  param start

  type start

  Standard_Transient

  rtype

  None

Start()

• Returns the starting entity

  rtype

  opencascade::handle<Standard_Transient>

Strip()

• Clears some data attached to binders used by TransientProcess, which become useless once the transfer has been donethe list of sub-scoped binders, which is now recorded as sub-results

  rtype

  None

SubResult()

• Returns a sub-result, given its rank

  param num

  type num

  int

  rtype

  opencascade::handle<Transfer_ResultFromTransient>

property thisown

The membership flag

class Transfer_SequenceOfBinder(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class Transfer_SequenceOfFinder(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class Transfer_SimpleBinderOfTransient(*args)

Bases: OCC.Core.Transfer.Transfer_Binder

• Creates an empty SimpleBinderOfTransient Returns True if a starting object is bound with SEVERAL resultsHere, returns allways False See Binder itself

  rtype

  None

static DownCast(t)

static GetTypedResult()

• Returns a transient result according to its type (IsKind) i.e. the result itself if IsKind(atype), else searches in NextResult, until first found, then returns True If not found, returns False (res is NOT touched) //! This syntactic form avoids to do DownCastif a result is found with the good type, it is loaded in <res> and can be immediately used, well initialised

  param bnd

  type bnd

  Transfer_Binder

  param atype

  type atype

  Standard_Type

  param res

  type res

  Standard_Transient

  rtype

  bool

Result()

• Returns the defined Result, if there is one

  rtype

  opencascade::handle<Standard_Transient>

SetResult()

• Defines the Result

  param res

  type res

  Standard_Transient

  rtype

  None

property thisown

The membership flag

class Transfer_TransferDispatch(*args)

Bases: OCC.Core.Interface.Interface_CopyTool

• Creates a TransferDispatch from a Model. Works with a General Service Library, given as an Argument A TransferDispatch is created as a CopyTool in which the Control is set to TransientProcess

  param amodel

  type amodel

  Interface_InterfaceModel

  param lib

  type lib

  Interface_GeneralLib

  rtype

  None* Same as above, but Library is defined through a Protocol

  param amodel

  type amodel

  Interface_InterfaceModel

  param protocol

  type protocol

  Interface_Protocol

  rtype

  None* Same as above, but works with the Active Protocol

  param amodel

  type amodel

  Interface_InterfaceModel

  rtype

  None

TransientProcess()

• Returns the content of Control Object, as a TransientProcess

  rtype

  opencascade::handle<Transfer_TransientProcess>

property thisown

The membership flag

class Transfer_TransferInput(*args)

Bases: object

• Creates a TransferInput ready to use

  rtype

  None

Entities()

• Takes the transient items stored in a TransferIterator

  param list

  type list

  Transfer_TransferIterator

  rtype

  Interface_EntityIterator

FillModel()

• Fills an InterfaceModel with the Complete Result of a Transfer stored in a TransientProcess (Starting Objects are Transient) The complete result is exactly added to the model

  param proc

  type proc

  Transfer_TransientProcess

  param amodel

  type amodel

  Interface_InterfaceModel

  rtype

  None* Fills an InterfaceModel with results of the Transfer recorded in a TransientProcess (Starting Objects are Transient) : Root Result if <roots> is True (Default), Complete Result else The entities added to the model are determined from the result by by adding the referenced entities

  param proc

  type proc

  Transfer_TransientProcess

  param amodel

  type amodel

  Interface_InterfaceModel

  param proto

  type proto

  Interface_Protocol

  param roots

  default value is Standard_True

  type roots

  bool

  rtype

  None* Fills an InterfaceModel with the Complete Result of a Transfer stored in a TransientProcess (Starting Objects are Transient) The complete result is exactly added to the model

  param proc

  type proc

  Transfer_FinderProcess

  param amodel

  type amodel

  Interface_InterfaceModel

  rtype

  None* Fills an InterfaceModel with results of the Transfer recorded in a TransientProcess (Starting Objects are Transient) : Root Result if <roots> is True (Default), Complete Result else The entities added to the model are determined from the result by by adding the referenced entities

  param proc

  type proc

  Transfer_FinderProcess

  param amodel

  type amodel

  Interface_InterfaceModel

  param proto

  type proto

  Interface_Protocol

  param roots

  default value is Standard_True

  type roots

  bool

  rtype

  None

property thisown

The membership flag

class Transfer_TransferIterator(*args)

Bases: object

• Creates an empty Iterator

  rtype

  None

AddItem()

• Adds a Binder to the iteration list (construction)

  param atr

  type atr

  Transfer_Binder

  rtype

  None

Check()

• Returns Check associated to current Binder (in case of error, it brings Fail messages) (in case of warnings, it brings Warning messages)

  rtype

  opencascade::handle<Interface_Check>

HasFails()

• Returns True if Fail Messages are recorded with the current Binder. They can then be read through Check (see below)

  rtype

  bool

HasResult()

• Returns True if current Item brings a Result, Transient (Handle) or not or Multiple. That is to say, if it corresponds to a normally acheived Transfer, Transient Result is read by specific TransientResult below. Other kind of Result must be read specifically from its Binder

  rtype

  bool

HasTransientResult()

• Returns True if the current Item has a Transient Unique Result (if yes, use TransientResult to get it)

  rtype

  bool

HasUniqueResult()

• Returns True if Current Item has a Unique Result

  rtype

  bool

HasWarnings()

• Returns True if Warning Messages are recorded with the current Binder. They can then be read through Check (see below)

  rtype

  bool

More()

• Returns True if there are other Items to iterate

  rtype

  bool

Next()

• Sets Iteration to the next Item

  rtype

  None

Number()

• Returns count of Binders to be iterated

  rtype

  int

ResultType()

• Returns the Type of the Result of the current Item, if Unique. If No Unique Result (Error Transfert or Multiple Result), returns a Null Handle The Type isthe Dynamic Type for a Transient Result, the Type defined by the Binder Class else

  rtype

  opencascade::handle<Standard_Type>

SelectBinder()

• Selects Items on the Type of Binderkeep only Binders which are of a given Type (if keep is True) or reject only them (if keep is False)

  param atype

  type atype

  Standard_Type

  param keep

  type keep

  bool

  rtype

  None

SelectItem()

• Selects/Unselect (according to <keep> an item designated by its rank <num> in the list Used by sub-classes which have specific criteria

  param num

  type num

  int

  param keep

  type keep

  bool

  rtype

  None

SelectResult()

• Selects Items on the Type of Result. Considers only Unique Results. Considers Dynamic Type for Transient Result, Static Type (the one given to define the Binder) else. //! Results which are of a given Type (if keep is True) or reject only them (if keep is False)

  param atype

  type atype

  Standard_Type

  param keep

  type keep

  bool

  rtype

  None

SelectUnique()

• Select Items according Unicitykeep only Unique Results (if keep is True) or keep only Multiple Results (if keep is False)

  param keep

  type keep

  bool

  rtype

  None

Start()

• Clears Iteration in progress, to allow it to be restarted

  rtype

  None

Status()

• Returns Execution Status of current Binder Normal transfer corresponds to StatusDone

  rtype

  Transfer_StatusExec

TransientResult()

• Returns the Transient Result of the current Item if there is (else, returns a null Handle) Supposes that Binding is done by a SimpleBinderOfTransient

  rtype

  opencascade::handle<Standard_Transient>

Value()

• Returns the current Binder

  rtype

  opencascade::handle<Transfer_Binder>

property thisown

The membership flag

class Transfer_TransferMapOfProcessForFinder(*args)

Bases: object

Add()

Assign()

ChangeFromIndex()

ChangeFromKey()

ChangeSeek()

Clear()

Contains()

Exchange()

FindFromIndex()

FindFromKey()

FindIndex()

FindKey()

ReSize()

RemoveFromIndex()

RemoveKey()

RemoveLast()

Seek()

Set()

Size()

Substitute()

Swap()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class Transfer_TransferMapOfProcessForTransient(*args)

Bases: object

Add()

Assign()

ChangeFromIndex()

ChangeFromKey()

ChangeSeek()

Clear()

Contains()

Exchange()

FindFromIndex()

FindFromKey()

FindIndex()

FindKey()

ReSize()

RemoveFromIndex()

RemoveKey()

RemoveLast()

Seek()

Set()

Size()

Substitute()

Swap()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class Transfer_TransferOutput(*args)

Bases: object

• Creates a TransferOutput ready to use, with a TransientProcess

  param actor

  type actor

  Transfer_ActorOfTransientProcess

  param amodel

  type amodel

  Interface_InterfaceModel

  rtype

  None* Creates a TransferOutput from an already existing TransientProcess, and a Model Returns (by Reference, hence can be changed) the Mode for Scope Management. False (D) means Scope is ignored. True means that each individual Transfer (direct or through TransferRoots) is regarded as one Scope

  param proc

  type proc

  Transfer_TransientProcess

  param amodel

  type amodel

  Interface_InterfaceModel

  rtype

  None

ListForStatus()

• Returns the list of Starting Entities with these criteria- <normal> False, gives the entities bound with ABNORMAL STATUS (e.g.Fail recorded, Exception raised during Transfer) - <normal> True, gives Entities with or without a Result, but with no Fail, no Exception (Warnings are not counted) - <roots> False, considers all entities recorded (either for Result, or for at least one Fail or Warning message) - <roots> True (Default), considers only roots of Transfer (the Entities recorded at highest level) This method is based on AbnormalResult from TransferProcess

  param normal

  type normal

  bool

  param roots

  default value is Standard_True

  type roots

  bool

  rtype

  Interface_EntityIterator

Model()

• Returns the Starting Model

  rtype

  opencascade::handle<Interface_InterfaceModel>

ModelForStatus()

• Fills a Model with the list determined by ListForStatus This model starts from scratch (made by NewEmptyModel from the current Model), then is filled by AddWithRefs //! Useful to get separately from a transfer, the entities which have caused problem, in order to furtherly analyse them (with normal = False), or the ‘good’ entities, to obtain a data set ‘which works well’ (with normal = True)

  param protocol

  type protocol

  Interface_Protocol

  param normal

  type normal

  bool

  param roots

  default value is Standard_True

  type roots

  bool

  rtype

  opencascade::handle<Interface_InterfaceModel>

Transfer()

• Transfer checks that all taken Entities come from the same Model, then calls Transfer from TransientProcess

  param obj

  type obj

  Standard_Transient

  rtype

  None

TransferRoots()

• Runs transfer on the roots of the Interface Model The Roots are computed with a ShareFlags created from a Protocol given as Argument

  param protocol

  type protocol

  Interface_Protocol

  rtype

  None* Runs transfer on the roots defined by a Graph of dependences (which detains also a Model and its Entities) Roots are computed with a ShareFlags created from the Graph

  param G

  type G

  Interface_Graph

  rtype

  None* Runs transfer on the roots of the Interface Model Remark : the Roots are computed with a ShareFlags created from the Active Protocol

  rtype

  None

TransientProcess()

• Returns the TransientProcess used to work

  rtype

  opencascade::handle<Transfer_TransientProcess>

property thisown

The membership flag

class Transfer_TransientListBinder(*args)

Bases: OCC.Core.Transfer.Transfer_Binder

Return type

None:param list: :type list: TColStd_HSequenceOfTransient :rtype: None

AddResult()

• Adds an item to the result list

  param res

  type res

  Standard_Transient

  rtype

  None

static DownCast(t)

NbTransients()

Return type

int

Result()

Return type

opencascade::handle<TColStd_HSequenceOfTransient>

SetResult()

• Changes an already defined sub-result

  param num

  type num

  int

  param res

  type res

  Standard_Transient

  rtype

  None

Transient()

Parameters

num –

type num

int

rtype

opencascade::handle<Standard_Transient>

property thisown

The membership flag

class Transfer_TransientMapper(*args)

Bases: OCC.Core.Transfer.Transfer_Finder

• Creates a Mapper with a Value. This Value can then not be changed. It is used by the Hasher to compute the HashCode, which will then be stored for an immediate reading.

  param akey

  type akey

  Standard_Transient

  rtype

  None

static DownCast(t)

Value()

• Returns the contained value

  rtype

  opencascade::handle<Standard_Transient>

property thisown

The membership flag

class Transfer_TransientProcess(*args)

Bases: OCC.Core.Transfer.Transfer_ProcessForTransient

• Sets TransientProcess at initial state, with an initial size

  param nb

  default value is 10000

  type nb

  int

  rtype

  None

Context()

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

  rtype

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

static DownCast(t)

GetContext()

• Returns the Context attached to a name, if set and if it is Kind of the type, else a Null Handle Returns True if OK, False if no Context

  param name

  type name

  char *

  param type

  type type

  Standard_Type

  param ctx

  type ctx

  Standard_Transient

  rtype

  bool

Graph()

Return type

Interface_Graph

HGraph()

Return type

opencascade::handle<Interface_HGraph>

HasGraph()

Return type

bool

IsDataFail()

• Tells if an entity fails on data checking (load time, syntactic, or semantic check). Normally, should answer False. It is not prudent to try transferring an entity which fails on data checking

  param ent

  type ent

  Standard_Transient

  rtype

  bool

IsDataLoaded()

• Tells if an entity is well loaded from file (even if its data fail on checking, they are present). Mostly often, answers True. Else, there was a syntactic error in the file. A non-loaded entity MAY NOT BE transferred, unless its Report (in the model) is interpreted

  param ent

  type ent

  Standard_Transient

  rtype

  bool

Model()

• Returns the Model used for StartTrace

  rtype

  opencascade::handle<Interface_InterfaceModel>

PrintStats()

• Prints statistics on a given output, according mode

  param mode

  type mode

  int

  param S

  type S

  Message_Messenger

  rtype

  None

RootsForTransfer()

Return type

opencascade::handle<TColStd_HSequenceOfTransient>

SetContext()

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

  param name

  type name

  char *

  param ctx

  type ctx

  Standard_Transient

  rtype

  None

SetGraph()

• Sets a Graphsuperseedes SetModel if already done

  param HG

  type HG

  Interface_HGraph

  rtype

  None

SetModel()

• Sets an InterfaceModel, used by StartTrace, CheckList, queries on Integrity, to give informations significant for each norm.

  param model

  type model

  Interface_InterfaceModel

  rtype

  None

TypedSharings()

• Returns the list of sharings entities, AT ANY LEVEL, which are kind of a given type. Calls TypedSharings from Graph Returns an empty list if the Graph has not been aknowledged

  param start

  type start

  Standard_Transient

  param type

  type type

  Standard_Type

  rtype

  Interface_EntityIterator

property thisown

The membership flag

class Transfer_VoidBinder(*args)

Bases: OCC.Core.Transfer.Transfer_Binder

• a VoidBinder is not Multiple (Remarkit is not Simple too) But it can bring next results …

  rtype

  None

static DownCast(t)

property thisown

The membership flag