OCC.Dico module

-Purpose : Defines alphanumeric dictionaries and iterators on themThose are generic classes (Iterator is nested in Dictionary)Three default instantiations are offered :with Integer and Handle Objects (Persistent and Transient)

class Dico_DictionaryOfInteger(*args)

Bases: OCC.MMgt.MMgt_TShared

Return type:None

Clean()

Return type:None

Clear()

Return type:None

Complete()

Parameters:acell (Handle_Dico_DictionaryOfInteger &) – Return type:bool

Copy()

Return type:Handle_Dico_DictionaryOfInteger

GetHandle()

GetItem()

Parameters:

• name (TCollection_AsciiString &) –
• anitem (int &) –
• exact (bool) – default value is Standard_True
• name –
• anitem –
• exact – default value is Standard_True

Return type:

bool

Return type:

bool

HasItem()

Parameters:

• name (TCollection_AsciiString &) –
• exact (bool) – default value is Standard_False
• name –
• exact – default value is Standard_True

Return type:

bool

Return type:

bool

IsEmpty()

Return type:bool

Item()

Parameters:

• name (TCollection_AsciiString &) –
• exact (bool) – default value is Standard_True
• name –
• exact – default value is Standard_True

Return type:

int

Return type:

int

NewItem()

Parameters:

• name (TCollection_AsciiString &) –
• isvalued (bool) –
• exact (bool) – default value is Standard_True
• name –
• isvalued –
• exact – default value is Standard_True

Return type:

int

Return type:

int

RemoveItem()

Parameters:

• name (TCollection_AsciiString &) –
• cln (bool) – default value is Standard_True
• exact (bool) – default value is Standard_True
• name –
• cln – default value is Standard_True
• exact – default value is Standard_True

Return type:

bool

Return type:

bool

SetItem()

Parameters:

• name (TCollection_AsciiString &) –
• anitem (int &) –
• exact (bool) – default value is Standard_True
• name –
• anitem –
• exact – default value is Standard_True

Return type:

None

Return type:

None

thisown

The membership flag

class Dico_DictionaryOfTransient(*args)

Bases: OCC.MMgt.MMgt_TShared

Return type:None

Clean()

Return type:None

Clear()

Return type:None

Complete()

Parameters:acell (Handle_Dico_DictionaryOfTransient &) – Return type:bool

Copy()

Return type:Handle_Dico_DictionaryOfTransient

GetHandle()

GetItem()

Parameters:

• name (TCollection_AsciiString &) –
• anitem (Handle_Standard_Transient &) –
• exact (bool) – default value is Standard_True
• name –
• anitem –
• exact – default value is Standard_True

Return type:

bool

Return type:

bool

HasItem()

Parameters:

• name (TCollection_AsciiString &) –
• exact (bool) – default value is Standard_False
• name –
• exact – default value is Standard_True

Return type:

bool

Return type:

bool

IsEmpty()

Return type:bool

Item()

Parameters:

• name (TCollection_AsciiString &) –
• exact (bool) – default value is Standard_True
• name –
• exact – default value is Standard_True

Return type:

Handle_Standard_Transient

Return type:

Handle_Standard_Transient

NewItem()

Parameters:

• name (TCollection_AsciiString &) –
• isvalued (bool) –
• exact (bool) – default value is Standard_True
• name –
• isvalued –
• exact – default value is Standard_True

Return type:

Handle_Standard_Transient

Return type:

Handle_Standard_Transient

RemoveItem()

Parameters:

• name (TCollection_AsciiString &) –
• cln (bool) – default value is Standard_True
• exact (bool) – default value is Standard_True
• name –
• cln – default value is Standard_True
• exact – default value is Standard_True

Return type:

bool

Return type:

bool

SetItem()

Parameters:

• name (TCollection_AsciiString &) –
• anitem (Handle_Standard_Transient &) –
• exact (bool) – default value is Standard_True
• name –
• anitem –
• exact – default value is Standard_True

Return type:

None

Return type:

None

thisown

The membership flag

class Dico_IteratorOfDictionaryOfInteger(*args)

Bases: object

Parameters:

• acell (Handle_Dico_DictionaryOfInteger &) –
• acell –
• basename (TCollection_AsciiString &) –
• acell –
• basename –

Return type:

None

Return type:

None

Return type:

None

More()

Return type:bool

Name()

Return type:TCollection_AsciiString

Next()

Return type:None

Start()

Return type:None

Value()

Return type:int

thisown

The membership flag

class Dico_IteratorOfDictionaryOfTransient(*args)

Bases: object

Parameters:

• acell (Handle_Dico_DictionaryOfTransient &) –
• acell –
• basename (TCollection_AsciiString &) –
• acell –
• basename –

Return type:

None

Return type:

None

Return type:

None

More()

Return type:bool

Name()

Return type:TCollection_AsciiString

Next()

Return type:None

Start()

Return type:None

Value()

Return type:Handle_Standard_Transient

thisown

The membership flag

class Dico_StackItemOfDictionaryOfInteger(*args)

Bases: OCC.MMgt.MMgt_TShared

Return type:None Parameters:previous (Handle_Dico_StackItemOfDictionaryOfInteger &) – Return type:None

GetHandle()

Previous()

Return type:Handle_Dico_StackItemOfDictionaryOfInteger

SetValue()

Parameters:cval (Handle_Dico_DictionaryOfInteger &) – Return type:None

Value()

Return type:Handle_Dico_DictionaryOfInteger

thisown

The membership flag

class Dico_StackItemOfDictionaryOfTransient(*args)

Bases: OCC.MMgt.MMgt_TShared

Return type:None Parameters:previous (Handle_Dico_StackItemOfDictionaryOfTransient &) – Return type:None

GetHandle()

Previous()

Return type:Handle_Dico_StackItemOfDictionaryOfTransient

SetValue()

Parameters:cval (Handle_Dico_DictionaryOfTransient &) – Return type:None

Value()

Return type:Handle_Dico_DictionaryOfTransient

thisown

The membership flag

class Handle_Dico_DictionaryOfInteger(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()

GetObject()

IsNull()

Nullify()

thisown

The membership flag

class Handle_Dico_DictionaryOfTransient(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()

GetObject()

IsNull()

Nullify()

thisown

The membership flag

class Handle_Dico_StackItemOfDictionaryOfInteger(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()

GetObject()

IsNull()

Nullify()

thisown

The membership flag

class Handle_Dico_StackItemOfDictionaryOfTransient(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

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

new_instancemethod(func, inst, cls)

register_handle(handle, base_object)

Inserts the handle into the base object to prevent memory corruption in certain cases