src/IGESAppli/IGESAppli_FiniteElement.cdl

   1 -- Created on: 1993-01-11
   2 -- Created by: CKY / Contract Toubro-Larsen ( Arun MENON )
   3 -- Copyright (c) 1993-1999 Matra Datavision
   4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22 class FiniteElement from IGESAppli  inherits IGESEntity
  23
  24         ---Purpose: defines FiniteElement, Type <136> Form <0>
  25         --          in package IGESAppli
  26         --          Used to define a finite element with the help of an
  27         --          element topology.
  28
  29 uses
  30
  31         HAsciiString  from TCollection,
  32         Node          from IGESAppli,
  33         HArray1OfNode from IGESAppli
  34
  35 raises OutOfRange
  36
  37 is
  38
  39         Create returns mutable FiniteElement;
  40
  41         -- Specific Methods pertaining to the class
  42
  43         Init (me       : mutable;
  44               aType    : Integer;
  45               allNodes : HArray1OfNode;
  46               aName    : HAsciiString);
  47         ---Purpose : This method is used to set the fields of the class
  48         --           FiniteElement
  49         --       - aType    : Indicates the topology type
  50         --       - allNodes : List of Nodes defining the element
  51         --       - aName    : Element type name
  52
  53         Topology (me) returns Integer;
  54         ---Purpose : returns Topology type
  55
  56         NbNodes (me) returns Integer;
  57         ---Purpose : returns the number of nodes defining the element
  58
  59         Node (me; Index : Integer) returns Node
  60         raises OutOfRange;
  61         ---Purpose : returns Node defining element entity
  62         -- raises exception if Index <= 0 or Index > NbNodes()
  63
  64         Name (me) returns HAsciiString from TCollection;
  65         ---Purpose : returns Element Type Name
  66
  67 fields
  68
  69 --
  70 -- Class    : IGESAppli_FiniteElement
  71 --
  72 -- Purpose  : Declaration of variables specific to the definition
  73 --            of the Class FiniteElement.
  74 --
  75 -- Reminder : A FiniteElement instance is defined by :
  76 --            - the topology type
  77 --            - List of Nodes defining the element
  78 --            - Element type name
  79
  80         theTopology : Integer;
  81         theNodes    : HArray1OfNode;
  82         theName     : HAsciiString;
  83
  84 end FiniteElement;