src/StepData/StepData_UndefinedEntity.cdl

   1 -- Created on: 1992-02-11
   2 -- Created by: Christian CAILLET
   3 -- Copyright (c) 1992-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
  23 class UndefinedEntity  from StepData  inherits TShared
  24
  25     ---Purpose : Undefined entity specific to Step Interface, in which StepType
  26     --           is defined at each instance, or is a SubList of another one
  27     --           Uses an UndefinedContent, that from Interface is suitable.
  28     --           Also an Entity defined by STEP can be "Complex Type" (see
  29     --           ANDOR clause in Express).
  30
  31 uses AsciiString from TCollection, HAsciiString from TCollection,
  32      UndefinedContent, Check, CopyTool, EntityIterator,
  33      StepReaderData, StepWriter
  34
  35 is
  36
  37     Create returns mutable UndefinedEntity;
  38     ---Purpose : creates an Unknown entity
  39
  40     Create (issub : Boolean) returns mutable UndefinedEntity;
  41     ---Purpose : Creates a SubList of an Unknown entity : it is an Unknown
  42     --           Entity with no Type, but flagged as "SUB" if issub is True
  43
  44     UndefinedContent (me) returns mutable UndefinedContent;
  45     ---Purpose : Returns the UndefinedContent which brings the Parameters
  46
  47
  48     IsSub (me) returns Boolean;
  49     ---Purpose : Returns True if an Unndefined Entity is SubPart of another one
  50
  51     Super (me) returns mutable UndefinedEntity;
  52     ---Purpose : Returns the "super-entity" of a sub-part
  53
  54     IsComplex (me) returns Boolean;
  55     ---Purpose : Returns True if <me> defines a Multiple Type Entity (see ANDOR)
  56
  57     Next (me) returns mutable UndefinedEntity;
  58     ---Purpose : For a Multiple Type Entity, returns the Next "Componant"
  59     --           For more than two Types, iterative definition (Next->Next...)
  60     --           Returns a Null Handle for the end of the List
  61
  62
  63     StepType (me) returns CString;
  64     ---Purpose : gives entity type, read from file
  65     --           For a Complex Type Entity, gives the first Type read, each
  66     --           "Next" gives its "partial" type
  67     -- was C++ : return const
  68
  69     ReadRecord (me : mutable;
  70                 SR : StepReaderData; num : Integer; ach : in out Check);
  71     ---Purpose : reads data from StepReaderData (i.e. from file), by filling
  72     --           StepType and parameters stored in the UndefinedContent
  73
  74     WriteParams (me; SW : in out StepWriter);
  75     ---Purpose : write data to StepWriter, taken from UndefinedContent
  76
  77     GetFromAnother (me : mutable; other : like me;
  78                     TC : in out CopyTool);
  79     ---Purpose : reads another UndefinedEntity from StepData
  80
  81     FillShared     (me; list : in out EntityIterator from Interface);
  82     ---Purpose : Fills the list of shared entities
  83
  84 fields
  85
  86     thetype : HAsciiString from TCollection;
  87     thecont : UndefinedContent;
  88     thesub  : Boolean;
  89     thenext : UndefinedEntity;  -- for a Multiple Type Entity
  90
  91 end UndefinedEntity;