OpenCascade.js
API ReferenceDataExchangeTKDEIGES

IGESDefs

OCCT package IGESDefs: IGESDefs, IGESDefs_AssociativityDef, IGESDefs_AttributeDef, IGESDefs_AttributeTable, and 16 more bound classes.

IGESDefs_AssociativityDef

IGESData_IGESEntityStandard_Transient

defines IGES Associativity Definition Entity, Type <302> Form <5001 - 9999> in package IGESDefs. This class permits the preprocessor to define an associativity schema. i.e., by using it preprocessor defines the type of relationship.

Constructors(1)

Static methods(2)

Instance methods(10)

  • Init(requirements: NCollection_HArray1_int, orders: NCollection_HArray1_int, numItems: NCollection_HArray1_int, items: IGESBasic_HArray1OfHArray1OfInteger): void

    This method is used to set the fields of the class AssociativityDef.

    • requirements : Back Pointers requirements
    • orders : Class Orders
    • numItems : Number of Items per Class
    • items : Items in each class raises exception if lengths of the arrays are not the same.
    Parameters (4)
    • requirements
    • orders
    • numItems
    • items
  • SetFormNumber(form: number): void
    Parameters (1)
    • form
  • NbClassDefs(): number

    returns the Number of class definitions

  • IsBackPointerReq(ClassNum: number): boolean

    returns 1 if the theBackPointerReqs(ClassNum) = 1 returns 0 if the theBackPointerReqs(ClassNum) = 2 raises exception if ClassNum <= 0 or ClassNum > NbClassDefs()

    Parameters (1)
    • ClassNum
  • BackPointerReq(ClassNum: number): number

    returns 1 or 2 raises exception if ClassNum <= 0 or ClassNum > NbClassDefs()

    Parameters (1)
    • ClassNum
  • IsOrdered(ClassNum: number): boolean

    returns 1 if theClassOrders(ClassNum) = 1 (ordered class) returns 0 if theClassOrders(ClassNum) = 2 (unordered class) raises exception if ClassNum <= 0 or ClassNum > NbClassDefs()

    Parameters (1)
    • ClassNum
  • ClassOrder(ClassNum: number): number

    returns 1 or 2 raises exception if ClassNum <= 0 or ClassNum > NbClassDefs()

    Parameters (1)
    • ClassNum
  • NbItemsPerClass(ClassNum: number): number

    returns no. of items per class entry raises exception if ClassNum <= 0 or ClassNum > NbClassDefs()

    Parameters (1)
    • ClassNum
  • Item(ClassNum: number, ItemNum: number): number

    returns ItemNum'th Item of ClassNum'th Class raises exception if ClassNum <= 0 or ClassNum > NbClassDefs() ItemNum <= 0 or ItemNum > NbItemsPerClass(ClassNum)

    Parameters (2)
    • ClassNum
    • ItemNum
  • DynamicType(): Standard_Type

IGESDefs_AttributeDef

IGESData_IGESEntityStandard_Transient

defines IGES Attribute Table Definition Entity, Type <322> Form [0, 1, 2] in package IGESDefs. This is class is used to support the concept of well defined collection of attributes, whether it is a table or a single row of attributes.

Constructors(1)

Static methods(2)

Instance methods(18)

  • Init(aName: TCollection_HAsciiString, aListType: number, attrTypes: NCollection_HArray1_int, attrValueDataTypes: NCollection_HArray1_int, attrValueCounts: NCollection_HArray1_int, attrValues: NCollection_HArray1_handle_Standard_Transient, attrValuePointers: IGESDefs_HArray1OfHArray1OfTextDisplayTemplate): void
    Parameters (7)
    • aName
    • aListType
    • attrTypes
    • attrValueDataTypes
    • attrValueCounts
    • attrValues
    • attrValuePointers
  • HasTableName(): boolean

    Returns True if a Table Name is defined.

  • TableName(): TCollection_HAsciiString

    returns the Attribute Table name, or comment (default = null, no name : seeHasTableName)

  • ListType(): number

    returns the Attribute List Type

  • NbAttributes(): number

    returns the Number of Attributes

  • AttributeType(num: number): number

    returns the num'th Attribute Type raises exception if num <= 0 or num > NbAttributes()

    Parameters (1)
    • num
  • AttributeValueDataType(num: number): number

    returns the num'th Attribute value data type raises exception if num <= 0 or num > NbAttributes()

    Parameters (1)
    • num
  • AttributeValueCount(num: number): number

    returns the num'th Attribute value count raises exception if num <= 0 or num > NbAttributes()

    Parameters (1)
    • num
  • HasValues(): boolean

    returns false if Values are defined (i.e. for Form = 1 or 2)

  • HasTextDisplay(): boolean

    returns false if TextDisplays are defined (i.e. for Form = 2)

  • AttributeTextDisplay(AttrNum: number, PointerNum: number): IGESGraph_TextDisplayTemplate
    Parameters (2)
    • AttrNum
    • PointerNum
  • AttributeList(AttrNum: number): Standard_Transient

    Returns the List of Attributes <AttrNum>, as a Transient. Its effective Type depends of the Type of Attribute : HArray1OfInteger for Integer, Logical(0-1), HArray1OfReal for Real, HArray1OfHSaciiString for String, HArray1OfIGESEntity for Entity (Pointer) See methods AttributeAs... for an accurate access.

    Parameters (1)
    • AttrNum
  • AttributeAsInteger(AttrNum: number, ValueNum: number): number

    Returns Attribute Value <AttrNum, rank ValueNum> as an Integer Error if Indices out of Range, or no Value defined, or not an Integer.

    Parameters (2)
    • AttrNum
    • ValueNum
  • AttributeAsReal(AttrNum: number, ValueNum: number): number

    Returns Attribute Value <AttrNum, rank ValueNum> as a Real Error if Indices out of Range, or no Value defined, or not a Real.

    Parameters (2)
    • AttrNum
    • ValueNum
  • AttributeAsString(AttrNum: number, ValueNum: number): TCollection_HAsciiString

    Returns Attribute Value <AttrNum, rank ValueNum> as an Integer.

    Parameters (2)
    • AttrNum
    • ValueNum
  • AttributeAsEntity(AttrNum: number, ValueNum: number): IGESData_IGESEntity

    Returns Attribute Value <AttrNum, rank ValueNum> as an Entity Error if Indices out of Range, or no Value defined, or not a Entity.

    Parameters (2)
    • AttrNum
    • ValueNum
  • AttributeAsLogical(AttrNum: number, ValueNum: number): boolean

    Returns Attribute Value <AttrNum, rank ValueNum> as a Boolean Error if Indices out of Range, or no Value defined, or not a Logical.

    Parameters (2)
    • AttrNum
    • ValueNum
  • DynamicType(): Standard_Type

IGESDefs_AttributeTable

IGESData_IGESEntityStandard_Transient

defines IGES Attribute Table, Type <422> Form <0, 1> in package IGESDefs This class is used to represent an occurrence of Attribute Table. This Class may be independent or dependent or pointed at by other Entities.

Constructors(1)

Static methods(2)

Instance methods(14)

  • Init(attributes: NCollection_HArray2_handle_Standard_Transient): void

    This method is used to set the fields of the class AttributeTable.

    • attributes : Attribute instances, created as (1,NbAttributes,1,NbRows)
    • NbRows = 1 is a particular case (Form 0)
    Parameters (1)
    • attributes
  • SetDefinition(def: IGESDefs_AttributeDef): void

    Sets a Definition as Structure information (works by calling InitMisc).

    Parameters (1)
    • def
  • Definition(): IGESDefs_AttributeDef

    Return the Structure information in Directory Entry, casted as an AttributeDef.

  • NbRows(): number

    returns Number of Rows. Remark that it is always 1 if Form = 0 It means that the list of Attributes (by their number, and for each one its type and ValueCount) is repeated <NbRows> times

  • NbAttributes(): number

    returns Number of Attributes

  • DataType(Atnum: number): number

    returns the Type of an Attribute, given its No. : it is read in the Definition. (1 : Integer, 2 : Real, 3 : String, 4 : Entity, 6 : Logical)

    Parameters (1)
    • Atnum
  • ValueCount(Atnum: number): number

    returns the Count of Value for an Attribute, given its No. : it is read in the Definition.

    Parameters (1)
    • Atnum
  • AttributeList(Attribnum: number, Rownum: number): Standard_Transient
    Parameters (2)
    • Attribnum
    • Rownum
  • AttributeAsInteger(AtNum: number, Rownum: number, ValNum: number): number

    Returns Attribute Value <AtNum, Rownum, rank ValNum> as an Integer Error if Indices out of Range, or no Value defined, or not an Integer.

    Parameters (3)
    • AtNum
    • Rownum
    • ValNum
  • AttributeAsReal(AtNum: number, Rownum: number, ValNum: number): number

    Returns Attribute Value <AtNum, Rownum, rank ValNum> as a Real Error if Indices out of Range, or no Value defined, or not a Real.

    Parameters (3)
    • AtNum
    • Rownum
    • ValNum
  • AttributeAsString(AtNum: number, Rownum: number, ValNum: number): TCollection_HAsciiString

    Returns Attribute Value <AtNum, Rownum, rank ValNum> as an Integer.

    Parameters (3)
    • AtNum
    • Rownum
    • ValNum
  • AttributeAsEntity(AtNum: number, Rownum: number, ValNum: number): IGESData_IGESEntity

    Returns Attribute Value <AtNum, Rownum, rank ValNum> as an Entity Error if Indices out of Range, or no Value defined, or not an Entity.

    Parameters (3)
    • AtNum
    • Rownum
    • ValNum
  • AttributeAsLogical(AtNum: number, Rownum: number, ValNum: number): boolean

    Returns Attribute Value <AtNum, Rownum, rank ValNum> as a Boolean Error if Indices out of Range, or no Value defined, or not a Logical.

    Parameters (3)
    • AtNum
    • Rownum
    • ValNum
  • DynamicType(): Standard_Type

IGESDefs_GeneralModule

IGESData_GeneralModuleInterface_GeneralModuleStandard_Transient

Definition of General Services for IGESDefs (specific part) This Services comprise : Shared & Implied Lists, Copy, Check.

Constructors(1)

Static methods(2)

Instance methods(6)

IGESDefs_GenericData

IGESData_IGESEntityStandard_Transient

defines IGES Generic Data, Type <406> Form <27> in package IGESDefs Used to communicate information defined by the system operator while creating the model. The information is system specific and does not map into one of the predefined properties or associativities. Properties and property values can be defined by multiple instances of this property.

Constructors(1)

Static methods(2)

Instance methods(12)

  • Init(nbPropVal: number, aName: TCollection_HAsciiString, allTypes: NCollection_HArray1_int, allValues: NCollection_HArray1_handle_Standard_Transient): void

    This method is used to set the fields of the class GenericData.

    • nbPropVal : Number of property values
    • aName : Property Name
    • allTypes : Property Types
    • allValues : Property Values
    Parameters (4)
    • nbPropVal
    • aName
    • allTypes
    • allValues
  • NbPropertyValues(): number

    returns the number of property values

  • Name(): TCollection_HAsciiString

    returns property name

  • NbTypeValuePairs(): number

    returns the number of TYPE/VALUE pairs

  • Type(Index: number): number

    returns the Index'th property value data type raises exception if Index <= 0 or Index > NbTypeValuePairs()

    Parameters (1)
    • Index
  • Value(Index: number): Standard_Transient

    HArray1OfInteger (length 1), HArray1OfReal (length 1) for Integer, Real, Boolean (= Integer 0/1), HAsciiString for String (the value itself), IGESEntity for Entity (the value itself).

    Parameters (1)
    • Index
  • ValueAsInteger(ValueNum: number): number

    Returns Attribute Value <AttrNum, rank ValueNum> as an Integer Error if Index out of Range, or not an Integer.

    Parameters (1)
    • ValueNum
  • ValueAsReal(ValueNum: number): number

    Returns Attribute Value <AttrNum, rank ValueNum> as a Real Error if Index out of Range, or not a Real.

    Parameters (1)
    • ValueNum
  • ValueAsString(ValueNum: number): TCollection_HAsciiString

    Returns Attribute Value <AttrNum, rank ValueNum> as an Integer.

    Parameters (1)
    • ValueNum
  • ValueAsEntity(ValueNum: number): IGESData_IGESEntity

    Returns Attribute Value <AttrNum, rank ValueNum> as an Entity Error if Index out of Range, or not a Entity.

    Parameters (1)
    • ValueNum
  • ValueAsLogical(ValueNum: number): boolean

    Returns Attribute Value <AttrNum, rank ValueNum> as a Boolean Error if Index out of Range, or not a Logical.

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

IGESDefs_HArray1OfHArray1OfTextDisplayTemplate

Standard_Transient

Constructors(1)

Static methods(2)

Instance methods(6)

IGESDefs_MacroDef

IGESData_IGESEntityStandard_Transient

defines IGES Macro Definition Entity, Type <306> Form <0> in package IGESDefs This Class specifies the action of a specific MACRO. After specification MACRO can be used as necessary by means of MACRO class instance entity.

Constructors(1)

Static methods(2)

Instance methods(7)

IGESDefs_Protocol

IGESData_ProtocolInterface_ProtocolStandard_Transient

Description of Protocol for IGESDefs.

Constructors(1)

Static methods(2)

Instance methods(4)

  • NbResources(): number

    Gives the count of Resource Protocol. Here, one (Protocol from IGESGraph).

  • Resource(num: number): Interface_Protocol

    Returns a Resource, given a rank.

    Parameters (1)
    • num
  • TypeNumber(atype: Standard_Type): number

    Returns a Case Number, specific of each recognized Type This Case Number is then used in Libraries : the various Modules attached to this class of Protocol must use them in accordance (for a given value of TypeNumber, they must consider the same Type as the Protocol defines).

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

IGESDefs_ReadWriteModule

IGESData_ReadWriteModuleInterface_ReaderModuleStandard_Transient

Defines Defs File Access Module for IGESDefs (specific parts) Specific actions concern : Read and Write Own Parameters of an IGESEntity.

Constructors(1)

Static methods(2)

Instance methods(2)

IGESDefs_TabularData

IGESData_IGESEntityStandard_Transient

Defines IGES Tabular Data, Type <406> Form <11>, in package IGESDefs This Class is used to provide a Structure to accommodate point form data.

Constructors(1)

Static methods(2)

Instance methods(13)

  • Init(nbProps: number, propType: number, typesInd: NCollection_HArray1_int, nbValuesInd: NCollection_HArray1_int, valuesInd: IGESBasic_HArray1OfHArray1OfReal, valuesDep: IGESBasic_HArray1OfHArray1OfReal): void

    This method is used to set the fields of the class TabularData.

    • nbProps : Number of property values
    • propType : Property Type
    • typesInd : Type of independent variables
    • nbValuesInd : Number of values of independent variables
    • valuesInd : Values of independent variables
    • valuesDep : Values of dependent variables raises exception if lengths of typeInd and nbValuesInd are not same
    Parameters (6)
    • nbProps
    • propType
    • typesInd
    • nbValuesInd
    • valuesInd
    • valuesDep
  • NbPropertyValues(): number

    returns the number of property values (recorded)

  • ComputedNbPropertyValues(): number

    determines the number of property values required

  • OwnCorrect(): boolean

    checks, and correct as necessary, the number of property values. Returns True if corrected, False if already OK

  • PropertyType(): number

    returns the property type

  • NbDependents(): number

    returns the number of dependent variables

  • NbIndependents(): number

    returns the number of independent variables

  • TypeOfIndependents(num: number): number

    returns the type of the num'th independent variable raises exception if num <= 0 or num > NbIndependents()

    Parameters (1)
    • num
  • NbValues(num: number): number

    returns the number of different values of the num'th indep. variable raises exception if num <= 0 or num > NbIndependents()

    Parameters (1)
    • num
  • IndependentValue(variablenum: number, valuenum: number): number
    Parameters (2)
    • variablenum
    • valuenum
  • DependentValues(num: number): NCollection_HArray1_double
    Parameters (1)
    • num
  • DependentValue(variablenum: number, valuenum: number): number
    Parameters (2)
    • variablenum
    • valuenum
  • DynamicType(): Standard_Type

IGESDefs_ToolAssociativityDef

Tool to work on a AssociativityDef. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(3)

IGESDefs_ToolAttributeDef

Tool to work on a AttributeDef. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(3)

IGESDefs_ToolAttributeTable

Tool to work on a AttributeTable. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(3)

IGESDefs_ToolGenericData

Tool to work on a GenericData. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(3)

IGESDefs_ToolMacroDef

Tool to work on a MacroDef. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(3)

IGESDefs_ToolTabularData

Tool to work on a TabularData. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(3)

IGESDefs_ToolUnitsData

Tool to work on a UnitsData. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(3)

IGESDefs_UnitsData

IGESData_IGESEntityStandard_Transient

defines IGES UnitsData Entity, Type <316> Form <0> in package IGESDefs This class stores data about a model's fundamental units.

Constructors(1)

Static methods(2)

Instance methods(6)

IGESData

OCCT package IGESData: IGESData, IGESData_BasicEditor, IGESData_ColorEntity, IGESData_DefaultGeneral, and 37 more bound classes.

IGESDimen

OCCT package IGESDimen: IGESDimen, IGESDimen_AngularDimension, IGESDimen_BasicDimension, IGESDimen_CenterLine, and 47 more bound classes.