OpenCascade.js
API ReferenceApplicationFrameworkTKLCAF

TDataStd

OCCT package TDataStd: TDataStd, TDataStd_AsciiString, TDataStd_BooleanArray, TDataStd_BooleanList, and 39 more bound classes.

TDataStd

This package defines standard attributes for modelling. These allow you to create and modify labels and attributes for many basic data types. Standard topological and visualization attributes have also been created. To find an attribute attached to a specific label, you use the GUID of the type of attribute you are looking for.
To do this, first find this information using the method GetID as follows: Standard_GUID anID = MyAttributeClass::GetID(); Then, use the method Find for the label as follows: bool HasAttribute = aLabel.Find(anID,anAttribute); Note For information on the relations between this component of OCAF and the others, refer to the OCAF User's Guide.

Constructors(1)

Static methods(1)

  • IDList(anIDList: NCollection_List_Standard_GUID): void

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

    Parameters (1)
    • anIDList —
      Mutated in place; read the updated value from this argument after the call.

TDataStd_AsciiString

TDF_AttributeStandard_Transient

Used to define an AsciiString attribute containing a TCollection_AsciiString.

Constructors(1)

Static methods(5)

Instance methods(10)

  • Set(S: TCollection_AsciiString): void
    Parameters (1)
    • S
  • SetID(argNo0: Standard_GUID): void

    Sets the explicit user defined GUID to the attribute.

    Parameters (1)
    • argNo0
  • SetID(): void

    Sets default GUID for the attribute.

  • Get(): TCollection_AsciiString
  • IsEmpty(): boolean
  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • DynamicType(): Standard_Type

TDataStd_BooleanArray

TDF_AttributeStandard_Transient

An array of boolean values.

Constructors(1)

Static methods(5)

Instance methods(15)

  • Init(lower: number, upper: number): void

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

    Parameters (2)
    • lower
    • upper
  • SetValue(index: number, value: boolean): void

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

    Parameters (2)
    • index
    • value
  • SetID(argNo0: Standard_GUID): void

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

    Parameters (1)
    • argNo0
  • SetID(): void

    Sets default GUID for the attribute.

  • Value(Index: number): boolean

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

    Parameters (1)
    • Index
  • Lower(): number

    Returns the lower boundary of the array.

  • Upper(): number

    Returns the upper boundary of the array.

  • Length(): number

    Returns the number of elements in the array.

  • InternalArray(): TColStd_HArray1OfByte
  • SetInternalArray(values: TColStd_HArray1OfByte): void
    Parameters (1)
    • values
  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • DynamicType(): Standard_Type

TDataStd_BooleanList

TDF_AttributeStandard_Transient

Contains a list of bolleans.

Constructors(1)

Static methods(5)

Instance methods(18)

  • IsEmpty(): boolean
  • Extent(): number
  • Prepend(value: boolean): void
    Parameters (1)
    • value
  • Append(value: boolean): void
    Parameters (1)
    • value
  • Clear(): void
  • First(): boolean
  • Last(): boolean
  • List(): TDataStd_ListOfByte

    1 - means TRUE, 0 - means FALSE.

  • InsertBefore(index: number, before_value: boolean): boolean

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

    Parameters (2)
    • index
    • before_value
  • InsertAfter(index: number, after_value: boolean): boolean

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

    Parameters (2)
    • index
    • after_value
  • Remove(index: number): boolean

    Removes a value at <index> position.

    Parameters (1)
    • index
  • SetID(argNo0: Standard_GUID): void

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

    Parameters (1)
    • argNo0
  • SetID(): void

    Sets default GUID for the attribute.

  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • DynamicType(): Standard_Type

TDataStd_ByteArray

TDF_AttributeStandard_Transient

An array of Byte (unsigned char) values.

Constructors(1)

Static methods(5)

  • get_type_name(): string
  • get_type_descriptor(): Standard_Type
  • GetID(): Standard_GUID

    Static methods
    Returns an ID for array.

  • Set(label: TDF_Label, lower: number, upper: number, isDelta: boolean): TDataStd_ByteArray

    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.

    Parameters (4)
    • label
    • lower
    • upper
    • isDelta
  • Set(label: TDF_Label, theGuid: Standard_GUID, lower: number, upper: number, isDelta: boolean): TDataStd_ByteArray

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

    Parameters (5)
    • label
    • theGuid
    • lower
    • upper
    • isDelta

Instance methods(19)

  • DynamicType(): Standard_Type
  • Init(lower: number, upper: number): void

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

    Parameters (2)
    • lower
    • upper
  • SetValue(index: number, value: number): void

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

    Parameters (2)
    • index
    • value
  • SetID(argNo0: Standard_GUID): void

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

    Parameters (1)
    • argNo0
  • SetID(): void

    Sets default GUID for the attribute.

  • Value(Index: number): number

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

    Parameters (1)
    • Index
  • Lower(): number

    Returns the lower boundary of the array.

  • Upper(): number

    Returns the upper boundary of the array.

  • Length(): number

    Returns the number of elements in the array.

  • InternalArray(): TColStd_HArray1OfByte
  • ChangeArray(newArray: TColStd_HArray1OfByte, isCheckItems?: boolean): void

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

    Parameters (2)
    • newArray
    • isCheckItems
  • GetDelta(): boolean
  • SetDelta(isDelta: boolean): void

    for internal use only!

    Parameters (1)
    • isDelta
  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • DeltaOnModification(anOldAttribute: TDF_Attribute): TDF_DeltaOnModification

    Makes a DeltaOnModification between <me> and <anOldAttribute>.

    Parameters (1)
    • anOldAttribute
  • DeltaOnModification(aDelta: TDF_DeltaOnModification): void

    Makes a DeltaOnModification between <me> and <anOldAttribute>.

    Parameters (1)
    • aDelta

TDataStd_ChildNodeIterator

Iterates on the ChildStepren step of a step, at the first level only. It is possible to ask the iterator to explore all the sub step levels of the given one, with the option "allLevels".

Constructors(2)

Instance methods(5)

  • Initialize(aTreeNode: TDataStd_TreeNode, allLevels?: boolean): void

    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.

    Parameters (2)
    • aTreeNode
    • allLevels
  • More(): boolean

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

  • Next(): void

    Move to the next Item.

  • NextBrother(): void

    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.

  • Value(): TDataStd_TreeNode

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

TDataStd_Comment

TDataStd_GenericExtStringTDF_AttributeStandard_Transient

Comment attribute. may be associated to any label to store user comment.

Constructors(1)

Static methods(5)

Instance methods(5)

TDataStd_Current

TDF_AttributeStandard_Transient

this attribute, located at root label, manage an access to a current label.

Constructors(1)

Static methods(6)

Instance methods(7)

  • SetLabel(current: TDF_Label): void
    Parameters (1)
    • current
  • GetLabel(): TDF_Label
  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • DynamicType(): Standard_Type

TDataStd_DeltaOnModificationOfExtStringArray

TDF_DeltaOnModificationTDF_AttributeDeltaStandard_Transient

This class provides default services for an AttributeDelta on a MODIFICATION action.

Constructors(1)

Static methods(2)

Instance methods(2)

TDataStd_DeltaOnModificationOfIntArray

TDF_DeltaOnModificationTDF_AttributeDeltaStandard_Transient

This class provides default services for an AttributeDelta on a MODIFICATION action.

Constructors(1)

Static methods(2)

Instance methods(2)

TDataStd_DeltaOnModificationOfIntPackedMap

TDF_DeltaOnModificationTDF_AttributeDeltaStandard_Transient

This class provides default services for an AttributeDelta on a MODIFICATION action.

Constructors(1)

Static methods(2)

Instance methods(2)

TDataStd_Directory

TDataStd_GenericEmptyTDF_AttributeStandard_Transient

Associates a directory in the data framework with a TDataStd_TagSource attribute. You can create a new directory label and add sub-directory or object labels to it,.

Constructors(1)

Static methods(7)

Instance methods(3)

TDataStd_Expression

TDF_AttributeStandard_Transient

Expression attribute.

  • Data Structure of the Expression is stored in a string and references to variables used by the string
    Warning: To be consistent, each Variable referenced by the expression must have its equivalent in the string

Constructors(1)

Static methods(4)

Instance methods(9)

TDataStd_ExtStringArray

TDF_AttributeStandard_Transient

ExtStringArray Attribute. Handles an array of UNICODE strings (represented by the TCollection_ExtendedString class).

Constructors(1)

Static methods(5)

  • get_type_name(): string
  • get_type_descriptor(): Standard_Type
  • GetID(): Standard_GUID

    class methods
    Returns the GUID for the attribute.

  • Set(label: TDF_Label, lower: number, upper: number, isDelta: boolean): TDataStd_ExtStringArray

    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.

    Parameters (4)
    • label
    • lower
    • upper
    • isDelta
  • Set(label: TDF_Label, theGuid: Standard_GUID, lower: number, upper: number, isDelta: boolean): TDataStd_ExtStringArray

    Finds, or creates, an ExtStringArray attribute with explicit user defined <guid>. The ExtStringArray attribute is returned.

    Parameters (5)
    • label
    • theGuid
    • lower
    • upper
    • isDelta

Instance methods(19)

  • DynamicType(): Standard_Type
  • Init(lower: number, upper: number): void

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

    Parameters (2)
    • lower
    • upper
  • SetValue(Index: number, Value: TCollection_ExtendedString): void

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

    Parameters (2)
    • Index
    • Value
  • SetID(argNo0: Standard_GUID): void

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

    Parameters (1)
    • argNo0
  • SetID(): void

    Sets default GUID for the attribute.

  • Value(Index: number): TCollection_ExtendedString

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

    Parameters (1)
    • Index
  • Lower(): number

    Return the lower bound.

  • Upper(): number

    Return the upper bound.

  • Length(): number

    Return the number of elements of <me>.

  • ChangeArray(newArray: NCollection_HArray1_TCollection_ExtendedString, isCheckItems?: boolean): void

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

    Parameters (2)
    • newArray
    • isCheckItems
  • Array(): NCollection_HArray1_TCollection_ExtendedString

    Return the inner array of the ExtStringArray attribute.

  • GetDelta(): boolean
  • SetDelta(isDelta: boolean): void

    for internal use only!

    Parameters (1)
    • isDelta
  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • DeltaOnModification(anOldAttribute: TDF_Attribute): TDF_DeltaOnModification

    Makes a DeltaOnModification between <me> and <anOldAttribute>.

    Parameters (1)
    • anOldAttribute
  • DeltaOnModification(aDelta: TDF_DeltaOnModification): void

    Makes a DeltaOnModification between <me> and <anOldAttribute>.

    Parameters (1)
    • aDelta

TDataStd_ExtStringList

TDF_AttributeStandard_Transient

Contains a list of ExtendedString.

Constructors(1)

Static methods(5)

Instance methods(21)

TDataStd_GenericEmpty

TDF_AttributeStandard_Transient

An ancestor attribute for all attributes which have no fields. If an attribute inherits this one it should not have drivers for persistence.

Static methods(2)

Instance methods(3)

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • DynamicType(): Standard_Type

TDataStd_GenericExtString

TDF_AttributeStandard_Transient

An ancestor attribute for all attributes which have TCollection_ExtendedString field. If an attribute inherits this one it should not have drivers for persistence. Also this attribute provides functionality to have on the same label same attributes with different IDs.

Static methods(2)

Instance methods(8)

  • Set(S: TCollection_ExtendedString): void

    Sets as name. Raises if is not a valid name.

    Parameters (1)
    • S
  • SetID(argNo0: Standard_GUID): void

    Sets the explicit user defined GUID to the attribute.

    Parameters (1)
    • argNo0
  • SetID(): void

    Sets the explicit user defined GUID to the attribute.

  • Get(): TCollection_ExtendedString

    Returns the name contained in this name attribute.

  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • DynamicType(): Standard_Type

TDataStd_HDataMapOfStringHArray1OfInteger

Standard_Transient

Extension of NCollection_DataMap<TCollection_ExtendedString, occ::handle<NCollection_HArray1<int>>> class to be manipulated by handle.

Constructors(2)

Static methods(2)

Instance methods(3)

TDataStd_HDataMapOfStringHArray1OfReal

Standard_Transient

Extension of NCollection_DataMap<TCollection_ExtendedString, occ::handle<NCollection_HArray1<double>>> class to be manipulated by handle.

Constructors(2)

Static methods(2)

Instance methods(3)

TDataStd_HDataMapOfStringInteger

Standard_Transient

Extension of NCollection_DataMap<TCollection_ExtendedString, int> class to be manipulated by handle.

Constructors(2)

Static methods(2)

Instance methods(3)

TDataStd_HDataMapOfStringReal

Standard_Transient

Extension of NCollection_DataMap<TCollection_ExtendedString, double> class to be manipulated by handle.

Constructors(2)

Static methods(2)

Instance methods(3)

TDataStd_HDataMapOfStringString

Standard_Transient

Extension of NCollection_DataMap<TCollection_ExtendedString, TCollection_ExtendedString> class to be manipulated by handle.

Constructors(2)

Static methods(2)

Instance methods(3)

TDataStd_Integer

TDF_AttributeStandard_Transient

The basis to define an integer attribute.

Constructors(1)

Static methods(5)

Instance methods(10)

  • Set(V: number): void

    Integer methods

    Parameters (1)
    • V
  • SetID(argNo0: Standard_GUID): void

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

    Parameters (1)
    • argNo0
  • SetID(): void

    Sets default GUID for the attribute.

  • Get(): number

    Returns the integer value contained in the attribute.

  • IsCaptured(): boolean

    Returns True if there is a reference on the same label.

  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • DynamicType(): Standard_Type

TDataStd_IntegerArray

TDF_AttributeStandard_Transient

Contains an array of integers.

Constructors(1)

Static methods(5)

  • get_type_name(): string
  • get_type_descriptor(): Standard_Type
  • GetID(): Standard_GUID

    class methods
    Returns the GUID for arrays of integers.

  • Set(label: TDF_Label, lower: number, upper: number, isDelta: boolean): TDataStd_IntegerArray

    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.

    Parameters (4)
    • label
    • lower
    • upper
    • isDelta
  • Set(label: TDF_Label, theGuid: Standard_GUID, lower: number, upper: number, isDelta: boolean): TDataStd_IntegerArray

    Finds, or creates, an IntegerArray attribute with explicit user defined <guid>. The IntegerArray attribute is returned.

    Parameters (5)
    • label
    • theGuid
    • lower
    • upper
    • isDelta

Instance methods(19)

  • DynamicType(): Standard_Type
  • Init(lower: number, upper: number): void

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

    Parameters (2)
    • lower
    • upper
  • SetValue(Index: number, Value: number): void

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

    Parameters (2)
    • Index
    • Value
  • SetID(argNo0: Standard_GUID): void

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

    Parameters (1)
    • argNo0
  • SetID(): void

    Sets default GUID for the attribute.

  • Value(Index: number): number

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

    Parameters (1)
    • Index
  • Lower(): number

    Returns the lower boundary of this array of integers.

  • Upper(): number

    Return the upper boundary of this array of integers.

  • Length(): number

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

  • ChangeArray(newArray: NCollection_HArray1_int, isCheckItems?: boolean): void

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

    Parameters (2)
    • newArray
    • isCheckItems
  • Array(): NCollection_HArray1_int

    Return the inner array of the IntegerArray attribute.

  • GetDelta(): boolean
  • SetDelta(isDelta: boolean): void

    for internal use only!

    Parameters (1)
    • isDelta
  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    Note. Uses inside ChangeArray() method.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • DeltaOnModification(anOldAttribute: TDF_Attribute): TDF_DeltaOnModification

    Makes a DeltaOnModification between <me> and <anOldAttribute>.

    Parameters (1)
    • anOldAttribute
  • DeltaOnModification(aDelta: TDF_DeltaOnModification): void

    Makes a DeltaOnModification between <me> and <anOldAttribute>.

    Parameters (1)
    • aDelta

TDataStd_IntegerList

TDF_AttributeStandard_Transient

Contains a list of integers.

Constructors(1)

Static methods(5)

Instance methods(21)

  • IsEmpty(): boolean
  • Extent(): number
  • Prepend(value: number): void
    Parameters (1)
    • value
  • Append(value: number): void
    Parameters (1)
    • value
  • SetID(argNo0: Standard_GUID): void

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

    Parameters (1)
    • argNo0
  • SetID(): void

    Sets default GUID for the attribute.

  • InsertBefore(value: number, before_value: number): boolean

    Inserts the before the first meet of <before_value>.

    Parameters (2)
    • value
    • before_value
  • InsertBeforeByIndex(index: number, before_value: number): boolean

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

    Parameters (2)
    • index
    • before_value
  • InsertAfter(value: number, after_value: number): boolean

    Inserts the after the first meet of <after_value>.

    Parameters (2)
    • value
    • after_value
  • InsertAfterByIndex(index: number, after_value: number): boolean

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

    Parameters (2)
    • index
    • after_value
  • Remove(value: number): boolean

    Removes the first meet of the .

    Parameters (1)
    • value
  • RemoveByIndex(index: number): boolean

    Removes a value at <index> position.

    Parameters (1)
    • index
  • Clear(): void
  • First(): number
  • Last(): number
  • List(): NCollection_List_int
  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • DynamicType(): Standard_Type

TDataStd_IntPackedMap

TDF_AttributeStandard_Transient

Attribute for storing TColStd_PackedMapOfInteger.

Constructors(1)

Static methods(4)

  • get_type_name(): string
  • get_type_descriptor(): Standard_Type
  • GetID(): Standard_GUID

    class methods
    Returns the GUID of the attribute.

  • Set(label: TDF_Label, isDelta?: boolean): TDataStd_IntPackedMap

    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

    Parameters (2)
    • label
    • isDelta

Instance methods(19)

TDataStd_Name

TDataStd_GenericExtStringTDF_AttributeStandard_Transient

Used to define a name attribute containing a string which specifies the name.

Constructors(1)

Static methods(5)

  • GetID(): Standard_GUID

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

  • Set(label: TDF_Label, string_: TCollection_ExtendedString): TDataStd_Name

    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

    Parameters (2)
    • label
    • string_
  • Set(label: TDF_Label, guid: Standard_GUID, string_: TCollection_ExtendedString): TDataStd_Name

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

    Parameters (3)
    • label
    • guid
    • string_
  • get_type_name(): string
  • get_type_descriptor(): Standard_Type

Instance methods(5)

TDataStd_NamedData

TDF_AttributeStandard_Transient

Contains a named data.

Constructors(1)

Static methods(4)

Instance methods(52)

TDataStd_NoteBook

TDataStd_GenericEmptyTDF_AttributeStandard_Transient

NoteBook Object attribute.

Constructors(1)

Static methods(5)

  • Find(current: TDF_Label): { returnValue: boolean; N: TDataStd_NoteBook; [Symbol.dispose](): void }

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

    Parameters (1)
    • current
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • N: owned by the returned envelope.
      Dispose the returned envelope to release owned Handle fields.
  • New(label: TDF_Label): TDataStd_NoteBook

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

    Parameters (1)
    • label
  • GetID(): Standard_GUID

    NoteBook methods

  • get_type_name(): string
  • get_type_descriptor(): Standard_Type

Instance methods(5)

TDataStd_Real

TDF_AttributeStandard_Transient

The basis to define a real number attribute.

Constructors(1)

Static methods(5)

Instance methods(12)

  • Set(V: number): void

    Sets the real number V.

    Parameters (1)
    • V
  • SetDimension(DIM: TDataStd_RealEnum): void

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

    Deprecated
    Parameters (1)
    • DIM
  • GetDimension(): TDataStd_RealEnum

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

    Deprecated
  • SetID(argNo0: Standard_GUID): void

    Sets the explicit GUID for the attribute.

    Parameters (1)
    • argNo0
  • SetID(): void

    Sets default GUID for the attribute.

  • Get(): number

    Returns the real number value contained in the attribute.

  • IsCaptured(): boolean

    Returns True if there is a reference on the same label.

  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • DynamicType(): Standard_Type

TDataStd_RealArray

TDF_AttributeStandard_Transient

A framework for an attribute composed of a real number array.

Constructors(1)

Static methods(5)

  • get_type_name(): string
  • get_type_descriptor(): Standard_Type
  • GetID(): Standard_GUID

    class methods
    Returns the GUID for arrays of reals.

  • Set(label: TDF_Label, lower: number, upper: number, isDelta: boolean): TDataStd_RealArray

    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.

    Parameters (4)
    • label
    • lower
    • upper
    • isDelta
  • Set(label: TDF_Label, theGuid: Standard_GUID, lower: number, upper: number, isDelta: boolean): TDataStd_RealArray

    Finds, or creates, an RealArray attribute with explicit user defined <guid>. The RealArray attribute is returned.

    Parameters (5)
    • label
    • theGuid
    • lower
    • upper
    • isDelta

Instance methods(19)

  • DynamicType(): Standard_Type
  • Init(lower: number, upper: number): void

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

    Parameters (2)
    • lower
    • upper
  • SetID(argNo0: Standard_GUID): void

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

    Parameters (1)
    • argNo0
  • SetID(): void

    Sets default GUID for the attribute.

  • SetValue(Index: number, Value: number): void

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

    Parameters (2)
    • Index
    • Value
  • Value(Index: number): number

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

    Parameters (1)
    • Index
  • Lower(): number

    Returns the lower boundary of the array.

  • Upper(): number

    Returns the upper boundary of the array.

  • Length(): number

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

  • ChangeArray(newArray: NCollection_HArray1_double, isCheckItems?: boolean): void

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

    Parameters (2)
    • newArray
    • isCheckItems
  • Array(): NCollection_HArray1_double

    Returns the handle of this array of reals.

  • GetDelta(): boolean
  • SetDelta(isDelta: boolean): void

    for internal use only!

    Parameters (1)
    • isDelta
  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    Note. Uses inside ChangeArray() method.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • DeltaOnModification(anOldAttribute: TDF_Attribute): TDF_DeltaOnModification

    Makes a DeltaOnModification between <me> and <anOldAttribute>.

    Parameters (1)
    • anOldAttribute
  • DeltaOnModification(aDelta: TDF_DeltaOnModification): void

    Makes a DeltaOnModification between <me> and <anOldAttribute>.

    Parameters (1)
    • aDelta

TDataStd_RealList

TDF_AttributeStandard_Transient

Contains a list of doubles.

Constructors(1)

Static methods(5)

Instance methods(21)

  • IsEmpty(): boolean
  • Extent(): number
  • Prepend(value: number): void
    Parameters (1)
    • value
  • Append(value: number): void
    Parameters (1)
    • value
  • SetID(argNo0: Standard_GUID): void

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

    Parameters (1)
    • argNo0
  • SetID(): void

    Sets default GUID for the attribute.

  • InsertBefore(value: number, before_value: number): boolean

    Inserts the before the first meet of <before_value>.

    Parameters (2)
    • value
    • before_value
  • InsertBeforeByIndex(index: number, before_value: number): boolean

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

    Parameters (2)
    • index
    • before_value
  • InsertAfter(value: number, after_value: number): boolean

    Inserts the after the first meet of <after_value>.

    Parameters (2)
    • value
    • after_value
  • InsertAfterByIndex(index: number, after_value: number): boolean

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

    Parameters (2)
    • index
    • after_value
  • Remove(value: number): boolean

    Removes the first meet of the .

    Parameters (1)
    • value
  • RemoveByIndex(index: number): boolean

    Removes a value at <index> position.

    Parameters (1)
    • index
  • Clear(): void
  • First(): number
  • Last(): number
  • List(): NCollection_List_double
  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • DynamicType(): Standard_Type

TDataStd_ReferenceArray

TDF_AttributeStandard_Transient

Contains an array of references to the labels.

Constructors(1)

Static methods(5)

Instance methods(16)

  • Init(lower: number, upper: number): void

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

    Parameters (2)
    • lower
    • upper
  • SetValue(index: number, value: TDF_Label): void

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

    Parameters (2)
    • index
    • value
  • SetID(argNo0: Standard_GUID): void

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

    Parameters (1)
    • argNo0
  • SetID(): void

    Sets default GUID for the attribute.

  • Value(Index: number): TDF_Label

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

    Parameters (1)
    • Index
  • Lower(): number

    Returns the lower boundary of the array.

  • Upper(): number

    Returns the upper boundary of the array.

  • Length(): number

    Returns the number of elements in the array.

  • InternalArray(): NCollection_HArray1_TDF_Label
  • SetInternalArray(values: NCollection_HArray1_TDF_Label, isCheckItems?: boolean): void
    Parameters (2)
    • values
    • isCheckItems
  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • References(aDataSet: TDF_DataSet): void

    Adds the first level referenced attributes and labels to <aDataSet>.
    For this, use the AddLabel or AddAttribute of DataSet.
    If there is none, do not implement the method.

    Parameters (1)
    • aDataSet
  • DynamicType(): Standard_Type

TDataStd_ReferenceList

TDF_AttributeStandard_Transient

Contains a list of references.

Constructors(1)

Static methods(5)

Instance methods(22)

  • IsEmpty(): boolean
  • Extent(): number
  • Prepend(value: TDF_Label): void
    Parameters (1)
    • value
  • Append(value: TDF_Label): void
    Parameters (1)
    • value
  • SetID(argNo0: Standard_GUID): void

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

    Parameters (1)
    • argNo0
  • SetID(): void

    Sets default GUID for the attribute.

  • InsertBefore(value: TDF_Label, before_value: TDF_Label): boolean

    Inserts the before the first meet of <before_value>.

    Parameters (2)
    • value
    • before_value
  • InsertBefore(index: number, before_value: TDF_Label): boolean

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

    Parameters (2)
    • index
    • before_value
  • InsertAfter(value: TDF_Label, after_value: TDF_Label): boolean

    Inserts the after the first meet of <after_value>.

    Parameters (2)
    • value
    • after_value
  • InsertAfter(index: number, after_value: TDF_Label): boolean

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

    Parameters (2)
    • index
    • after_value
  • Remove(value: TDF_Label): boolean

    Removes the first meet of the .

    Parameters (1)
    • value
  • Remove(index: number): boolean

    Removes a label at "index" position.

    Parameters (1)
    • index
  • Clear(): void
  • First(): TDF_Label
  • Last(): TDF_Label
  • List(): NCollection_List_TDF_Label
  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • References(aDataSet: TDF_DataSet): void

    Adds the first level referenced attributes and labels to <aDataSet>.
    For this, use the AddLabel or AddAttribute of DataSet.
    If there is none, do not implement the method.

    Parameters (1)
    • aDataSet
  • DynamicType(): Standard_Type

TDataStd_Relation

TDataStd_ExpressionTDF_AttributeStandard_Transient

Relation attribute.

  • Data Structure of the Expression is stored in a string and references to variables used by the string
    Warning: To be consistent, each Variable referenced by the relation must have its equivalent in the string

Constructors(1)

Static methods(4)

Instance methods(5)

TDataStd_Tick

TDataStd_GenericEmptyTDF_AttributeStandard_Transient

Defines a boolean attribute. If it exists at a label - true, Otherwise - false.

Constructors(1)

Static methods(4)

Instance methods(3)

TDataStd_TreeNode

TDF_AttributeStandard_Transient

Allows you to define an explicit tree of labels which you can also edit. Without this class, the data structure cannot be fully edited. This service is required if for presentation purposes, you want to create an application with a tree which allows you to organize and link data as a function of application features.

Constructors(1)

Static methods(6)

  • Find(L: TDF_Label): { returnValue: boolean; T: TDataStd_TreeNode; [Symbol.dispose](): void }

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

    Parameters (1)
    • L
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • T: owned by the returned envelope.
      Dispose the returned envelope to release owned Handle fields.
  • Set(L: TDF_Label): TDataStd_TreeNode

    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.

    Parameters (1)
    • L
  • Set(L: TDF_Label, ExplicitTreeID: Standard_GUID): 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.

    Parameters (2)
    • L
    • ExplicitTreeID
  • GetDefaultTreeID(): Standard_GUID

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

  • get_type_name(): string
  • get_type_descriptor(): Standard_Type

Instance methods(41)

  • Append(Child: TDataStd_TreeNode): boolean

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

    Parameters (1)
    • Child
  • Prepend(Child: TDataStd_TreeNode): boolean

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

    Parameters (1)
    • Child
  • InsertBefore(Node: TDataStd_TreeNode): boolean

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

    Parameters (1)
    • Node
  • InsertAfter(Node: TDataStd_TreeNode): boolean

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

    Parameters (1)
    • Node
  • Remove(): boolean

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

  • Depth(): number

    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.

  • NbChildren(allLevels?: boolean): number

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

    Parameters (1)
    • allLevels
  • IsAscendant(of_: TDataStd_TreeNode): boolean

    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.

    Parameters (1)
    • of_
  • IsDescendant(of_: TDataStd_TreeNode): boolean

    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.

    Parameters (1)
    • of_
  • IsRoot(): boolean

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

  • Root(): TDataStd_TreeNode

    Returns the ultimate father of this tree node attribute.

  • IsFather(of_: TDataStd_TreeNode): boolean

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

    Parameters (1)
    • of_
  • IsChild(of_: TDataStd_TreeNode): boolean

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

    Parameters (1)
    • of_
  • HasFather(): boolean

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

  • Father(): TDataStd_TreeNode

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

  • HasNext(): boolean

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

  • Next(): TDataStd_TreeNode

    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 <me>. Null if last.

  • HasPrevious(): boolean

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

  • Previous(): TDataStd_TreeNode

    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.

  • HasFirst(): boolean

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

  • First(): TDataStd_TreeNode

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

  • HasLast(): boolean

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

  • Last(): TDataStd_TreeNode

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

  • FindLast(): TDataStd_TreeNode

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

  • SetTreeID(explicitID: Standard_GUID): void
    Parameters (1)
    • explicitID
  • SetFather(F: TDataStd_TreeNode): void
    Parameters (1)
    • F
  • SetNext(F: TDataStd_TreeNode): void
    Parameters (1)
    • F
  • SetPrevious(F: TDataStd_TreeNode): void
    Parameters (1)
    • F
  • SetFirst(F: TDataStd_TreeNode): void
    Parameters (1)
    • F
  • SetLast(F: TDataStd_TreeNode): void

    TreeNode callback:

    Parameters (1)
    • F
  • AfterAddition(): void

    Connect the TreeNode to its father child list.

  • BeforeForget(): void

    Disconnect the TreeNode from its Father child list.

  • AfterResume(): void

    Reconnect the TreeNode to its father child list.

  • BeforeUndo(anAttDelta: TDF_AttributeDelta, forceIt?: boolean): boolean

    Disconnect the TreeNode, if necessary.

    Parameters (2)
    • anAttDelta
    • forceIt
  • AfterUndo(anAttDelta: TDF_AttributeDelta, forceIt?: boolean): boolean

    Reconnect the TreeNode, if necessary.
    Implementation of Attribute methods:

    Parameters (2)
    • anAttDelta
    • forceIt
  • ID(): Standard_GUID

    Returns the tree ID (default or explicit one depending on the Set method used).

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • References(aDataSet: TDF_DataSet): void

    Adds the first level referenced attributes and labels to <aDataSet>.
    For this, use the AddLabel or AddAttribute of DataSet.
    If there is none, do not implement the method.

    Parameters (1)
    • aDataSet
  • DynamicType(): Standard_Type

TDataStd_UAttribute

TDF_AttributeStandard_Transient

Constructors(1)

Static methods(3)

Instance methods(8)

  • SetID(argNo0: Standard_GUID): void

    Sets specific ID of the attribute (supports several attributes of one type at the same label feature).

    Parameters (1)
    • argNo0
  • SetID(): void

    Sets specific ID of the attribute (supports several attributes of one type at the same label feature).

  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • References(aDataSet: TDF_DataSet): void

    Adds the first level referenced attributes and labels to <aDataSet>.
    For this, use the AddLabel or AddAttribute of DataSet.
    If there is none, do not implement the method.

    Parameters (1)
    • aDataSet
  • DynamicType(): Standard_Type

TDataStd_Variable

TDF_AttributeStandard_Transient

Variable attribute.

  • A variable is associated to a TDataStd_Real (which contains its current value) and a TDataStd_Name attribute (which contains its name). It contains a constant flag, and a Unit
  • An expression may be assigned to a variable. In thatcase the expression is handled by the associated Expression Attribute and the Variable returns True to the method <IsAssigned>.

Constructors(1)

Static methods(4)

Instance methods(22)

  • Set(value: number): void

    retrieve or create the associated real attribute and set the value .

    Parameters (1)
    • value
  • Set(value: number, dimension: TDataStd_RealEnum): void

    Find, or create, a Variable attribute.
    Real methods

    Parameters (2)
    • value
    • dimension
  • Name(string_: TCollection_ExtendedString): void

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

    Parameters (1)
    • string_
  • Name(): TCollection_ExtendedString

    returns string stored in the associated Name attribute.

  • IsValued(): boolean

    returns True if a Real attribute is associated.

  • Get(): number

    returns value stored in associated Real attribute.

  • Real(): TDataStd_Real

    returns associated Real attribute.

  • IsAssigned(): boolean

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

  • Assign(): TDataStd_Expression

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

  • Desassign(): void

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

  • Expression(): TDataStd_Expression

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

  • IsCaptured(): boolean

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

  • IsConstant(): boolean

    A constant value is not modified by regeneration.

  • Unit(unit: TCollection_AsciiString): void
    Parameters (1)
    • unit
  • Unit(): TCollection_AsciiString

    to read/write fields

  • Constant(status: boolean): void

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

    Parameters (1)
    • status
  • ID(): Standard_GUID

    Returns the ID of the attribute.

  • Restore(anAttribute: TDF_Attribute): void

    Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

    Parameters (1)
    • anAttribute
  • NewEmpty(): TDF_Attribute

    Returns an new empty attribute from the good end type. It is used by the copy algorithm.

  • Paste(intoAttribute: TDF_Attribute, aRelocationTable: TDF_RelocationTable): void

    This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    The given pasted attribute can be full or empty of its contents. But don't make a NEW! Just set the contents!
    It is possible to use <aRelocationTable> to get/set the relocation value of a source attribute.

    Parameters (2)
    • intoAttribute
    • aRelocationTable
  • References(aDataSet: TDF_DataSet): void

    to export reference to the associated Name attribute.

    Parameters (1)
    • aDataSet
  • DynamicType(): Standard_Type

AppStdL

OCCT package AppStdL: AppStdL_Application.

TDF

OCCT package TDF: TDF, TDF_Attribute, TDF_AttributeDelta, TDF_AttributeIterator, and 24 more bound classes.