OCC.Core.TDataStd module¶

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

class SwigPyIterator(*args, **kwargs)¶

Bases: object

advance()¶

copy()¶

decr()¶

distance()¶

equal()¶

incr()¶

next()¶

previous()¶

property thisown¶: The membership flag

value()¶

class TDataStd_AsciiString(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_AsciiString self) → std::string¶

Get()¶

Return type: TCollection_AsciiString

static GetID()¶

class methods ============= Returns the GUID of the attribute.

rtype

Standard_GUID

IsEmpty()¶

Return type: bool

Set()¶

Finds, or creates an AsciiString attribute and sets the string. the AsciiString attribute is returned. AsciiString methods ===================

param label

type label

TDF_Label

param string

type string

TCollection_AsciiString

rtype

opencascade::handle<TDataStd_AsciiString>* Finds, or creates, an AsciiString attribute with explicit user defined <guid> and sets <string>. The Name attribute is returned.

param label

type label

TDF_Label

param guid

type guid

Standard_GUID

param string

type string

TCollection_AsciiString

rtype

opencascade::handle<TDataStd_AsciiString>:param S:

type S

TCollection_AsciiString

rtype

None

SetID()¶

Sets the explicit user defined GUID to the attribute.

param guid

type guid

Standard_GUID

rtype

None* Sets default GUID for the attribute.

rtype

None

property thisown¶: The membership flag

class TDataStd_BooleanArray(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_BooleanArray self) → std::string¶

static GetID()¶

Static methods ============== Returns an ID for array.

rtype

Standard_GUID

Init()¶

Initialize the inner array with bounds from <lower> to <upper>

param lower

type lower

int

param upper

type upper

int

rtype

None

InternalArray()¶

Return type: opencascade::handle<TColStd_HArray1OfByte>

Length()¶

Returns the number of elements in the array.

rtype

int

Lower()¶

Returns the lower boundary of the array.

rtype

int

static Set()¶

Finds or creates an attribute with internal boolean array.

param label

type label

TDF_Label

param lower

type lower

int

param upper

type upper

int

rtype

opencascade::handle<TDataStd_BooleanArray>* Finds or creates an attribute with the array using explicit user defined <guid>.

param label

type label

TDF_Label

param theGuid

type theGuid

Standard_GUID

param lower

type lower

int

param upper

type upper

int

rtype

opencascade::handle<TDataStd_BooleanArray>

SetID()¶

Sets the explicit GUID (user defined) for the attribute.

param theGuid

type theGuid

Standard_GUID

rtype

None* Sets default GUID for the attribute.

rtype

None

SetInternalArray()¶

Parameters

values –

type values: TColStd_HArray1OfByte
rtype: None

SetValue()¶

Sets the <Index>th element of the array to <Value> OutOfRange exception is raised if <Index> doesn’t respect Lower and Upper bounds of the internal array.

param index

type index

int

param value

type value

bool

rtype

None

Upper()¶

Returns the upper boundary of the array.

rtype

int

Value()¶

Return the value of the <Index>th element of the array.

param Index

type Index

int

rtype

bool

property thisown¶: The membership flag

class TDataStd_BooleanList(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

Append()¶

Parameters

value –

type value: bool
rtype: None

Clear()¶

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_BooleanList self) → std::string¶

Extent()¶

Return type: int

First()¶

Return type: bool

static GetID()¶

Static methods ============== Returns the ID of the list of booleans attribute.

rtype

Standard_GUID

InsertAfter()¶

Inserts the <value> after the <index> position. The indices start with 1 .. Extent().

param index

type index

int

param after_value

type after_value

bool

rtype

bool

InsertBefore()¶

Inserts the <value> before the <index> position. The indices start with 1 .. Extent().

param index

type index

int

param before_value

type before_value

bool

rtype

bool

IsEmpty()¶

Return type: bool

Last()¶

Return type: bool

List()¶

1 - means True, 0 - means False.

rtype

TDataStd_ListOfByte

Prepend()¶

Parameters

value –

type value: bool
rtype: None

Remove()¶

Removes a value at <index> position.

param index

type index

int

rtype

bool

static Set()¶

Finds or creates a list of boolean values attribute.

param label

type label

TDF_Label

rtype

opencascade::handle<TDataStd_BooleanList>* Finds or creates a list of boolean values attribute with explicit user defined <guid>.

param label

type label

TDF_Label

param theGuid

type theGuid

Standard_GUID

rtype

opencascade::handle<TDataStd_BooleanList>

SetID()¶

Sets the explicit GUID (user defined) for the attribute.

param theGuid

type theGuid

Standard_GUID

rtype

None* Sets default GUID for the attribute.

rtype

None

property thisown¶: The membership flag

class TDataStd_ByteArray(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

ChangeArray()¶

Sets the inner array <myValue> of the attribute to <newArray>. If value of <newArray> differs from <myValue>, Backup performed and myValue refers to new instance of HArray1OfInteger that holds <newArray> values. If <isCheckItems> equal True each item of <newArray> will be checked with each item of <myValue> for coincidence (to avoid backup).

param newArray

type newArray

TColStd_HArray1OfByte

param isCheckItems

default value is Standard_True

type isCheckItems

bool

rtype

None

static DownCast(t)¶

DumpToString(TDataStd_ByteArray self) → std::string¶

GetDelta()¶

Return type: bool

static GetID()¶

Static methods ============== Returns an ID for array.

rtype

Standard_GUID

Init()¶

Initialize the inner array with bounds from <lower> to <upper>

param lower

type lower

int

param upper

type upper

int

rtype

None

InternalArray()¶

Return type: opencascade::handle<TColStd_HArray1OfByte>

Length()¶

Returns the number of elements in the array.

rtype

int

Lower()¶

Returns the lower boundary of the array.

rtype

int

static Set()¶

Finds or creates an attribute with the array on the specified label. If <isDelta> == False, DefaultDeltaOnModification is used. If <isDelta> == True, DeltaOnModification of the current attribute is used. If attribute is already set, all input parameters are refused and the found attribute is returned.

param label

type label

TDF_Label

param lower

type lower

int

param upper

type upper

int

param isDelta

default value is Standard_False

type isDelta

bool

rtype

opencascade::handle<TDataStd_ByteArray>* Finds or creates an attribute with byte array and explicit user defined <guid> on the specified label.

param label

type label

TDF_Label

param theGuid

type theGuid

Standard_GUID

param lower

type lower

int

param upper

type upper

int

param isDelta

default value is Standard_False

type isDelta

bool

rtype

opencascade::handle<TDataStd_ByteArray>

SetDelta()¶

for internal use only!

param isDelta

type isDelta

bool

rtype

None

SetID()¶

Sets the explicit GUID (user defined) for the attribute.

param theGuid

type theGuid

Standard_GUID

rtype

None* Sets default GUID for the attribute.

rtype

None

SetValue()¶

Sets the <Index>th element of the array to <Value> OutOfRange exception is raised if <Index> doesn’t respect Lower and Upper bounds of the internal array.

param index

type index

int

param value

type value

Standard_Byte

rtype

None

Upper()¶

Returns the upper boundary of the array.

rtype

int

Value()¶

Return the value of the <Index>th element of the array.

param Index

type Index

int

rtype

Standard_Byte

property thisown¶: The membership flag

class TDataStd_ChildNodeIterator(*args)¶

Bases: object

Creates an empty iterator.

rtype

None* Iterates on the ChildStepren of the given Step. If <allLevels> option is set to true, it explores not only the first, but all the sub Step levels.

param aTreeNode

type aTreeNode

TDataStd_TreeNode

param allLevels

default value is Standard_False

type allLevels

bool

rtype

None

Initialize()¶

Initializes the iteration on the Children Step of the given Step. If <allLevels> option is set to true, it explores not only the first, but all the sub Step levels.

param aTreeNode

type aTreeNode

TDataStd_TreeNode

param allLevels

default value is Standard_False

type allLevels

bool

rtype

None

More()¶

Returns True if there is a current Item in the iteration.

rtype

bool

Next()¶

Move to the next Item

rtype

None

NextBrother()¶

Move to the next Brother. If there is none, go up etc. This method is interesting only with ‘allLevels’ behavior, because it avoids to explore the current Step ChildStepren.

rtype

None

Value()¶

Returns the current item; a null Step if there is no one.

rtype

opencascade::handle<TDataStd_TreeNode>

property thisown¶: The membership flag

class TDataStd_Comment(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_Comment self) → std::string¶

Get()¶

Returns the comment attribute.

rtype

TCollection_ExtendedString

static GetID()¶

class methods ============= Returns the GUID for comments.

rtype

Standard_GUID

Set()¶

Find, or create a Comment attribute. the Comment attribute is returned.

param label

type label

TDF_Label

rtype

opencascade::handle<TDataStd_Comment>* Finds, or creates a Comment attribute and sets the string. the Comment attribute is returned. Comment methods ============

param label

type label

TDF_Label

param string

type string

TCollection_ExtendedString

rtype

opencascade::handle<TDataStd_Comment>:param S:

type S

TCollection_ExtendedString

rtype

None

property thisown¶: The membership flag

class TDataStd_Current(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_Current self) → std::string¶

static Get()¶

returns current of <acces> Framework. raise if (!Has)

param acces

type acces

TDF_Label

rtype

TDF_Label

static GetID()¶

class methods =============

rtype

Standard_GUID

GetLabel()¶

Return type: TDF_Label

static Has()¶

returns True if a current label is managed in <acces> Framework. class methods =============

param acces

type acces

TDF_Label

rtype

bool

static Set()¶

Set <L> as current of <L> Framework.

param L

type L

TDF_Label

rtype

void

SetLabel()¶

Parameters

current –

type current: TDF_Label
rtype: None

property thisown¶: The membership flag

class TDataStd_DataMapOfStringByte(*args)¶

Bases: object

Assign()¶

Bind()¶

Bound()¶

ChangeFind()¶

ChangeSeek()¶

Clear()¶

Exchange()¶

Find()¶

IsBound()¶

ReSize()¶

Seek()¶

Set()¶

Size()¶

UnBind()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class TDataStd_DataMapOfStringHArray1OfInteger(*args)¶

Bases: object

Assign()¶

Bind()¶

Bound()¶

ChangeFind()¶

ChangeSeek()¶

Clear()¶

Exchange()¶

Find()¶

IsBound()¶

ReSize()¶

Seek()¶

Set()¶

Size()¶

UnBind()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class TDataStd_DataMapOfStringHArray1OfReal(*args)¶

Bases: object

Assign()¶

Bind()¶

Bound()¶

ChangeFind()¶

ChangeSeek()¶

Clear()¶

Exchange()¶

Find()¶

IsBound()¶

ReSize()¶

Seek()¶

Set()¶

Size()¶

UnBind()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class TDataStd_DataMapOfStringReal(*args)¶

Bases: object

Assign()¶

Bind()¶

Bound()¶

ChangeFind()¶

ChangeSeek()¶

Clear()¶

Exchange()¶

Find()¶

IsBound()¶

ReSize()¶

Seek()¶

Set()¶

Size()¶

UnBind()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class TDataStd_DataMapOfStringString(*args)¶

Bases: object

Assign()¶

Bind()¶

Bound()¶

ChangeFind()¶

ChangeSeek()¶

Clear()¶

Exchange()¶

Find()¶

IsBound()¶

ReSize()¶

Seek()¶

Set()¶

Size()¶

UnBind()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class TDataStd_DeltaOnModificationOfByteArray(*args)¶

Bases: OCC.Core.TDF.TDF_DeltaOnModification

Initializes a TDF_DeltaOnModification.

param Arr

type Arr

TDataStd_ByteArray

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class TDataStd_DeltaOnModificationOfExtStringArray(*args)¶

Bases: OCC.Core.TDF.TDF_DeltaOnModification

Initializes a TDF_DeltaOnModification.

param Arr

type Arr

TDataStd_ExtStringArray

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class TDataStd_DeltaOnModificationOfIntArray(*args)¶

Bases: OCC.Core.TDF.TDF_DeltaOnModification

Initializes a TDF_DeltaOnModification.

param Arr

type Arr

TDataStd_IntegerArray

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class TDataStd_DeltaOnModificationOfIntPackedMap(*args)¶

Bases: OCC.Core.TDF.TDF_DeltaOnModification

Initializes a TDF_DeltaOnModification.

param Arr

type Arr

TDataStd_IntPackedMap

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class TDataStd_DeltaOnModificationOfRealArray(*args)¶

Bases: OCC.Core.TDF.TDF_DeltaOnModification

Initializes a TDF_DeltaOnModification.

param Arr

type Arr

TDataStd_RealArray

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class TDataStd_Directory(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static AddDirectory()¶

Creates a new sub-label and sets the sub-directory dir on that label.

param dir

type dir

TDataStd_Directory

rtype

opencascade::handle<TDataStd_Directory>

static DownCast(t)¶

DumpToString(TDataStd_Directory self) → std::string¶

static Find()¶

class methods ============= Searches for a directory attribute on the label current, or on one of the father labels of current. If a directory attribute is found, true is returned, and the attribute found is set as D.

param current

type current

TDF_Label

param D

type D

TDataStd_Directory

rtype

bool

static GetID()¶

Directory methods ===============

rtype

Standard_GUID

static MakeObjectLabel()¶

Makes new label and returns it to insert other object attributes (sketch,part…etc…)

param dir

type dir

TDataStd_Directory

rtype

TDF_Label

static New()¶

Creates an enpty Directory attribute, located at <label>. Raises if <label> has attribute

param label

type label

TDF_Label

rtype

opencascade::handle<TDataStd_Directory>

property thisown¶: The membership flag

class TDataStd_Expression(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_Expression self) → std::string¶

GetExpression()¶

Return type: TCollection_ExtendedString

static GetID()¶

class methods =============

rtype

Standard_GUID

GetVariables()¶

Return type: TDF_AttributeList

Name()¶

build and return the expression name

rtype

TCollection_ExtendedString

static Set()¶

Find, or create, an Expression attribute. Expressionmethods ============

param label

type label

TDF_Label

rtype

opencascade::handle<TDataStd_Expression>

SetExpression()¶

Parameters

E –

type E: TCollection_ExtendedString
rtype: None

property thisown¶: The membership flag

class TDataStd_ExtStringArray(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

Array()¶

Return the inner array of the ExtStringArray attribute

rtype

opencascade::handle<TColStd_HArray1OfExtendedString>

ChangeArray()¶

Sets the inner array <myValue> of the ExtStringArray attribute to <newArray>. If value of <newArray> differs from <myValue>, Backup performed and myValue refers to new instance of HArray1OfExtendedString that holds <newArray> values If <isCheckItems> equal True each item of <newArray> will be checked with each item of <myValue> for coincidence (to avoid backup).

param newArray

type newArray

TColStd_HArray1OfExtendedString

param isCheckItems

default value is Standard_True

type isCheckItems

bool

rtype

None

static DownCast(t)¶

DumpToString(TDataStd_ExtStringArray self) → std::string¶

GetDelta()¶

Return type: bool

static GetID()¶

class methods ============= Returns the GUID for the attribute.

rtype

Standard_GUID

Init()¶

Initializes the inner array with bounds from <lower> to <upper>

param lower

type lower

int

param upper

type upper

int

rtype

None

Length()¶

Return the number of elements of <self>.

rtype

int

Lower()¶

Return the lower bound.

rtype

int

static Set()¶

Finds, or creates, an ExtStringArray attribute with <lower> and <upper> bounds on the specified label. If <isDelta> == False, DefaultDeltaOnModification is used. If <isDelta> == True, DeltaOnModification of the current attribute is used. If attribute is already set, all input parameters are refused and the found attribute is returned.

param label

type label

TDF_Label

param lower

type lower

int

param upper

type upper

int

param isDelta

default value is Standard_False

type isDelta

bool

rtype

opencascade::handle<TDataStd_ExtStringArray>* Finds, or creates, an ExtStringArray attribute with explicit user defined <guid>. The ExtStringArray attribute is returned.

param label

type label

TDF_Label

param theGuid

type theGuid

Standard_GUID

param lower

type lower

int

param upper

type upper

int

param isDelta

default value is Standard_False

type isDelta

bool

rtype

opencascade::handle<TDataStd_ExtStringArray>

SetDelta()¶

for internal use only!

param isDelta

type isDelta

bool

rtype

None

SetID()¶

Sets the explicit GUID (user defined) for the attribute.

param theGuid

type theGuid

Standard_GUID

rtype

None* Sets default GUID for the attribute.

rtype

None

SetValue()¶

Sets the <Index>th element of the array to <Value> OutOfRange exception is raised if <Index> doesn’t respect Lower and Upper bounds of the internal array.

param Index

type Index

int

param Value

type Value

TCollection_ExtendedString

rtype

None

Upper()¶

Return the upper bound

rtype

int

Value()¶

Returns the value of the <Index>th element of the array

param Index

type Index

int

rtype

TCollection_ExtendedString

property thisown¶: The membership flag

class TDataStd_ExtStringList(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

Append()¶

Parameters

value –

type value: TCollection_ExtendedString
rtype: None

Clear()¶

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_ExtStringList self) → std::string¶

Extent()¶

Return type: int

First()¶

Return type: TCollection_ExtendedString

static GetID()¶

Static methods ============== Returns the ID of the list of strings attribute.

rtype

Standard_GUID

InsertAfter()¶

Inserts the <value> after the first meet of <after_value>.

param value

type value

TCollection_ExtendedString

param after_value

type after_value

TCollection_ExtendedString

rtype

bool* Inserts the <value> after the <index> position. The indices start with 1 .. Extent().

param index

type index

int

param after_value

type after_value

TCollection_ExtendedString

rtype

bool

InsertBefore()¶

Inserts the <value> before the first meet of <before_value>.

param value

type value

TCollection_ExtendedString

param before_value

type before_value

TCollection_ExtendedString

rtype

bool* Inserts the <value> before the <index> position. The indices start with 1 .. Extent().

param index

type index

int

param before_value

type before_value

TCollection_ExtendedString

rtype

bool

IsEmpty()¶

Return type: bool

Last()¶

Return type: TCollection_ExtendedString

List()¶

Return type: TDataStd_ListOfExtendedString

Prepend()¶

Parameters

value –

type value: TCollection_ExtendedString
rtype: None

Remove()¶

Removes the first meet of the <value>.

param value

type value

TCollection_ExtendedString

rtype

bool* Removes a value at <index> position.

param index

type index

int

rtype

bool

static Set()¶

Finds or creates a list of string values attribute with explicit user defined <guid>.

param label

type label

TDF_Label

rtype

opencascade::handle<TDataStd_ExtStringList>* Finds or creates a list of string values attribute.

param label

type label

TDF_Label

param theGuid

type theGuid

Standard_GUID

rtype

opencascade::handle<TDataStd_ExtStringList>

SetID()¶

Sets the explicit GUID (user defined) for the attribute.

param theGuid

type theGuid

Standard_GUID

rtype

None* Sets default GUID for the attribute.

rtype

None

property thisown¶: The membership flag

class TDataStd_HDataMapOfStringByte(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Parameters: NbBuckets – default value is 1 :type NbBuckets: int :rtype: None:param theOther: :type theOther: TDataStd_DataMapOfStringByte :rtype: None

ChangeMap()¶

Return type: TDataStd_DataMapOfStringByte

static DownCast(t)¶

Map()¶

Return type: TDataStd_DataMapOfStringByte

property thisown¶: The membership flag

class TDataStd_HDataMapOfStringHArray1OfInteger(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Parameters: NbBuckets – default value is 1 :type NbBuckets: int :rtype: None:param theOther: :type theOther: TDataStd_DataMapOfStringHArray1OfInteger :rtype: None

ChangeMap()¶

Return type: TDataStd_DataMapOfStringHArray1OfInteger

static DownCast(t)¶

Map()¶

Return type: TDataStd_DataMapOfStringHArray1OfInteger

property thisown¶: The membership flag

class TDataStd_HDataMapOfStringHArray1OfReal(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Parameters: NbBuckets – default value is 1 :type NbBuckets: int :rtype: None:param theOther: :type theOther: TDataStd_DataMapOfStringHArray1OfReal :rtype: None

ChangeMap()¶

Return type: TDataStd_DataMapOfStringHArray1OfReal

static DownCast(t)¶

Map()¶

Return type: TDataStd_DataMapOfStringHArray1OfReal

property thisown¶: The membership flag

class TDataStd_HDataMapOfStringInteger(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Parameters: NbBuckets – default value is 1 :type NbBuckets: int :rtype: None:param theOther: :type theOther: TColStd_DataMapOfStringInteger :rtype: None

ChangeMap()¶

Return type: TColStd_DataMapOfStringInteger

static DownCast(t)¶

Map()¶

Return type: TColStd_DataMapOfStringInteger

property thisown¶: The membership flag

class TDataStd_HDataMapOfStringReal(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Parameters: NbBuckets – default value is 1 :type NbBuckets: int :rtype: None:param theOther: :type theOther: TDataStd_DataMapOfStringReal :rtype: None

ChangeMap()¶

Return type: TDataStd_DataMapOfStringReal

static DownCast(t)¶

Map()¶

Return type: TDataStd_DataMapOfStringReal

property thisown¶: The membership flag

class TDataStd_HDataMapOfStringString(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Parameters: NbBuckets – default value is 1 :type NbBuckets: int :rtype: None:param theOther: :type theOther: TDataStd_DataMapOfStringString :rtype: None

ChangeMap()¶

Return type: TDataStd_DataMapOfStringString

static DownCast(t)¶

Map()¶

Return type: TDataStd_DataMapOfStringString

property thisown¶: The membership flag

class TDataStd_HLabelArray1(*args)¶

Bases: OCC.Core.TDataStd.TDataStd_LabelArray1, OCC.Core.Standard.Standard_Transient

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

Array1()¶

ChangeArray1()¶

static DownCast(t)¶

property thisown¶: The membership flag

class TDataStd_IntPackedMap(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

Add()¶

Parameters

theKey –

type theKey: int
rtype: bool

ChangeMap()¶

Parameters

theMap –

type theMap: TColStd_HPackedMapOfInteger
rtype: bool:param theMap:
type theMap: TColStd_PackedMapOfInteger
rtype: bool

Clear()¶

Return type: bool

Contains()¶

Parameters

theKey –

type theKey: int
rtype: bool

static DownCast(t)¶

DumpToString(TDataStd_IntPackedMap self) → std::string¶

Extent()¶

Return type: int

GetDelta()¶

Return type: bool

GetHMap()¶

Return type: opencascade::handle<TColStd_HPackedMapOfInteger>

static GetID()¶

class methods ============= Returns the GUID of the attribute.

rtype

Standard_GUID

GetMap()¶

Return type: TColStd_PackedMapOfInteger

IsEmpty()¶

Return type: bool

Remove()¶

Parameters

theKey –

type theKey: int
rtype: bool

static Set()¶

Finds or creates an integer map attribute on the given label. If <isDelta> == False, DefaultDeltaOnModification is used. If <isDelta> == True, DeltaOnModification of the current attribute is used. If attribute is already set, input parameter <isDelta> is refused and the found attribute returned. Attribute methods ===================

param label

type label

TDF_Label

param isDelta

default value is Standard_False

type isDelta

bool

rtype

opencascade::handle<TDataStd_IntPackedMap>

SetDelta()¶

for internal use only!

param isDelta

type isDelta

bool

rtype

None

property thisown¶: The membership flag

class TDataStd_Integer(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_Integer self) → std::string¶

Get()¶

Returns the integer value contained in the attribute.

rtype

int

static GetID()¶

class methods ============= Returns the GUID for integers.

rtype

Standard_GUID

IsCaptured()¶

Returns True if there is a reference on the same label

rtype

bool

Set()¶

Finds, or creates, an Integer attribute and sets <value> the Integer attribute is returned.

param label

type label

TDF_Label

param value

type value

int

rtype

opencascade::handle<TDataStd_Integer>* Finds, or creates, an Integer attribute with explicit user defined <guid> and sets <value>. The Integer attribute is returned.

param label

type label

TDF_Label

param guid

type guid

Standard_GUID

param value

type value

int

rtype

opencascade::handle<TDataStd_Integer>* Integer methods ===============

param V

type V

int

rtype

None

SetID()¶

Sets the explicit GUID (user defined) for the attribute.

param guid

type guid

Standard_GUID

rtype

None* Sets default GUID for the attribute.

rtype

None

property thisown¶: The membership flag

class TDataStd_IntegerArray(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

Array()¶

Return the inner array of the IntegerArray attribute

rtype

opencascade::handle<TColStd_HArray1OfInteger>

ChangeArray()¶

Sets the inner array <myValue> of the IntegerArray attribute to <newArray>. If value of <newArray> differs from <myValue>, Backup performed and myValue refers to new instance of HArray1OfInteger that holds <newArray> values If <isCheckItems> equal True each item of <newArray> will be checked with each item of <myValue> for coincidence (to avoid backup).

param newArray

type newArray

TColStd_HArray1OfInteger

param isCheckItems

default value is Standard_True

type isCheckItems

bool

rtype

None

static DownCast(t)¶

DumpToString(TDataStd_IntegerArray self) → std::string¶

GetDelta()¶

Return type: bool

static GetID()¶

class methods ============= Returns the GUID for arrays of integers.

rtype

Standard_GUID

Init()¶

Initialize the inner array with bounds from <lower> to <upper>

param lower

type lower

int

param upper

type upper

int

rtype

None

Length()¶

Returns the length of this array of integers in terms of the number of elements it contains.

rtype

int

Lower()¶

Returns the lower boundary of this array of integers.

rtype

int

static Set()¶

Finds or creates on the <label> an integer array attribute with the specified <lower> and <upper> boundaries. If <isDelta> == False, DefaultDeltaOnModification is used. If <isDelta> == True, DeltaOnModification of the current attribute is used. If attribute is already set, all input parameters are refused and the found attribute is returned.

param label

type label

TDF_Label

param lower

type lower

int

param upper

type upper

int

param isDelta

default value is Standard_False

type isDelta

bool

rtype

opencascade::handle<TDataStd_IntegerArray>* Finds, or creates, an IntegerArray attribute with explicit user defined <guid>. The IntegerArray attribute is returned.

param label

type label

TDF_Label

param theGuid

type theGuid

Standard_GUID

param lower

type lower

int

param upper

type upper

int

param isDelta

default value is Standard_False

type isDelta

bool

rtype

opencascade::handle<TDataStd_IntegerArray>

SetDelta()¶

for internal use only!

param isDelta

type isDelta

bool

rtype

None

SetID()¶

Sets the explicit GUID (user defined) for the attribute.

param theGuid

type theGuid

Standard_GUID

rtype

None* Sets default GUID for the attribute.

rtype

None

SetValue()¶

Sets the <Index>th element of the array to <Value> OutOfRange exception is raised if <Index> doesn’t respect Lower and Upper bounds of the internal array.

param Index

type Index

int

param Value

type Value

int

rtype

None

Upper()¶

Return the upper boundary of this array of integers.

rtype

int

Value()¶

Return the value of the <Index>th element of the array

param Index

type Index

int

rtype

int

property thisown¶: The membership flag

class TDataStd_IntegerList(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

Append()¶

Parameters

value –

type value: int
rtype: None

Clear()¶

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_IntegerList self) → std::string¶

Extent()¶

Return type: int

First()¶

Return type: int

static GetID()¶

Static methods ============== Returns the ID of the list of integer attribute.

rtype

Standard_GUID

InsertAfter()¶

Inserts the <value> after the first meet of <after_value>.

param value

type value

int

param after_value

type after_value

int

rtype

bool

InsertAfterByIndex()¶

Inserts the <value> after the <index> position. The indices start with 1 .. Extent().

param index

type index

int

param after_value

type after_value

int

rtype

bool

InsertBefore()¶

Inserts the <value> before the first meet of <before_value>.

param value

type value

int

param before_value

type before_value

int

rtype

bool

InsertBeforeByIndex()¶

Inserts the <value> before the <index> position. The indices start with 1 .. Extent().

param index

type index

int

param before_value

type before_value

int

rtype

bool

IsEmpty()¶

Return type: bool

Last()¶

Return type: int

List()¶

Return type: TColStd_ListOfInteger

Prepend()¶

Parameters

value –

type value: int
rtype: None

Remove()¶

Removes the first meet of the <value>.

param value

type value

int

rtype

bool

RemoveByIndex()¶

Removes a value at <index> position.

param index

type index

int

rtype

bool

static Set()¶

Finds or creates a list of integer values attribute.

param label

type label

TDF_Label

rtype

opencascade::handle<TDataStd_IntegerList>* Finds or creates a list of integer values attribute with explicit user defined <guid>.

param label

type label

TDF_Label

param theGuid

type theGuid

Standard_GUID

rtype

opencascade::handle<TDataStd_IntegerList>

SetID()¶

Sets the explicit GUID (user defined) for the attribute.

param theGuid

type theGuid

Standard_GUID

rtype

None* Sets default GUID for the attribute.

rtype

None

property thisown¶: The membership flag

class TDataStd_LabelArray1(*args)¶

Bases: object

Assign()¶

ChangeFirst()¶

ChangeLast()¶

ChangeValue()¶

First()¶

Init()¶

IsAllocated()¶

IsDeletable()¶

IsEmpty()¶

Last()¶

Length()¶

Lower()¶

Move()¶

Resize()¶

Set()¶

SetValue()¶

Size()¶

Upper()¶

Value()¶

begin()¶

cbegin()¶

cend()¶

end()¶

next()¶

property thisown¶: The membership flag

class TDataStd_ListIteratorOfListOfByte(*args)¶

Bases: object

ChangeValue()¶

More()¶

Next()¶

Value()¶

property thisown¶: The membership flag

class TDataStd_ListIteratorOfListOfExtendedString(*args)¶

Bases: object

ChangeValue()¶

More()¶

Next()¶

Value()¶

property thisown¶: The membership flag

class TDataStd_ListOfByte(*args)¶

Bases: object

Append()¶

Assign()¶

Clear()¶

First()¶

InsertAfter()¶

InsertBefore()¶

Last()¶

Prepend()¶

Remove()¶

RemoveFirst()¶

Reverse()¶

Set()¶

Size()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class TDataStd_ListOfExtendedString(*args)¶

Bases: object

Append()¶

Assign()¶

Clear()¶

First()¶

InsertAfter()¶

InsertBefore()¶

Last()¶

Prepend()¶

Remove()¶

RemoveFirst()¶

Reverse()¶

Set()¶

Size()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class TDataStd_Name(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_Name self) → std::string¶

Get()¶

Returns the name contained in this name attribute.

rtype

TCollection_ExtendedString

static GetID()¶

class methods working on the name itself ======================================== Returns the GUID for name attributes.

rtype

Standard_GUID

Set()¶

Creates (if does not exist) and sets the name in the name attribute. from any label <L> search in father labels (L is not concerned) the first name attribute.if found set it in <father>. class methods working on the name tree ====================================== Search in the whole TDF_Data the Name attribute which fit with <fullPath>. Returns True if found. Search under <currentLabel> a label which fit with <name>. Returns True if found. Shortcut which avoids building a ListOfExtendedStrin. Search in the whole TDF_Data the label which fit with name Returns True if found. tools methods to translate path <-> pathlist =========================================== move to draw For Draw test we may provide this tool method which convert a path in a sequence of string to call after the FindLabel methods. Example: if it’s given ‘Assembly:Part_1:Sketch_5’ it will return in <pathlist> the list of 3 strings: ‘Assembly’,’Part_1’,’Sketch_5’. move to draw from <pathlist> build the string path Name methods ============

param label

type label

TDF_Label

param string

type string

TCollection_ExtendedString

rtype

opencascade::handle<TDataStd_Name>* Finds, or creates, a Name attribute with explicit user defined <guid> and sets <string>. The Name attribute is returned.

param label

type label

TDF_Label

param guid

type guid

Standard_GUID

param string

type string

TCollection_ExtendedString

rtype

opencascade::handle<TDataStd_Name>* Sets <S> as name. Raises if <S> is not a valid name.

param S

type S

TCollection_ExtendedString

rtype

None

SetID()¶

Sets the explicit user defined GUID to the attribute.

param guid

type guid

Standard_GUID

rtype

None* Sets default GUID for the attribute.

rtype

None

property thisown¶: The membership flag

class TDataStd_NamedData(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

ChangeArraysOfIntegers()¶

Replace the container content by new content of the <theArraysOfIntegers>.

param theArraysOfIntegers

type theArraysOfIntegers

TDataStd_DataMapOfStringHArray1OfInteger

rtype

None

ChangeArraysOfReals()¶

Replace the container content by new content of the <theArraysOfReals>.

param theArraysOfReals

type theArraysOfReals

TDataStd_DataMapOfStringHArray1OfReal

rtype

None

ChangeBytes()¶

Replace the container content by new content of the <theBytes>.

param theBytes

type theBytes

TDataStd_DataMapOfStringByte

rtype

None

ChangeIntegers()¶

Replace the container content by new content of the <theIntegers>.

param theIntegers

type theIntegers

TColStd_DataMapOfStringInteger

rtype

None

ChangeReals()¶

Replace the container content by new content of the <theReals>.

param theReals

type theReals

TDataStd_DataMapOfStringReal

rtype

None

ChangeStrings()¶

Replace the container content by new content of the <theStrings>.

param theStrings

type theStrings

TDataStd_DataMapOfStringString

rtype

None

static DownCast(t)¶

DumpToString(TDataStd_NamedData self) → std::string¶

GetArrayOfIntegers()¶

Returns the named array of integer values. It returns a NULL Handle if there is no such a named array of integers (use HasArrayOfIntegers()).

param theName

type theName

TCollection_ExtendedString

rtype

opencascade::handle<TColStd_HArray1OfInteger>

GetArrayOfReals()¶

Returns the named array of real values. It returns a NULL Handle if there is no such a named array of reals (use HasArrayOfReals()).

param theName

type theName

TCollection_ExtendedString

rtype

opencascade::handle<TColStd_HArray1OfReal>

GetArraysOfIntegersContainer()¶

Returns the internal container of named arrays of integer values.

rtype

TDataStd_DataMapOfStringHArray1OfInteger

GetArraysOfRealsContainer()¶

Returns the internal container of named arrays of real values.

rtype

TDataStd_DataMapOfStringHArray1OfReal

GetByte()¶

Returns the named byte. It returns 0 if there is no such a named byte (use HasByte()).

param theName

type theName

TCollection_ExtendedString

rtype

Standard_Byte

GetBytesContainer()¶

Returns the internal container of named bytes.

rtype

TDataStd_DataMapOfStringByte

static GetID()¶

Static methods ============== Returns the ID of the named data attribute.

rtype

Standard_GUID

GetInteger()¶

Returns the integer value specified by the Name. It returns 0 if internal map doesn’t contain the specified integer (use HasInteger() to check before).

param theName

type theName

TCollection_ExtendedString

rtype

int

GetIntegersContainer()¶

Returns the internal container of named integers.

rtype

TColStd_DataMapOfStringInteger

GetReal()¶

Returns the named real. It returns 0.0 if there is no such a named real (use HasReal()).

param theName

type theName

TCollection_ExtendedString

rtype

float

GetRealsContainer()¶

Returns the internal container of named reals.

rtype

TDataStd_DataMapOfStringReal

GetString()¶

Returns the named string. It returns an empty string if there is no such a named string (use HasString()).

param theName

type theName

TCollection_ExtendedString

rtype

TCollection_ExtendedString

GetStringsContainer()¶

Returns the internal container of named strings.

rtype

TDataStd_DataMapOfStringString

HasArrayOfIntegers()¶

Returns true if the attribute contains this named array of integer values.

param theName

type theName

TCollection_ExtendedString

rtype

bool

HasArrayOfReals()¶

Returns true if the attribute contains this named array of real values.

param theName

type theName

TCollection_ExtendedString

rtype

bool

HasArraysOfIntegers()¶

Returns true if there are some named arrays of integer values in the attribute.

rtype

bool

HasArraysOfReals()¶

Returns true if there are some named arrays of real values in the attribute.

rtype

bool

HasByte()¶

Returns true if the attribute contains this named byte.

param theName

type theName

TCollection_ExtendedString

rtype

bool

HasBytes()¶

Returns true if there are some named bytes in the attribute.

rtype

bool

HasInteger()¶

Returns true if the attribute contains specified by Name integer value.

param theName

type theName

TCollection_ExtendedString

rtype

bool

HasIntegers()¶

Returns true if at least one named integer value is kept in the attribute.

rtype

bool

HasReal()¶

Returns true if the attribute contains a real specified by Name.

param theName

type theName

TCollection_ExtendedString

rtype

bool

HasReals()¶

Returns true if at least one named real value is kept in the attribute.

rtype

bool

HasString()¶

Returns true if the attribute contains this named string.

param theName

type theName

TCollection_ExtendedString

rtype

bool

HasStrings()¶

Returns true if there are some named strings in the attribute.

rtype

bool

static Set()¶

Finds or creates a named data attribute.

param label

type label

TDF_Label

rtype

opencascade::handle<TDataStd_NamedData>

SetArrayOfIntegers()¶

Defines a named array of integer values. If the array already exists, it changes its value to <theArrayOfIntegers>.

param theName

type theName

TCollection_ExtendedString

param theArrayOfIntegers

type theArrayOfIntegers

TColStd_HArray1OfInteger

rtype

None

SetArrayOfReals()¶

Defines a named array of real values. If the array already exists, it changes its value to <theArrayOfReals>.

param theName

type theName

TCollection_ExtendedString

param theArrayOfReals

type theArrayOfReals

TColStd_HArray1OfReal

rtype

None

SetByte()¶

Defines a named byte. If the byte already exists, it changes its value to <theByte>.

param theName

type theName

TCollection_ExtendedString

param theByte

type theByte

Standard_Byte

rtype

None

SetInteger()¶

Defines a named integer. If the integer already exists, it changes its value to <theInteger>.

param theName

type theName

TCollection_ExtendedString

param theInteger

type theInteger

int

rtype

None

SetReal()¶

Defines a named real. If the real already exists, it changes its value to <theReal>.

param theName

type theName

TCollection_ExtendedString

param theReal

type theReal

float

rtype

None

SetString()¶

Defines a named string. If the string already exists, it changes its value to <theString>.

param theName

type theName

TCollection_ExtendedString

param theString

type theString

TCollection_ExtendedString

rtype

None

property thisown¶: The membership flag

class TDataStd_NoteBook(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

Append()¶

Tool to Create an Integer attribute from <value>, Insert it in a new son label of <self>. The Real attribute is returned.

param value

type value

float

param isExported

default value is Standard_False

type isExported

bool

rtype

opencascade::handle<TDataStd_Real>* Tool to Create an Real attribute from <value>, Insert it in a new son label of <self>. The Integer attribute is returned.

param value

type value

int

param isExported

default value is Standard_False

type isExported

bool

rtype

opencascade::handle<TDataStd_Integer>

static DownCast(t)¶

DumpToString(TDataStd_NoteBook self) → std::string¶

static Find()¶

class methods ============= try to retrieve a NoteBook attribute at <current> label or in fathers label of <current>. Returns True if found and set <N>.

param current

type current

TDF_Label

param N

type N

TDataStd_NoteBook

rtype

bool

static GetID()¶

NoteBook methods ===============

rtype

Standard_GUID

static New()¶

Create an enpty NoteBook attribute, located at <label>. Raises if <label> has attribute

param label

type label

TDF_Label

rtype

opencascade::handle<TDataStd_NoteBook>

property thisown¶: The membership flag

class TDataStd_Real(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_Real self) → std::string¶

Get()¶

Returns the real number value contained in the attribute.

rtype

float

GetDimension()¶

Obsolete method that will be removed in next versions. This field is not supported in the persistence mechanism.

rtype

TDataStd_RealEnum

static GetID()¶

class methods ============= Returns the default GUID for real numbers.

rtype

Standard_GUID

IsCaptured()¶

Returns True if there is a reference on the same label

rtype

bool

Set()¶

Finds, or creates, a Real attribute with default GUID and sets <value>. The Real attribute is returned. The Real dimension is Scalar by default. Use SetDimension to overwrite. Real methods ============

param label

type label

TDF_Label

param value

type value

float

rtype

opencascade::handle<TDataStd_Real>* Finds, or creates, a Real attribute with explicit GUID and sets <value>. The Real attribute is returned. Real methods ============

param label

type label

TDF_Label

param guid

type guid

Standard_GUID

param value

type value

float

rtype

opencascade::handle<TDataStd_Real>* Sets the real number V.

param V

type V

float

rtype

None

SetDimension()¶

Obsolete method that will be removed in next versions. This field is not supported in the persistence mechanism.

param DIM

type DIM

TDataStd_RealEnum

rtype

None

SetID()¶

Sets the explicit GUID for the attribute.

param guid

type guid

Standard_GUID

rtype

None* Sets default GUID for the attribute.

rtype

None

property thisown¶: The membership flag

class TDataStd_RealArray(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

Array()¶

Returns the handle of this array of reals.

rtype

opencascade::handle<TColStd_HArray1OfReal>

ChangeArray()¶

Sets the inner array <myValue> of the RealArray attribute to <newArray>. If value of <newArray> differs from <myValue>, Backup performed and myValue refers to new instance of HArray1OfReal that holds <newArray> values If <isCheckItems> equal True each item of <newArray> will be checked with each item of <myValue> for coincidence (to avoid backup).

param newArray

type newArray

TColStd_HArray1OfReal

param isCheckItems

default value is Standard_True

type isCheckItems

bool

rtype

None

static DownCast(t)¶

DumpToString(TDataStd_RealArray self) → std::string¶

GetDelta()¶

Return type: bool

static GetID()¶

class methods ============= Returns the GUID for arrays of reals.

rtype

Standard_GUID

Init()¶

Initialize the inner array with bounds from <lower> to <upper>

param lower

type lower

int

param upper

type upper

int

rtype

None

Length()¶

Returns the number of elements of the array of reals in terms of the number of elements it contains.

rtype

int

Lower()¶

Returns the lower boundary of the array.

rtype

int

static Set()¶

Finds or creates on the <label> a real array attribute with the specified <lower> and <upper> boundaries. If <isDelta> == False, DefaultDeltaOnModification is used. If <isDelta> == True, DeltaOnModification of the current attribute is used. If attribute is already set, input parameter <isDelta> is refused and the found attribute returned.

param label

type label

TDF_Label

param lower

type lower

int

param upper

type upper

int

param isDelta

default value is Standard_False

type isDelta

bool

rtype

opencascade::handle<TDataStd_RealArray>* Finds, or creates, an RealArray attribute with explicit user defined <guid>. The RealArray attribute is returned.

param label

type label

TDF_Label

param theGuid

type theGuid

Standard_GUID

param lower

type lower

int

param upper

type upper

int

param isDelta

default value is Standard_False

type isDelta

bool

rtype

opencascade::handle<TDataStd_RealArray>

SetDelta()¶

for internal use only!

param isDelta

type isDelta

bool

rtype

None

SetID()¶

Sets the explicit GUID (user defined) for the attribute.

param theGuid

type theGuid

Standard_GUID

rtype

None* Sets default GUID for the attribute.

rtype

None

SetValue()¶

Sets the <Index>th element of the array to <Value> OutOfRange exception is raised if <Index> doesn’t respect Lower and Upper bounds of the internal array.

param Index

type Index

int

param Value

type Value

float

rtype

None

Upper()¶

Returns the upper boundary of the array.

rtype

int

Value()¶

Return the value of the <Index>th element of the array

param Index

type Index

int

rtype

float

property thisown¶: The membership flag

class TDataStd_RealList(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

Append()¶

Parameters

value –

type value: float
rtype: None

Clear()¶

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_RealList self) → std::string¶

Extent()¶

Return type: int

First()¶

Return type: float

static GetID()¶

Static methods ============== Returns the ID of the list of doubles attribute.

rtype

Standard_GUID

InsertAfter()¶

Inserts the <value> after the first meet of <after_value>.

param value

type value

float

param after_value

type after_value

float

rtype

bool

InsertAfterByIndex()¶

Inserts the <value> after the <index> position. The indices start with 1 .. Extent().

param index

type index

int

param after_value

type after_value

float

rtype

bool

InsertBefore()¶

Inserts the <value> before the first meet of <before_value>.

param value

type value

float

param before_value

type before_value

float

rtype

bool

InsertBeforeByIndex()¶

Inserts the <value> before the <index> position. The indices start with 1 .. Extent().

param index

type index

int

param before_value

type before_value

float

rtype

bool

IsEmpty()¶

Return type: bool

Last()¶

Return type: float

List()¶

Return type: TColStd_ListOfReal

Prepend()¶

Parameters

value –

type value: float
rtype: None

Remove()¶

Removes the first meet of the <value>.

param value

type value

float

rtype

bool

RemoveByIndex()¶

Removes a value at <index> position.

param index

type index

int

rtype

bool

static Set()¶

Finds or creates a list of double values attribute.

param label

type label

TDF_Label

rtype

opencascade::handle<TDataStd_RealList>* Finds or creates a list of double values attribute with explicit user defined <guid>.

param label

type label

TDF_Label

param theGuid

type theGuid

Standard_GUID

rtype

opencascade::handle<TDataStd_RealList>

SetID()¶

Sets the explicit GUID (user defined) for the attribute.

param theGuid

type theGuid

Standard_GUID

rtype

None* Sets default GUID for the attribute.

rtype

None

property thisown¶: The membership flag

class TDataStd_ReferenceArray(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_ReferenceArray self) → std::string¶

static GetID()¶

Static methods ============== Returns the ID of the array of references (labels) attribute.

rtype

Standard_GUID

Init()¶

Initialize the inner array with bounds from <lower> to <upper>

param lower

type lower

int

param upper

type upper

int

rtype

None

InternalArray()¶

Return type: opencascade::handle<TDataStd_HLabelArray1>

Length()¶

Returns the number of elements in the array.

rtype

int

Lower()¶

Returns the lower boundary of the array.

rtype

int

static Set()¶

Finds or creates an array of reference values (labels) attribute.

param label

type label

TDF_Label

param lower

type lower

int

param upper

type upper

int

rtype

opencascade::handle<TDataStd_ReferenceArray>* Finds or creates an array of reference values (labels) attribute with explicit user defined <guid>.

param label

type label

TDF_Label

param theGuid

type theGuid

Standard_GUID

param lower

type lower

int

param upper

type upper

int

rtype

opencascade::handle<TDataStd_ReferenceArray>

SetID()¶

Sets the explicit GUID (user defined) for the attribute.

param theGuid

type theGuid

Standard_GUID

rtype

None* Sets default GUID for the attribute.

rtype

None

SetInternalArray()¶

Parameters

values –

type values: TDataStd_HLabelArray1
param isCheckItems: default value is Standard_True
type isCheckItems: bool
rtype: None

SetValue()¶

Sets the <Index>th element of the array to <Value> OutOfRange exception is raised if <Index> doesn’t respect Lower and Upper bounds of the internal array.

param index

type index

int

param value

type value

TDF_Label

rtype

None

Upper()¶

Returns the upper boundary of the array.

rtype

int

Value()¶

Returns the value of the <Index>th element of the array.

param Index

type Index

int

rtype

TDF_Label

property thisown¶: The membership flag

class TDataStd_ReferenceList(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

Append()¶

Parameters

value –

type value: TDF_Label
rtype: None

Clear()¶

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_ReferenceList self) → std::string¶

Extent()¶

Return type: int

First()¶

Return type: TDF_Label

static GetID()¶

Static methods ============== Returns the ID of the list of references (labels) attribute.

rtype

Standard_GUID

InsertAfter()¶

Inserts the <value> after the first meet of <after_value>.

param value

type value

TDF_Label

param after_value

type after_value

TDF_Label

rtype

bool* Inserts the label after the <index> position. The indices start with 1 .. Extent().

param index

type index

int

param after_value

type after_value

TDF_Label

rtype

bool

InsertBefore()¶

Inserts the <value> before the first meet of <before_value>.

param value

type value

TDF_Label

param before_value

type before_value

TDF_Label

rtype

bool* Inserts the label before the <index> position. The indices start with 1 .. Extent().

param index

type index

int

param before_value

type before_value

TDF_Label

rtype

bool

IsEmpty()¶

Return type: bool

Last()¶

Return type: TDF_Label

List()¶

Return type: TDF_LabelList

Prepend()¶

Parameters

value –

type value: TDF_Label
rtype: None

Remove()¶

Removes the first meet of the <value>.

param value

type value

TDF_Label

rtype

bool* Removes a label at ‘index’ position.

param index

type index

int

rtype

bool

static Set()¶

Finds or creates a list of reference values (labels) attribute.

param label

type label

TDF_Label

rtype

opencascade::handle<TDataStd_ReferenceList>* Finds or creates a list of reference values (labels) attribute with explicit user defined <guid>.

param label

type label

TDF_Label

param theGuid

type theGuid

Standard_GUID

rtype

opencascade::handle<TDataStd_ReferenceList>

SetID()¶

Sets the explicit GUID (user defined) for the attribute.

param theGuid

type theGuid

Standard_GUID

rtype

None* Sets default GUID for the attribute.

rtype

None

property thisown¶: The membership flag

class TDataStd_Relation(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_Relation self) → std::string¶

static GetID()¶

class methods =============

rtype

Standard_GUID

GetRelation()¶

Return type: TCollection_ExtendedString

GetVariables()¶

Return type: TDF_AttributeList

Name()¶

build and return the relation name

rtype

TCollection_ExtendedString

static Set()¶

Find, or create, an Relation attribute. Real methods ============

param label

type label

TDF_Label

rtype

opencascade::handle<TDataStd_Relation>

SetRelation()¶

Parameters

E –

type E: TCollection_ExtendedString
rtype: None

property thisown¶: The membership flag

class TDataStd_Tick(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_Tick self) → std::string¶

static GetID()¶

Static methods ==============

rtype

Standard_GUID

static Set()¶

Find, or create, a Tick attribute. Tick methods ============

param label

type label

TDF_Label

rtype

opencascade::handle<TDataStd_Tick>

property thisown¶: The membership flag

class TDataStd_TreeNode(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

Append()¶

Insert the TreeNode <Child> as last child of <self>. If the insertion is successful <self> becomes the Father of <Child>.

param Child

type Child

TDataStd_TreeNode

rtype

bool

Depth()¶

Returns the depth of this tree node in the overall tree node structure. In other words, the number of father tree nodes of this one is returned.

rtype

int

static DownCast(t)¶

DumpToString(TDataStd_TreeNode self) → std::string¶

Father()¶

Returns the father TreeNode of <self>. Null if root.

rtype

opencascade::handle<TDataStd_TreeNode>

static Find()¶

class methods working on the node =================================== Returns true if the tree node T is found on the label L. Otherwise, false is returned.

param L

type L

TDF_Label

param T

type T

TDataStd_TreeNode

rtype

bool

FindLast()¶

Returns the last child tree node in this tree node object. to set fields =============

rtype

opencascade::handle<TDataStd_TreeNode>

First()¶

Returns the first child tree node in this tree node object.

rtype

opencascade::handle<TDataStd_TreeNode>

static GetDefaultTreeID()¶

returns a default tree ID. this ID is used by the <Set> method without explicit tree ID. Instance methods: ================

rtype

Standard_GUID

HasFather()¶

Returns true if this tree node attribute has a father tree node.

rtype

bool

HasFirst()¶

Returns true if this tree node attribute has a first child tree node.

rtype

bool

HasLast()¶

Returns true if this tree node attribute has a last child tree node.

rtype

bool

HasNext()¶

Returns true if this tree node attribute has a next tree node.

rtype

bool

HasPrevious()¶

Returns true if this tree node attribute has a previous tree node.

rtype

bool

InsertAfter()¶

Inserts the TreeNode <Node> after <self>. If insertion is successful <self> and <Node> belongs to the same Father.

param Node

type Node

TDataStd_TreeNode

rtype

bool

InsertBefore()¶

Inserts the TreeNode <Node> before <self>. If insertion is successful <self> and <Node> belongs to the same Father.

param Node

type Node

TDataStd_TreeNode

rtype

bool

IsAscendant()¶

Returns true if this tree node attribute is an ascendant of of. In other words, if it is a father or the father of a father of of.

param of

type of

TDataStd_TreeNode

rtype

bool

IsChild()¶

Returns true if this tree node attribute is a child of of.

param of

type of

TDataStd_TreeNode

rtype

bool

IsDescendant()¶

Returns true if this tree node attribute is a descendant of of. In other words, if it is a child or the child of a child of of.

param of

type of

TDataStd_TreeNode

rtype

bool

IsFather()¶

Returns true if this tree node attribute is a father of of.

param of

type of

TDataStd_TreeNode

rtype

bool

IsRoot()¶

Returns true if this tree node attribute is the ultimate father in the tree.

rtype

bool

Last()¶

Returns the last child tree node in this tree node object.

rtype

opencascade::handle<TDataStd_TreeNode>

NbChildren()¶

Returns the number of child nodes. If <allLevels> is true, the method counts children of all levels (children of children …)

param allLevels

default value is Standard_False

type allLevels

bool

rtype

int

Next()¶

Returns the next tree node in this tree node attribute. Warning This tree node is null if it is the last one in this tree node attribute.Returns the next TreeNode of <self>. Null if last.

rtype

opencascade::handle<TDataStd_TreeNode>

Prepend()¶

Insert the the TreeNode <Child> as first child of <self>. If the insertion is successful <self> becomes the Father of <Child>

param Child

type Child

TDataStd_TreeNode

rtype

bool

Previous()¶

Returns the previous tree node of this tree node attribute. Warning This tree node is null if it is the first one in this tree node attribute.

rtype

opencascade::handle<TDataStd_TreeNode>

Remove()¶

Removes this tree node attribute from its father node. The result is that this attribute becomes a root node.

rtype

bool

Root()¶

Returns the ultimate father of this tree node attribute.

rtype

opencascade::handle<TDataStd_TreeNode>

static Set()¶

Finds or Creates a TreeNode attribute on the label <L> with the default tree ID, returned by the method <GetDefaultTreeID>. Returns the created/found TreeNode attribute.

param L

type L

TDF_Label

rtype

opencascade::handle<TDataStd_TreeNode>* Finds or Creates a TreeNode attribute on the label <L>, with an explicit tree ID. <ExplicitTreeID> is the ID returned by <TDF_Attribute::ID> method. Returns the found/created TreeNode attribute.

param L

type L

TDF_Label

param ExplicitTreeID

type ExplicitTreeID

Standard_GUID

rtype

opencascade::handle<TDataStd_TreeNode>

SetFather()¶

Parameters

F –

type F: TDataStd_TreeNode
rtype: None

SetFirst()¶

Parameters

F –

type F: TDataStd_TreeNode
rtype: None

SetLast()¶

TreeNode callback: ==================

param F

type F

TDataStd_TreeNode

rtype

None

SetNext()¶

Parameters

F –

type F: TDataStd_TreeNode
rtype: None

SetPrevious()¶

Parameters

F –

type F: TDataStd_TreeNode
rtype: None

SetTreeID()¶

Parameters

explicitID –

type explicitID: Standard_GUID
rtype: None

property thisown¶: The membership flag

class TDataStd_UAttribute(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

static DownCast(t)¶

DumpToString(TDataStd_UAttribute self) → std::string¶

static Set()¶

api class methods ============= Find, or create, a UAttribute attribute with <LocalID> as Local GUID. The UAttribute attribute is returned. UAttribute methods ============

param label

type label

TDF_Label

param LocalID

type LocalID

Standard_GUID

rtype

opencascade::handle<TDataStd_UAttribute>

SetID()¶

Parameters

LocalID –

type LocalID: Standard_GUID
rtype: None

property thisown¶: The membership flag

class TDataStd_Variable(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

Assign()¶

create(if doesn’t exist) and returns the assigned expression attribute. fill it after.

rtype

opencascade::handle<TDataStd_Expression>

Constant()¶

if <status> is True, this variable will not be modified by the solver.

param status

type status

bool

rtype

None

Desassign()¶

if <self> is assigned delete the associated expression attribute.

rtype

None

static DownCast(t)¶

DumpToString(TDataStd_Variable self) → std::string¶

Expression()¶

if <self> is assigned, returns associated Expression attribute.

rtype

opencascade::handle<TDataStd_Expression>

Get()¶

returns value stored in associated Real attribute.

rtype

float

static GetID()¶

class methods =============

rtype

Standard_GUID

IsAssigned()¶

returns True if an Expression attribute is associated. create(if doesn’t exist), set and returns the assigned expression attribute.

rtype

bool

IsCaptured()¶

shortcut for <Real()->IsCaptured()>

rtype

bool

IsConstant()¶

A constant value is not modified by regeneration.

rtype

bool

IsValued()¶

returns True if a Real attribute is associated.

rtype

bool

Name()¶

set or change the name of the variable, in myUnknown and my associated Name attribute.

param string

type string

TCollection_ExtendedString

rtype

None* returns string stored in the associated Name attribute.

rtype

TCollection_ExtendedString

Real()¶

returns associated Real attribute.

rtype

opencascade::handle<TDataStd_Real>

Set()¶

Find, or create, a Variable attribute. Real methods ============

param label

type label

TDF_Label

rtype

opencascade::handle<TDataStd_Variable>* retrieve or create the associated real attribute and set the value <value>.

param value

type value

float

rtype

None* Obsolete method that will be removed in next versions. The dimension argument is not supported in the persistence mechanism.

param value

type value

float

param dimension

type dimension

TDataStd_RealEnum

rtype

None

Unit()¶

Parameters

unit –

type unit: TCollection_AsciiString
rtype: None* to read/write fields ===================
rtype: TCollection_AsciiString

property thisown¶: The membership flag

class tdatastd¶

Bases: object

static IDList()¶

Appends to <anIDList> the list of the attributes IDs of this package. CAUTION: <anIDList> is NOT cleared before use.

param anIDList

type anIDList

TDF_IDList

rtype

void

static Print()¶

Prints the name of the real dimension <DIM> as a String on the Stream <S> and returns <S>.

param DIM

type DIM

TDataStd_RealEnum

param S

type S

Standard_OStream

rtype

Standard_OStream

property thisown¶: The membership flag