src/IGESDefs/IGESDefs_TabularData.cdl

   1 -- Created on: 1993-01-09
   2 -- Created by: CKY / Contract Toubro-Larsen ( SIVA )
   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 TabularData from IGESDefs  inherits IGESEntity
  23
  24         ---Purpose: Defines IGES Tabular Data, Type <406> Form <11>,
  25         --          in package IGESDefs
  26         --          This Class is used to provide a Structure to accomodate
  27         --          point form data.
  28
  29 uses
  30
  31         HArray1OfInteger       from TColStd,
  32         HArray1OfReal          from TColStd,
  33         HArray1OfHArray1OfReal from IGESBasic
  34
  35 raises DimensionMismatch, OutOfRange
  36
  37 is
  38
  39         Create returns mutable TabularData;
  40
  41         -- Specific methods for the entity
  42
  43         Init (me          : mutable;
  44               nbProps     : Integer;
  45               propType    : Integer;
  46               typesInd    : HArray1OfInteger;
  47               nbValuesInd : HArray1OfInteger;
  48               valuesInd   : HArray1OfHArray1OfReal;
  49               valuesDep   : HArray1OfHArray1OfReal)
  50         raises DimensionMismatch;
  51         ---Purpose : This method is used to set the fields of the class
  52         --           TabularData
  53         --       - nbProps     : Number of property values
  54         --       - propType    : Property Type
  55         --       - typesInd    : Type of independent variables
  56         --       - nbValuesInd : Number of values of independent variables
  57         --       - valuesInd   : Values of independent variables
  58         --       - valuesDep   : Values of dependent variables
  59         -- raises exception if lengths of typeInd and nbValuesInd are not same
  60
  61         NbPropertyValues(me) returns Integer;
  62         ---Purpose : returns the number of property values (recorded)
  63
  64         ComputedNbPropertyValues (me) returns Integer;
  65         ---Purpose : determines the number of property values required
  66
  67         OwnCorrect (me : mutable) returns Boolean;
  68         ---Purpose : checks, and correct as necessary, the number of property
  69         --           values. Returns True if corrected, False if already OK
  70
  71         PropertyType(me) returns Integer;
  72         ---Purpose : returns the property type
  73
  74         NbDependents(me) returns Integer;
  75         ---Purpose : returns the number of dependent variables
  76
  77         NbIndependents(me) returns Integer;
  78         ---Purpose : returns the number of independent variables
  79
  80         TypeOfIndependents(me; num: Integer) returns Integer
  81         raises OutOfRange;
  82         ---Purpose : returns the type of the num'th independent variable
  83         -- raises exception if num <= 0 or num > NbIndependents()
  84
  85         NbValues(me; num : Integer) returns Integer
  86         raises OutOfRange;
  87         ---Purpose : returns the number of different values of the num'th indep. variable
  88         -- raises exception if num <= 0 or num > NbIndependents()
  89
  90         IndependentValue(me; variablenum : Integer; valuenum : Integer)
  91         returns Real
  92         raises OutOfRange;
  93         -- returns valuenum'th value of the variablenum'th independent variable
  94         -- raises exception if
  95         --         variablenum <= 0 or variablenum > NbIndependents()
  96         --         valuenum <= 0 or valuenum > NbValues(variablenum)
  97
  98         DependentValues (me; num : Integer) returns HArray1OfReal from TColStd
  99         raises OutOfRange;
 100         --  returns the entire list of recorded Dependent Values
 101         --  UNRESOLVED. Temporarily, all dependent values are attached to
 102         --  <num> = 1, the other values remain undefined
 103
 104         DependentValue(me; variablenum: Integer; valuenum: Integer)
 105         returns Real
 106         raises OutOfRange;
 107         -- RESERVED, unresolved
 108         -- valuenum'th value of the variablenum'th dependent variable
 109         -- raises exception if
 110         --         variablenum <= 0 or variablenum > NbIndependents()
 111         --         valuenum <= 0 or valuenum > NbValues(variablenum)
 112
 113 fields
 114
 115 --
 116 -- Class    : IGESDefs_TabularData
 117 --
 118 -- Purpose  : Declaration of variables specific to the definition
 119 --            of the Class TabularData.
 120 --
 121 -- Reminder : A TabularData instance is defined by :
 122 --            - The number of properties
 123 --            - The property type, an integer
 124 --            - The property type, an integer
 125 --            - The number of dependent variables
 126 --            - The type of independent variables, a single array of Int
 127 --            - The single array of integer values
 128 --            - The single array of independent values
 129 --            - The single array of dependent values
 130
 131         theNbPropertyValues           : Integer;
 132         thePropertyType               : Integer;
 133         theTypeOfIndependentVariables : HArray1OfInteger;
 134         theNbValues                   : HArray1OfInteger;
 135         theIndependentValues          : HArray1OfHArray1OfReal;
 136         theDependentValues            : HArray1OfHArray1OfReal;
 137
 138 end TabularData;