OCC.TFunction module¶

class Handle_TFunction_DataMapNodeOfDataMapOfGUIDDriver(*args)¶

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_TFunction_DataMapNodeOfDataMapOfLabelListOfLabel(*args)¶

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_TFunction_DoubleMapNodeOfDoubleMapOfIntegerLabel(*args)¶

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_TFunction_Driver(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_TFunction_DriverTable(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_TFunction_Function(*args)¶

Bases: OCC.TDF.Handle_TDF_Attribute

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_TFunction_GraphNode(*args)¶

Bases: OCC.TDF.Handle_TDF_Attribute

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_TFunction_HArray1OfDataMapOfGUIDDriver(*args)¶

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_TFunction_Scope(*args)¶

Bases: OCC.TDF.Handle_TDF_Attribute

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class SwigPyIterator(*args, **kwargs)¶

Bases: object

advance()¶

copy()¶

decr()¶

distance()¶

equal()¶

incr()¶

next()¶

previous()¶

thisown¶: The membership flag

value()¶

class TFunction_Array1OfDataMapOfGUIDDriver(*args)¶

Bases: object

Parameters:	Low (int) – Up (int) – Item (TFunction_DataMapOfGUIDDriver &) – Low – Up –
Return type:	None
Return type:	None

Assign()¶

Parameters:	Other (TFunction_Array1OfDataMapOfGUIDDriver &) –
Return type:	TFunction_Array1OfDataMapOfGUIDDriver

ChangeValue()¶

Parameters:	Index (int) –
Return type:	TFunction_DataMapOfGUIDDriver

Destroy()¶

Return type:	None

Init()¶

Parameters:	V (TFunction_DataMapOfGUIDDriver &) –
Return type:	None

IsAllocated()¶

Return type:	bool

Length()¶

Return type:	int

Lower()¶

Return type:	int

Set()¶

Parameters:	Other (TFunction_Array1OfDataMapOfGUIDDriver &) –
Return type:	TFunction_Array1OfDataMapOfGUIDDriver

SetValue()¶

Parameters:	Index (int) – Value (TFunction_DataMapOfGUIDDriver &) –
Return type:	None

Upper()¶

Return type:	int

Value()¶

Parameters:	Index (int) –
Return type:	TFunction_DataMapOfGUIDDriver

thisown¶: The membership flag

class TFunction_DataMapIteratorOfDataMapOfGUIDDriver(*args)¶

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:	None
Parameters:	aMap (TFunction_DataMapOfGUIDDriver &) –
Return type:	None

Initialize()¶

Parameters:	aMap (TFunction_DataMapOfGUIDDriver &) –
Return type:	None

Key()¶

Return type:	Standard_GUID

Value()¶

Return type:	Handle_TFunction_Driver

thisown¶: The membership flag

class TFunction_DataMapIteratorOfDataMapOfLabelListOfLabel(*args)¶

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:	None
Parameters:	aMap (TFunction_DataMapOfLabelListOfLabel &) –
Return type:	None

Initialize()¶

Parameters:	aMap (TFunction_DataMapOfLabelListOfLabel &) –
Return type:	None

Key()¶

Return type:	TDF_Label

Value()¶

Return type:	TDF_LabelList

thisown¶: The membership flag

class TFunction_DataMapNodeOfDataMapOfGUIDDriver(*args)¶

Bases: OCC.TCollection.TCollection_MapNode

Parameters:	K (Standard_GUID &) – I (Handle_TFunction_Driver &) – n (TCollection_MapNodePtr &) –
Return type:	None

GetHandle()¶

Key()¶

Return type:	Standard_GUID

Value()¶

Return type:	Handle_TFunction_Driver

thisown¶: The membership flag

class TFunction_DataMapNodeOfDataMapOfLabelListOfLabel(*args)¶

Bases: OCC.TCollection.TCollection_MapNode

Parameters:	K (TDF_Label &) – I (TDF_LabelList &) – n (TCollection_MapNodePtr &) –
Return type:	None

GetHandle()¶

Key()¶

Return type:	TDF_Label

Value()¶

Return type:	TDF_LabelList

thisown¶: The membership flag

class TFunction_DataMapOfGUIDDriver(*args)¶

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:	NbBuckets (int) – default value is 1
Return type:	None

Assign()¶

Parameters:	Other (TFunction_DataMapOfGUIDDriver &) –
Return type:	TFunction_DataMapOfGUIDDriver

Bind()¶

Parameters:	K (Standard_GUID &) – I (Handle_TFunction_Driver &) –
Return type:	bool

ChangeFind()¶

Parameters:	K (Standard_GUID &) –
Return type:	Handle_TFunction_Driver

ChangeFind1()¶

Parameters:	K (Standard_GUID &) –
Return type:	Standard_Address

Clear()¶

Return type:	None

Find()¶

Parameters:	K (Standard_GUID &) –
Return type:	Handle_TFunction_Driver

Find1()¶

Parameters:	K (Standard_GUID &) –
Return type:	Standard_Address

IsBound()¶

Parameters:	K (Standard_GUID &) –
Return type:	bool

ReSize()¶

Parameters:	NbBuckets (int) –
Return type:	None

Set()¶

Parameters:	Other (TFunction_DataMapOfGUIDDriver &) –
Return type:	TFunction_DataMapOfGUIDDriver

UnBind()¶

Parameters:	K (Standard_GUID &) –
Return type:	bool

thisown¶: The membership flag

class TFunction_DataMapOfLabelListOfLabel(*args)¶

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:	NbBuckets (int) – default value is 1
Return type:	None

Assign()¶

Parameters:	Other (TFunction_DataMapOfLabelListOfLabel &) –
Return type:	TFunction_DataMapOfLabelListOfLabel

Bind()¶

Parameters:	K (TDF_Label &) – I (TDF_LabelList &) –
Return type:	bool

ChangeFind()¶

Parameters:	K (TDF_Label &) –
Return type:	TDF_LabelList

ChangeFind1()¶

Parameters:	K (TDF_Label &) –
Return type:	Standard_Address

Clear()¶

Return type:	None

Find()¶

Parameters:	K (TDF_Label &) –
Return type:	TDF_LabelList

Find1()¶

Parameters:	K (TDF_Label &) –
Return type:	Standard_Address

IsBound()¶

Parameters:	K (TDF_Label &) –
Return type:	bool

ReSize()¶

Parameters:	NbBuckets (int) –
Return type:	None

Set()¶

Parameters:	Other (TFunction_DataMapOfLabelListOfLabel &) –
Return type:	TFunction_DataMapOfLabelListOfLabel

UnBind()¶

Parameters:	K (TDF_Label &) –
Return type:	bool

thisown¶: The membership flag

class TFunction_DoubleMapIteratorOfDoubleMapOfIntegerLabel(*args)¶

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:	None
Parameters:	aMap (TFunction_DoubleMapOfIntegerLabel &) –
Return type:	None

Initialize()¶

Parameters:	aMap (TFunction_DoubleMapOfIntegerLabel &) –
Return type:	None

Key1()¶

Return type:	int

Key2()¶

Return type:	TDF_Label

thisown¶: The membership flag

class TFunction_DoubleMapNodeOfDoubleMapOfIntegerLabel(*args)¶

Bases: OCC.TCollection.TCollection_MapNode

Parameters:	K1 (int &) – K2 (TDF_Label &) – n1 (TCollection_MapNodePtr &) – n2 (TCollection_MapNodePtr &) –
Return type:	None

GetHandle()¶

GetKey1()¶: TFunction_DoubleMapNodeOfDoubleMapOfIntegerLabel_GetKey1(TFunction_DoubleMapNodeOfDoubleMapOfIntegerLabel self) -> Standard_Integer

Key2()¶

Return type:	TDF_Label

Next2()¶

Return type:	TCollection_MapNodePtr

SetKey1()¶: TFunction_DoubleMapNodeOfDoubleMapOfIntegerLabel_SetKey1(TFunction_DoubleMapNodeOfDoubleMapOfIntegerLabel self, Standard_Integer value)

thisown¶: The membership flag

class TFunction_DoubleMapOfIntegerLabel(*args)¶

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:	NbBuckets (int) – default value is 1
Return type:	None

AreBound()¶

Parameters:	K1 (int &) – K2 (TDF_Label &) –
Return type:	bool

Assign()¶

Parameters:	Other (TFunction_DoubleMapOfIntegerLabel &) –
Return type:	TFunction_DoubleMapOfIntegerLabel

Bind()¶

Parameters:	K1 (int &) – K2 (TDF_Label &) –
Return type:	None

Clear()¶

Return type:	None

Find1()¶

Parameters:	K (int &) –
Return type:	TDF_Label

Find2()¶

Parameters:	K (TDF_Label &) –
Return type:	int

IsBound1()¶

Parameters:	K (int &) –
Return type:	bool

IsBound2()¶

Parameters:	K (TDF_Label &) –
Return type:	bool

ReSize()¶

Parameters:	NbBuckets (int) –
Return type:	None

Set()¶

Parameters:	Other (TFunction_DoubleMapOfIntegerLabel &) –
Return type:	TFunction_DoubleMapOfIntegerLabel

UnBind1()¶

Parameters:	K (int &) –
Return type:	bool

UnBind2()¶

Parameters:	K (TDF_Label &) –
Return type:	bool

thisown¶: The membership flag

class TFunction_Driver(*args, **kwargs)¶

Bases: OCC.MMgt.MMgt_TShared

Arguments()¶

The method fills-in the list by labels, where the arguments of the function are located.

Parameters:	args (TDF_LabelList &) –
Return type:	void

Execute()¶

Executes the function in this function driver and puts the impacted labels in the logbook log. arguments & results of functions ================================

Parameters:	log (TFunction_Logbook &) –
Return type:	int

GetHandle()¶

Init()¶

Initializes the label L for this function prior to its execution.

Parameters:	L (TDF_Label &) –
Return type:	None

Label()¶

Returns the label of the driver for this function.

Return type:	TDF_Label

MustExecute()¶

Analyzes the labels in the logbook log. Returns true if attributes have been modified. If the function label itself has been modified, the function must be executed.

Parameters:	log (TFunction_Logbook &) –
Return type:	bool

Results()¶

The method fills-in the list by labels, where the results of the function are located.

Parameters:	res (TDF_LabelList &) –
Return type:	void

Validate()¶

Validates labels of a function in <log>. This function is the one initialized in this function driver. Warning In regeneration mode, the solver must call this method even if the function is not executed. execution of function =====================

Parameters:	log (TFunction_Logbook &) –
Return type:	void

thisown¶: The membership flag

class TFunction_DriverTable(*args)¶

Bases: OCC.MMgt.MMgt_TShared

Default constructor

Return type:	None

AddDriver()¶

Returns true if the driver has been added successfully to the driver table.

Parameters:	guid (Standard_GUID &) – driver (Handle_TFunction_Driver &) – thread (int) – default value is 0
Return type:	bool

Clear()¶

Removes all drivers. Returns true if the driver has been removed successfully.

Return type:	None

DumpToString()¶: TFunction_DriverTable_DumpToString(TFunction_DriverTable self) -> std::string

FindDriver()¶

Returns true if the driver was found.

Parameters:	guid (Standard_GUID &) – driver (Handle_TFunction_Driver &) – thread (int) – default value is 0
Return type:	bool

static Get(*args)¶

Returns the driver table. If a driver does not exist, creates it.

Return type:	Handle_TFunction_DriverTable

GetHandle()¶

HasDriver()¶

Returns true if the driver exists in the driver table.

Parameters:	guid (Standard_GUID &) – thread (int) – default value is 0
Return type:	bool

RemoveDriver()¶

Removes a driver with the given GUID. Returns true if the driver has been removed successfully.

Parameters:	guid (Standard_GUID &) – thread (int) – default value is 0
Return type:	bool

thisown¶: The membership flag

TFunction_DriverTable_Get(*args)¶

Returns the driver table. If a driver does not exist, creates it.

Return type:	Handle_TFunction_DriverTable

class TFunction_Function(*args)¶

Bases: OCC.TDF.TDF_Attribute

Return type:	None

DumpToString()¶: TFunction_Function_DumpToString(TFunction_Function self) -> std::string

Failed()¶

Returns true if the execution failed

Return type:	bool

GetDriverGUID()¶

Returns the GUID for this function’s driver.

Return type:	Standard_GUID

GetFailure()¶

Returns an index of failure if the execution of this function failed. If this integer value is 0, no failure has occurred. Implementation of Attribute methods: ===================================

Return type:	int

GetHandle()¶

static GetID(*args)¶

Returns the GUID for functions. Returns a function found on the label. Instance methods: ================

Return type:	Standard_GUID

static Set(*args)¶

Static methods: ============== Finds or Creates a function attribute on the label <L>. Returns the function attribute.

Parameters:	L (TDF_Label &) –
Return type:	Handle_TFunction_Function

Finds or Creates a function attribute on the label <L>. Sets a driver ID to the function. Returns the function attribute.

Parameters:	L (TDF_Label &) – DriverID (Standard_GUID &) –
Return type:	Handle_TFunction_Function

SetDriverGUID()¶

Sets the driver for this function as that indentified by the GUID guid.

Parameters:	guid (Standard_GUID &) –
Return type:	None

SetFailure()¶

Sets the failed index.

Parameters:	mode (int) – default value is 0
Return type:	None

thisown¶: The membership flag

TFunction_Function_GetID(*args)¶

Returns the GUID for functions. Returns a function found on the label. Instance methods: ================

Return type:	Standard_GUID

TFunction_Function_Set(*args)¶

Static methods: ============== Finds or Creates a function attribute on the label <L>. Returns the function attribute.

Parameters:	L (TDF_Label &) –
Return type:	Handle_TFunction_Function

Finds or Creates a function attribute on the label <L>. Sets a driver ID to the function. Returns the function attribute.

Parameters:	L (TDF_Label &) – DriverID (Standard_GUID &) –
Return type:	Handle_TFunction_Function

class TFunction_GraphNode(*args)¶

Bases: OCC.TDF.TDF_Attribute

Return type:	None

AddNext()¶

Defines a reference to the function as a next one.

Parameters:	funcID (int) –
Return type:	bool

Defines a reference to the function as a next one.

Parameters:	func (TDF_Label &) –
Return type:	bool

AddPrevious()¶

Defines a reference to the function as a previous one.

Parameters:	funcID (int) –
Return type:	bool

Defines a reference to the function as a previous one.

Parameters:	func (TDF_Label &) –
Return type:	bool

DumpToString()¶: TFunction_GraphNode_DumpToString(TFunction_GraphNode self) -> std::string

GetHandle()¶

static GetID(*args)¶

Returns the GUID for GraphNode attribute. Instant methods =============== Constructor (empty).

Return type:	Standard_GUID

GetNext()¶

Returns a map of next functions.

Return type:	TColStd_MapOfInteger

GetPrevious()¶

Returns a map of previous functions.

Return type:	TColStd_MapOfInteger

GetStatus()¶

Returns the execution status of the function.

Return type:	TFunction_ExecutionStatus

RemoveAllNext()¶

Clears a map of next functions.

Return type:	None

RemoveAllPrevious()¶

Clears a map of previous functions.

Return type:	None

RemoveNext()¶

Removes a reference to the function as a next one.

Parameters:	funcID (int) –
Return type:	bool

Removes a reference to the function as a next one.

Parameters:	func (TDF_Label &) –
Return type:	bool

RemovePrevious()¶

Removes a reference to the function as a previous one.

Parameters:	funcID (int) –
Return type:	bool

Removes a reference to the function as a previous one.

Parameters:	func (TDF_Label &) –
Return type:	bool

static Set(*args)¶

Static methods ============== Finds or Creates a graph node attribute at the label <L>. Returns the attribute.

Parameters:	L (TDF_Label &) –
Return type:	Handle_TFunction_GraphNode

SetStatus()¶

Defines an execution status for a function. Implementation of Attribute methods ===================================

Parameters:	status (TFunction_ExecutionStatus) –
Return type:	None

thisown¶: The membership flag

TFunction_GraphNode_GetID(*args)¶

Returns the GUID for GraphNode attribute. Instant methods =============== Constructor (empty).

Return type:	Standard_GUID

TFunction_GraphNode_Set(*args)¶

Static methods ============== Finds or Creates a graph node attribute at the label <L>. Returns the attribute.

Parameters:	L (TDF_Label &) –
Return type:	Handle_TFunction_GraphNode

class TFunction_HArray1OfDataMapOfGUIDDriver(*args)¶

Bases: OCC.MMgt.MMgt_TShared

Parameters:	Low (int) – Up (int) – Low – Up – V (TFunction_DataMapOfGUIDDriver &) –
Return type:	None
Return type:	None

Array1()¶

Return type:	TFunction_Array1OfDataMapOfGUIDDriver

ChangeArray1()¶

Return type:	TFunction_Array1OfDataMapOfGUIDDriver

ChangeValue()¶

Parameters:	Index (int) –
Return type:	TFunction_DataMapOfGUIDDriver

GetHandle()¶

Init()¶

Parameters:	V (TFunction_DataMapOfGUIDDriver &) –
Return type:	None

Length()¶

Return type:	int

Lower()¶

Return type:	int

SetValue()¶

Parameters:	Index (int) – Value (TFunction_DataMapOfGUIDDriver &) –
Return type:	None

Upper()¶

Return type:	int

Value()¶

Parameters:	Index (int) –
Return type:	TFunction_DataMapOfGUIDDriver

thisown¶: The membership flag

class TFunction_IFunction(*args)¶

Bases: object

Return type:	None

A constructor. Initializes the interface by the label of function.

Parameters:	L (TDF_Label &) –
Return type:	None

Arguments()¶

The method fills-in the list by labels, where the arguments of the function are located.

Parameters:	args (TDF_LabelList &) –
Return type:	None

static DeleteFunction(*args)¶

Deletes a function attached to a label <L>. It deletes a TFunction_Function attribute and a TFunction_GraphNode. It deletes the functions from the scope of function of this document.

Parameters:	L (TDF_Label &) –
Return type:	bool

GetAllFunctions()¶

Returns the scope of all functions.

Return type:	TFunction_DoubleMapOfIntegerLabel

GetDriver()¶

Returns a driver of the function.

Parameters:	thread (int) – default value is 0
Return type:	Handle_TFunction_Driver

GetGraphNode()¶

Returns a graph node of the function.

Return type:	Handle_TFunction_GraphNode

GetLogbook()¶

Returns the Logbook - keeper of modifications.

Return type:	TFunction_Logbook

GetNext()¶

Returns a list of next functions.

Parameters:	prev (TDF_LabelList &) –
Return type:	None

GetPrevious()¶

Returns a list of previous functions.

Parameters:	prev (TDF_LabelList &) –
Return type:	None

GetStatus()¶

Returns the execution status of the function.

Return type:	TFunction_ExecutionStatus

Init()¶

Initializes the interface by the label of function.

Parameters:	L (TDF_Label &) –
Return type:	None

Label()¶

Returns a label of the function.

Return type:	TDF_Label

static NewFunction(*args)¶

Sets a new function attached to a label <L> with <ID>. It creates a new TFunction_Function attribute initialized by the <ID>, a new TFunction_GraphNode with an empty list of dependencies and the status equal to TFunction_ES_WrongDefinition. It registers the function in the scope of functions for this document.

Parameters:	L (TDF_Label &) – ID (Standard_GUID &) –
Return type:	bool

Results()¶

The method fills-in the list by labels, where the results of the function are located.

Parameters:	res (TDF_LabelList &) –
Return type:	None

SetStatus()¶

Defines an execution status for a function.

Parameters:	status (TFunction_ExecutionStatus) –
Return type:	None

UpdateDependencies()¶

Updates dependencies for all functions of the scope. It returns false in case of an error. An empty constructor.

Parameters:	Access (TDF_Label &) –
Return type:	bool

Updates the dependencies of this function only.

Return type:	bool

thisown¶: The membership flag

TFunction_IFunction_DeleteFunction(*args)¶

Deletes a function attached to a label <L>. It deletes a TFunction_Function attribute and a TFunction_GraphNode. It deletes the functions from the scope of function of this document.

Parameters:	L (TDF_Label &) –
Return type:	bool

TFunction_IFunction_NewFunction(*args)¶

Sets a new function attached to a label <L> with <ID>. It creates a new TFunction_Function attribute initialized by the <ID>, a new TFunction_GraphNode with an empty list of dependencies and the status equal to TFunction_ES_WrongDefinition. It registers the function in the scope of functions for this document.

Parameters:	L (TDF_Label &) – ID (Standard_GUID &) –
Return type:	bool

class TFunction_Iterator(*args)¶

Bases: object

An empty constructor.

Return type:	None

A constructor. Initializes the iterator.

Parameters:	Access (TDF_Label &) –
Return type:	None

Current()¶

Returns the current list of functions. If the iterator uses the execution status, the returned list contains only the functions with ‘not executed’ status.

Return type:	TDF_LabelList

DumpToString()¶: TFunction_Iterator_DumpToString(TFunction_Iterator self) -> std::string

GetMaxNbThreads()¶

Analyses the graph of dependencies and returns maximum number of threads may be used to calculate the model.

Return type:	int

GetStatus()¶

A help-function aimed to help the user to check the status of retrurned function. It calls TFunction_GraphNode::GetStatus() inside.

Parameters:	func (TDF_Label &) –
Return type:	TFunction_ExecutionStatus

GetUsageOfExecutionStatus()¶

Returns usage of execution status by the iterator.

Return type:	bool

Init()¶

Initializes the Iterator.

Parameters:	Access (TDF_Label &) –
Return type:	void

More()¶

Returns false if the graph of functions is fully iterated.

Return type:	bool

Next()¶

Switches the iterator to the next list of current functions.

Return type:	void

SetStatus()¶

A help-function aimed to help the user to change the execution status of a function. It calls TFunction_GraphNode::SetStatus() inside.

Parameters:	func (TDF_Label &) – status (TFunction_ExecutionStatus) –
Return type:	None

SetUsageOfExecutionStatus()¶

Defines the mode of iteration - usage or not of the execution status. If the iterator takes into account the execution status, the method ::Current() returns only ‘not executed’ functions while their status is not changed. If the iterator ignores the execution status, the method ::Current() returns the functions following their dependencies and ignoring the execution status.

Parameters:	usage (bool) –
Return type:	None

thisown¶: The membership flag

class TFunction_Logbook(*args)¶

Bases: object

next methods are solving declaration ===================================

Return type:	None

ChangeValid()¶

Return type:	TDF_LabelMap

Clear()¶

Clears this logbook to its default, empty state.

Return type:	None

Done()¶

Sets if the execution failed

Parameters:	status (bool) –
Return type:	None

DumpToString()¶: TFunction_Logbook_DumpToString(TFunction_Logbook self) -> std::string

GetImpacted()¶

Returns the map of impacted labels contained in this logbook.

Return type:	TDF_LabelMap

GetTouched()¶

Returns the map of touched labels in this logbook. A touched label is the one modified by the end user.

Return type:	TDF_LabelMap

GetValid()¶

Returns the map of valid labels in this logbook.

Return type:	TDF_LabelMap

IsDone()¶

Return type:	bool

IsEmpty()¶

Return type:	bool

IsModified()¶

Returns True if the label L is touched or impacted. This method is called by <TFunction_FunctionDriver::MustExecute>. If <WithChildren> is set to true, the method checks all the sublabels of <L> too. next method to consult solving result =====================================

Parameters:	L (TDF_Label &) – WithChildren (bool) – default value is Standard_False
Return type:	bool

SetImpacted()¶

Sets the label L as an impacted label in this logbook. This method is called by execution of the function driver.

Parameters:	L (TDF_Label &) – WithChildren (bool) – default value is Standard_False
Return type:	None

SetTouched()¶

Sets the label L as a touched label in this logbook. In other words, L is understood to have been modified by the end user.

Parameters:	L (TDF_Label &) –
Return type:	None

SetValid()¶

Sets the label L as a valid label in this logbook.

Parameters:	L (TDF_Label &) – WithChildren (bool) – default value is Standard_False
Return type:	None

thisown¶: The membership flag

class TFunction_Scope(*args)¶

Bases: OCC.TDF.TDF_Attribute

Return type:	None

AddFunction()¶

Adds a function to the scope of functions.

Parameters:	L (TDF_Label &) –
Return type:	bool

ChangeFunctions()¶

Returns the scope of functions for modification. Warning: Don’t use this method if You are not sure what You do!

Return type:	TFunction_DoubleMapOfIntegerLabel

DumpToString()¶: TFunction_Scope_DumpToString(TFunction_Scope self) -> std::string

GetFreeID()¶

Return type:	int

GetFunction()¶

Returns an ID of the function.

Parameters:	L (TDF_Label &) –
Return type:	int

Returns the label of the function with this ID.

Parameters:	ID (int) –
Return type:	TDF_Label

GetFunctions()¶

Returns the scope of functions.

Return type:	TFunction_DoubleMapOfIntegerLabel

GetHandle()¶

static GetID(*args)¶

Returns the GUID for Scope attribute. Instant methods =============== Constructor (empty).

Return type:	Standard_GUID

GetLogbook()¶

Returns the Logbook used in TFunction_Driver methods. Implementation of Attribute methods ===================================

Return type:	TFunction_Logbook

HasFunction()¶

Returns true if the function exists with such an ID.

Parameters:	ID (int) –
Return type:	bool

Returns true if the label contains a function of this scope.

Parameters:	L (TDF_Label &) –
Return type:	bool

RemoveAllFunctions()¶

Removes all functions from the scope of functions.

Return type:	None

RemoveFunction()¶

Removes a function from the scope of functions.

Parameters:	L (TDF_Label &) –
Return type:	bool

Removes a function from the scope of functions.

Parameters:	ID (int) –
Return type:	bool

static Set(*args)¶

Static methods ============== Finds or Creates a TFunction_Scope attribute at the root label accessed by <Access>. Returns the attribute.

Parameters:	Access (TDF_Label &) –
Return type:	Handle_TFunction_Scope

SetFreeID()¶

Parameters:	ID (int) –
Return type:	None

thisown¶: The membership flag

TFunction_Scope_GetID(*args)¶

Returns the GUID for Scope attribute. Instant methods =============== Constructor (empty).

Return type:	Standard_GUID

TFunction_Scope_Set(*args)¶

Static methods ============== Finds or Creates a TFunction_Scope attribute at the root label accessed by <Access>. Returns the attribute.

Parameters:	Access (TDF_Label &) –
Return type:	Handle_TFunction_Scope

register_handle(handle, base_object)¶: Inserts the handle into the base object to prevent memory corruption in certain cases