OpenCascade.js
API ReferenceDataExchangeTKDEIGES

IGESAppli

OCCT package IGESAppli: IGESAppli, IGESAppli_DrilledHole, IGESAppli_ElementResults, IGESAppli_FiniteElement, and 39 more bound classes.

IGESAppli_DrilledHole

defines DrilledHole, Type <406> Form <6> in package IGESAppli Identifies an entity representing a drilled hole through a printed circuit board.

Constructors(1)

Static methods(2)

Instance methods(8)

  • Init(nbPropVal: number, aSize: number, anotherSize: number, aPlating: number, aLayer: number, anotherLayer: number): void

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

    • nbPropVal : Number of property values = 5
    • aSize : Drill diameter size
    • anotherSize : Finish diameter size
    • aPlating : Plating indication flag False = not plating True = is plating
    • aLayer : Lower numbered layer
    • anotherLayer : Higher numbered layer
    Parameters (6)
    • nbPropVal
    • aSize
    • anotherSize
    • aPlating
    • aLayer
    • anotherLayer
  • is always 5

  • DrillDiaSize(): number

    returns the drill diameter size

  • FinishDiaSize(): number

    returns the finish diameter size

  • IsPlating(): boolean

    Returns Plating Status: False = not plating / True = is plating.

  • NbLowerLayer(): number

    returns the lower numbered layer

  • NbHigherLayer(): number

    returns the higher numbered layer

IGESAppli_ElementResults

defines ElementResults, Type <148> in package IGESAppli Used to find the results of FEM analysis

Constructors(1)

Static methods(2)

Instance methods(21)

  • Init(aNote: IGESDimen_GeneralNote, aSubCase: number, aTime: number, nbResults: number, aResRepFlag: number, allElementIdents: NCollection_HArray1_int, allFiniteElems: NCollection_HArray1_handle_IGESAppli_FiniteElement, allTopTypes: NCollection_HArray1_int, nbLayers: NCollection_HArray1_int, allDataLayerFlags: NCollection_HArray1_int, allnbResDataLocs: NCollection_HArray1_int, allResDataLocs: IGESBasic_HArray1OfHArray1OfInteger, allResults: IGESBasic_HArray1OfHArray1OfReal): void

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

    • aNote : GeneralNote Entity describing analysis
    • aSubCase : Analysis Subcase number
    • aTime : Analysis time value
    • nbResults : Number of result values per FEM
    • aResRepFlag : Results Reporting Flag
    • allElementIdents : FEM element number for elements
    • allFiniteElems : FEM element
    • allTopTypes : Element Topology Types
    • nbLayers : Number of layers per result data location
    • allDataLayerFlags : Data Layer Flags
    • allnbResDataLocs : Number of result data report locations
    • allResDataLocs : Result Data Report Locations
    • allResults : List of Result data values of FEM analysis
    Parameters (13)
    • aNote
    • aSubCase
    • aTime
    • nbResults
    • aResRepFlag
    • allElementIdents
    • allFiniteElems
    • allTopTypes
    • nbLayers
    • allDataLayerFlags
    • allnbResDataLocs
    • allResDataLocs
    • allResults
  • SetFormNumber(form: number): void

    Changes the FormNumber (which indicates Type of Result) Error if not in range [0-34].

    Parameters (1)
    • form
  • returns General Note Entity describing analysis case

  • SubCaseNumber(): number

    returns analysis Subcase number

  • Time(): number

    returns analysis time value

  • NbResultValues(): number

    returns number of result values per FEM

  • returns Results Reporting Flag

  • NbElements(): number

    returns number of FEM elements

  • ElementIdentifier(Index: number): number

    returns FEM element number for elements

    Parameters (1)
    • Index
  • returns FEM element

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

    returns element Topology Types

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

    returns number of layers per result data location

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

    returns Data Layer Flags

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

    returns number of result data report locations

    Parameters (1)
    • Index
  • ResultDataLoc(NElem: number, NLoc: number): number

    returns Result Data Report Locations UNFINISHED

    Parameters (2)
    • NElem
    • NLoc
  • NbResults(Index: number): number

    returns total number of results

    Parameters (1)
    • Index
  • ResultData(NElem: number, num: number): number

    returns Result data value for an Element, given its order between 1 and <NbResults(NElem)> (direct access) For a more comprehensive access, see below

    Parameters (2)
    • NElem
    • num
  • ResultData(NElem: number, NVal: number, NLay: number, NLoc: number): number

    returns Result data values of FEM analysis, according this definition :

    • <NElem> : n0 of the Element to be considered
    • <NVal> : n0 of the Value between 1 and NbResultValues
    • <NLay> : n0 of the Layer for this Element
    • <NLoc> : n0 of the Data Location for this Element This gives for each Element, the corresponding rank computed by ResultRank, in which the leftmost subscript changes most rapidly
    Parameters (4)
    • NElem
    • NVal
    • NLay
    • NLoc
  • ResultRank(NElem: number, NVal: number, NLay: number, NLoc: number): number

    Computes, for a given Element <NElem>, the rank of a individual Result Data, given <NVal>,<NLay>,<NLoc>.

    Parameters (4)
    • NElem
    • NVal
    • NLay
    • NLoc
  • Returns in once the entire list of data for an Element, addressed as by ResultRank (See above).

    Parameters (1)
    • NElem

IGESAppli_FiniteElement

defines FiniteElement, Type <136> Form <0> in package IGESAppli Used to define a finite element with the help of an element topology.

Constructors(1)

Static methods(2)

Instance methods(6)

IGESAppli_Flow

defines Flow, Type <402> Form <18> in package IGESAppli Represents a single signal or a single fluid flow path starting from a starting Connect Point Entity and including additional intermediate connect points.

Constructors(1)

Static methods(2)

Instance methods(18)

IGESAppli_FlowLineSpec

defines FlowLineSpec, Type <406> Form <14> in package IGESAppli Attaches one or more text strings to entities being used to represent a flow line

Constructors(1)

Static methods(2)

Instance methods(5)

IGESAppli_GeneralModule

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

Constructors(1)

Static methods(2)

Instance methods(6)

  • Returns a DirChecker, specific for each type of Entity (identified by its Case Number) : this DirChecker defines constraints which must be respected by the DirectoryPart.

    Parameters (2)
    • CN
    • ent
  • OwnCheckCase(CN: number, ent: IGESData_IGESEntity, shares: Interface_ShareTool): { ach: Interface_Check; [Symbol.dispose](): void }

    Performs Specific Semantic Check for each type of Entity.

    Parameters (3)
    • CN
    • ent
    • shares
    Returns

    A result object with fields:

    • ach: owned by the returned envelope.
      Dispose the returned envelope to release owned Handle fields.
  • NewVoid(CN: number): { returnValue: boolean; entto: Standard_Transient; [Symbol.dispose](): void }

    Specific creation of a new void entity.

    Parameters (1)
    • CN
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • entto: owned by the returned envelope.
      Dispose the returned envelope to release owned Handle fields.
  • Copies parameters which are specific of each Type of Entity.

    Parameters (4)
    • CN
    • entfrom
    • entto
    • TC
  • CategoryNumber(CN: number, ent: Standard_Transient, shares: Interface_ShareTool): number

    Returns a category number which characterizes an entity FEA for : ElementResults,FiniteElement,Node&Co Piping for : Flow & Co Professional for : others (in fact Schematics).

    Parameters (3)
    • CN
    • ent
    • shares

IGESAppli_LevelFunction

defines LevelFunction, Type <406> Form <3> in package IGESAppli Used to transfer the meaning or intended use of a level in the sending system

Constructors(1)

Static methods(2)

Instance methods(5)

IGESAppli_LevelToPWBLayerMap

defines LevelToPWBLayerMap, Type <406> Form <24> in package IGESAppli Used to correlate an exchange file level number with its corresponding native level identifier, physical PWB layer number and predefined functional level identification

Constructors(1)

Static methods(2)

Instance methods(8)

IGESAppli_LineWidening

defines LineWidening, Type <406> Form <5> in package IGESAppli Defines the characteristics of entities when they are used to define locations of items.

Constructors(1)

Static methods(2)

Instance methods(8)

  • Init(nbPropVal: number, aWidth: number, aCornering: number, aExtnFlag: number, aJustifFlag: number, aExtnVal: number): void

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

    • nbPropVal : Number of property values = 5
    • aWidth : Width of metalization
    • aCornering : Cornering codes 0 = rounded 1 = squared
    • aExtnFlag : Extension Flag 0 = No Extension 1 = One-half width extension 2 = Extn set by ExtnVal
    • aJustifFlag : Justification flag 0 = Center justified 1 = left justified 2 = right justified
    • aExtnVal : Extension value if aExtnFlag = 2
    Parameters (6)
    • nbPropVal
    • aWidth
    • aCornering
    • aExtnFlag
    • aJustifFlag
    • aExtnVal
  • returns the number of property values is always 5

  • returns the width of metallization

  • CorneringCode(): number

    returns the cornering code 0 = Rounded / 1 = Squared

  • ExtensionFlag(): number

    returns the extension flag 0 = No extension 1 = One-half width extension 2 = Extension set by theExtnVal

  • returns the justification flag 0 = Centre justified 1 = Left justified 2 = Right justified

  • ExtensionValue(): number

    returns the Extension Value Present only if theExtnFlag = 2

IGESAppli_NodalConstraint

defines NodalConstraint, Type <418> Form <0> in package IGESAppli Relates loads and/or constraints to specific nodes in the Finite Element Model by creating a relation between Node entities and Tabular Data Property that contains the load or constraint data

Constructors(1)

Static methods(2)

Instance methods(6)

IGESAppli_NodalDisplAndRot

defines NodalDisplAndRot, Type <138> Form <0> in package IGESAppli Used to communicate finite element post processing data.

Constructors(1)

Static methods(2)

Instance methods(9)

  • This method is used to set the fields of the class NodalDisplAndRot.

    • allNotes : Used to store the general note describing the analysis cases
    • allIdentifiers : Used to store the node number identifier for the nodes
    • allNodes : Used to store the nodes
    • allRotParams : Used to store the rotation for the nodes
    • allTransParams : Used to store the incremental displacements for the nodes raises exception if Lengths of allIdentifiers, allNodes, allRotParams, and allTransParams are not same or if length of allNotes and size of each element of allRotParams and allTransParam are not same
    Parameters (5)
    • allNotes
    • allIdentifiers
    • allNodes
    • allRotParams
    • allTransParams
  • NbCases(): number

    returns the number of analysis cases

  • NbNodes(): number

    returns the number of nodes

  • Note(Index: number): IGESDimen_GeneralNote

    returns the General Note that describes the Index analysis case raises exception if Index <= 0 or Index > NbCases

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

    returns the node identifier as specified by the Index raises exception if Index <= 0 or Index > NbNodes

    Parameters (1)
    • Index
  • Node(Index: number): IGESAppli_Node

    returns the node as specified by the Index raises exception if Index <= 0 or Index > NbNodes

    Parameters (1)
    • Index
  • TranslationParameter(NodeNum: number, CaseNum: number): gp_XYZ

    returns the Translational Parameters for the particular Index Exception raised if NodeNum <= 0 or NodeNum > NbNodes() or CaseNum <= 0 or CaseNum > NbCases()

    Parameters (2)
    • NodeNum
    • CaseNum
  • RotationalParameter(NodeNum: number, CaseNum: number): gp_XYZ

    returns the Rotational Parameters for Index Exception raised if NodeNum <= 0 or NodeNum > NbNodes() or CaseNum <= 0 or CaseNum > NbCases()

    Parameters (2)
    • NodeNum
    • CaseNum

IGESAppli_NodalResults

defines NodalResults, Type <146> in package IGESAppli Used to store the Analysis Data results per FEM Node

Constructors(1)

Static methods(2)

Instance methods(11)

  • Init(aNote: IGESDimen_GeneralNote, aNumber: number, aTime: number, allNodeIdentifiers: NCollection_HArray1_int, allNodes: NCollection_HArray1_handle_IGESAppli_Node, allData: NCollection_HArray2_double): void

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

    • aNote : General Note that describes the analysis case
    • aNumber : Analysis Subcase number
    • aTime : Analysis time
    • allNodeIdentifiers : Node identifiers for the nodes
    • allNodes : List of FEM Node Entities
    • allData : Values of the Finite Element analysis result data raises exception if Lengths of allNodeIdentifiers, allNodes and allData (Cols) are not same
    Parameters (6)
    • aNote
    • aNumber
    • aTime
    • allNodeIdentifiers
    • allNodes
    • allData
  • SetFormNumber(form: number): void

    Changes the FormNumber (which indicates Type of Result) Error if not in range [0-34].

    Parameters (1)
    • form
  • returns the General Note Entity that describes the analysis case

  • SubCaseNumber(): number

    returns zero if there is no subcase

  • Time(): number

    returns the Analysis time value for this subcase. It is the time at which transient analysis results occur in the mathematical FEM model.

  • NbData(): number

    returns number of real values in array V for a FEM node

  • NbNodes(): number

    returns number of FEM nodes for which data is to be read.

  • NodeIdentifier(Index: number): number

    returns FEM node number identifier for the (Index)th node raises exception if Index <= 0 or Index > NbNodes

    Parameters (1)
    • Index
  • Node(Index: number): IGESAppli_Node

    returns the node as specified by the Index raises exception if Index <= 0 or Index > NbNodes

    Parameters (1)
    • Index
  • Data(NodeNum: number, DataNum: number): number

    returns the finite element analysis result value raises exception if (NodeNum <= 0 or NodeNum > NbNodes()) or if (DataNum <=0 or DataNum > NbData())

    Parameters (2)
    • NodeNum
    • DataNum

IGESAppli_Node

defines Node, Type <134> Form <0> in package IGESAppli Geometric point used in the definition of a finite element.

Constructors(1)

Static methods(2)

Instance methods(6)

  • Init(aCoord: gp_XYZ, aCoordSystem: IGESGeom_TransformationMatrix): void

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

    • aCoord : Nodal Coordinates
    • aCoordSystem : the Nodal Displacement Coordinate System Entity (default 0 is Global Cartesian Coordinate system)
    Parameters (2)
    • aCoord
    • aCoordSystem
  • returns the nodal coordinates

  • returns TransfEntity if a Nodal Displacement Coordinate System Entity is defined else (for Global Cartesien) returns Null Handle

  • SystemType(): number

    Computes & returns the Type of Coordinate System : 0 GlobalCartesian, 1 Cartesian, 2 Cylindrical, 3 Spherical.

  • returns the Nodal coordinates after transformation

IGESAppli_PartNumber

defines PartNumber, Type <406> Form <9> in package IGESAppli Attaches a set of text strings that define the common part numbers to an entity being used to represent a physical component

Constructors(1)

Static methods(2)

Instance methods(7)

IGESAppli_PinNumber

defines PinNumber, Type <406> Form <8> in package IGESAppli Used to attach a text string representing a component pin number to an entity being used to represent an electrical component's pin

Constructors(1)

Static methods(2)

Instance methods(4)

IGESAppli_PipingFlow

defines PipingFlow, Type <402> Form <20> in package IGESAppli Represents a single fluid flow path

Constructors(1)

Static methods(2)

Instance methods(17)

IGESAppli_Protocol

Description of Protocol for IGESAppli.

Constructors(1)

Static methods(2)

Instance methods(4)

  • NbResources(): number

    Gives the count of direct Resource Protocol. Here, two (Protocols from IGESDefs and IGESDraw).

  • 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

IGESAppli_PWBArtworkStackup

defines PWBArtworkStackup, Type <406> Form <25> in package IGESAppli Used to communicate which exchange file levels are to be combined in order to create the artwork for a printed wire board (PWB). This property should be attached to the entity defining the printed wire assembly (PWA) or if no such entity exists, then the property should stand alone in the file.

Constructors(1)

Static methods(2)

Instance methods(6)

IGESAppli_PWBDrilledHole

defines PWBDrilledHole, Type <406> Form <26> in package IGESAppli Used to identify an entity that locates a drilled hole and to specify the characteristics of the drilled hole

Constructors(1)

Static methods(2)

Instance methods(6)

  • Init(nbPropVal: number, aDrillDia: number, aFinishDia: number, aCode: number): void

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

    • nbPropVal : number of property values, always = 3
    • aDrillDia : Drill diameter size
    • aFinishDia : Finish diameter size
    • aCode : Function code for drilled hole
    Parameters (4)
    • nbPropVal
    • aDrillDia
    • aFinishDia
    • aCode
  • returns number of property values, always = 3

  • returns Drill diameter size

  • returns Finish diameter size

  • FunctionCode(): number

    returns Function code for drilled hole is 0, 1, 2, 3, 4, 5 or 5001-9999

IGESAppli_ReadWriteModule

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

Constructors(1)

Static methods(2)

Instance methods(2)

IGESAppli_ReferenceDesignator

defines ReferenceDesignator, Type <406> Form <7> in package IGESAppli Used to attach a text string containing the value of a component reference designator to an entity being used to represent a component.

Constructors(1)

Static methods(2)

Instance methods(4)

IGESAppli_RegionRestriction

defines RegionRestriction, Type <406> Form <2> in package IGESAppli Defines regions to set an application's restriction over a region.

Constructors(1)

Static methods(2)

Instance methods(6)

  • Init(nbPropVal: number, aViasRest: number, aCompoRest: number, aCktRest: number): void

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

    • nbPropVal : Number of property values, always = 3
    • aViasRest : Electrical Vias restriction
    • aCompoRest : Electrical components restriction
    • aCktRest : Electrical circuitry restriction
    Parameters (4)
    • nbPropVal
    • aViasRest
    • aCompoRest
    • aCktRest
  • is always 3

  • returns the Electrical vias restriction is 0, 1 or 2

  • returns the Electrical components restriction is 0, 1 or 2

  • returns the Electrical circuitry restriction is 0, 1 or 2

IGESAppli_ToolDrilledHole

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

Constructors(1)

Instance methods(4)

IGESAppli_ToolElementResults

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

Constructors(1)

Instance methods(3)

IGESAppli_ToolFiniteElement

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

Constructors(1)

Instance methods(3)

IGESAppli_ToolFlow

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

Constructors(1)

Instance methods(4)

IGESAppli_ToolFlowLineSpec

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

Constructors(1)

Instance methods(3)

IGESAppli_ToolLevelFunction

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

Constructors(1)

Instance methods(4)

IGESAppli_ToolLevelToPWBLayerMap

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

Constructors(1)

Instance methods(3)

IGESAppli_ToolLineWidening

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

Constructors(1)

Instance methods(4)

IGESAppli_ToolNodalConstraint

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

Constructors(1)

Instance methods(3)

IGESAppli_ToolNodalDisplAndRot

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

Constructors(1)

Instance methods(3)

IGESAppli_ToolNodalResults

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

Constructors(1)

Instance methods(3)

IGESAppli_ToolNode

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

Constructors(1)

Instance methods(3)

IGESAppli_ToolPartNumber

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

Constructors(1)

Instance methods(4)

IGESAppli_ToolPinNumber

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

Constructors(1)

Instance methods(4)

IGESAppli_ToolPipingFlow

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

Constructors(1)

Instance methods(4)

IGESAppli_ToolPWBArtworkStackup

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

Constructors(1)

Instance methods(3)

IGESAppli_ToolPWBDrilledHole

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

Constructors(1)

Instance methods(4)

IGESAppli_ToolReferenceDesignator

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

Constructors(1)

Instance methods(4)

IGESAppli_ToolRegionRestriction

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

Constructors(1)

Instance methods(4)