src/TDataStd/TDataStd.cdl

   1 -- Created on: 1995-05-10
   2 -- Created by: Denis PASCAL
   3 -- Copyright (c) 1995-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
  24 package TDataStd
  25
  26         ---Purpose:  This  package  defines   standard attributes for
  27         --           modelling.
  28         -- These allow you to create and modify labels
  29         -- and attributes for many basic data types.
  30         -- Standard topological and visualization
  31         -- attributes have also been created.
  32         -- To find an attribute attached to a specific label,
  33         -- you use the GUID of the type of attribute you
  34         -- are looking for. To do this, first find this
  35         -- information using the method GetID as follows: Standard_GUID anID =
  36         -- MyAttributeClass::GetID();
  37         -- Then, use the method Find for the label as follows:
  38         -- Standard_Boolean HasAttribute
  39         -- =
  40         -- aLabel.Find(anID,anAttribute);
  41         -- Note
  42         -- For information on the relations between this
  43         -- component of OCAF and the others, refer to the OCAF User's Guide.
  44
  45     ---  Category: GUID - AttributeID
  46     --           2a96b606-ec8b-11d0-bee7-080009dc3333   TDataStd_Integer
  47
  48     --           2a96b608-ec8b-11d0-bee7-080009dc3333   TDataStd_Name
  49     --           2a96b60f-ec8b-11d0-bee7-080009dc3333   TDataStd_Real
  50     --           2a96b610-ec8b-11d0-bee7-080009dc3333   TDataStd_Reference
  51     --           2a96b616-ec8b-11d0-bee7-080009dc3333   TDataStd_Comment
  52     --           2a96b61c-ec8b-11d0-bee7-080009dc3333   TDataStd_UAttribute
  53     --           2a96b61d-ec8b-11d0-bee7-080009dc3333   TDataStd_IntegerArray
  54     --           2a96b61e-ec8b-11d0-bee7-080009dc3333   TDataStd_RealArray
  55     --           2a96b624-ec8b-11d0-bee7-080009dc3333   TDataStd_ExtStringArray
  56     --           2a96b609-ec8b-11d0-bee7-080009dc3333   TDataStd_NoteBook
  57     --           2a96b61f-ec8b-11d0-bee7-080009dc3333   TDataStd_Directory
  58
  59
  60
  61
  62 uses Standard,
  63      MMgt,
  64      TCollection,
  65      TColStd,
  66      TDF
  67
  68
  69 is
  70     enumeration RealEnum is
  71         ---Purpose:
  72         -- The terms of this enumeration define the
  73         -- semantics of a real number value.
  74       SCALAR,
  75       LENGTH,
  76       ANGULAR
  77     end RealEnum;
  78
  79     ---Category:  Basic  attributes
  80     --           ===================
  81
  82
  83     class Current;
  84
  85     class Name;
  86
  87     class Comment;
  88
  89     class Integer;
  90
  91     class IntegerArray;
  92
  93     class Real;
  94
  95     class RealArray;
  96
  97     class ExtStringArray;
  98
  99     class UAttribute;
 100
 101
 102     ---Purpose: Attributes for organization
 103     --          ============================
 104
 105     class TreeNode;
 106     pointer PtrTreeNode to TreeNode from TDataStd;
 107     class ChildNodeIterator;
 108
 109     class Directory;
 110
 111
 112     ---Category: Other attributes
 113     --           ================
 114
 115     class NoteBook;
 116
 117     class Expression;
 118
 119     class Relation;
 120
 121     class Variable;
 122
 123     class DeltaOnModificationOfIntArray;
 124
 125     class DeltaOnModificationOfRealArray;
 126
 127     class DeltaOnModificationOfExtStringArray;
 128
 129     class DeltaOnModificationOfIntPackedMap;
 130
 131     class DeltaOnModificationOfByteArray;
 132
 133
 134     -- Extension
 135     class Tick;
 136
 137     class AsciiString;
 138
 139     class IntPackedMap;
 140
 141
 142     -- Lists:
 143     class IntegerList;
 144
 145     class RealList;
 146
 147     class ExtStringList;
 148
 149     class BooleanList;
 150
 151     class ReferenceList;
 152
 153
 154     -- Arrays:
 155     class BooleanArray;
 156
 157     class ReferenceArray;
 158
 159     class ByteArray;
 160
 161     class NamedData;
 162
 163     class ListOfExtendedString instantiates List from TCollection ( ExtendedString from TCollection );
 164
 165
 166     --  Extension
 167     class ListOfByte instantiates List from TCollection(Byte from Standard);
 168
 169     class LabelArray1 instantiates Array1 from TCollection(Label from TDF);
 170
 171     class HLabelArray1 instantiates HArray1 from TCollection(Label from TDF, LabelArray1 from TDataStd);
 172
 173     class DataMapOfStringReal instantiates DataMap from TCollection(ExtendedString from TCollection,
 174                                                                     Real from Standard,
 175                                                                     ExtendedString from TCollection);
 176     class DataMapOfStringString instantiates DataMap from TCollection(ExtendedString from TCollection,
 177                                                                       ExtendedString from TCollection,
 178                                                                       ExtendedString from TCollection);
 179     class DataMapOfStringByte instantiates DataMap from TCollection(ExtendedString from TCollection,
 180                                                                     Byte from Standard,
 181                                                                     ExtendedString from TCollection);
 182     class DataMapOfStringHArray1OfInteger instantiates DataMap from TCollection(ExtendedString from TCollection,
 183                                                                                 HArray1OfInteger from TColStd,
 184                                                                                 ExtendedString from TCollection);
 185     class DataMapOfStringHArray1OfReal instantiates DataMap from TCollection(ExtendedString from TCollection,
 186                                                                              HArray1OfReal from TColStd,
 187                                                                              ExtendedString from TCollection);
 188
 189     class HDataMapOfStringInteger;
 190
 191     class HDataMapOfStringReal;
 192
 193     class HDataMapOfStringString;
 194
 195     class HDataMapOfStringByte;
 196
 197     class HDataMapOfStringHArray1OfInteger;
 198
 199     class HDataMapOfStringHArray1OfReal;
 200
 201
 202     IDList (anIDList : in out IDList from TDF);
 203         ---Purpose: Appends to <anIDList> the list of the attributes
 204         --          IDs of this package. CAUTION: <anIDList> is NOT
 205         --          cleared before use.
 206
 207
 208
 209     Print (DIM : RealEnum from TDataStd; S : in out OStream)
 210         ---Purpose: Prints the name of the real dimension <DIM> as a String on
 211         --          the Stream <S> and returns <S>.
 212         ---C++: return &
 213     returns OStream;
 214
 215 end TDataStd;
 216
 217
 218