src/TDataStd/TDataStd_Comment.cdl

   1 -- Created on: 1998-01-15
   2 -- Created by: Denis PASCAL
   3 -- Copyright (c) 1998-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 class Comment from TDataStd inherits Attribute from TDF
  18
  19         ---Purpose: Comment attribute. may be  associated to any label
  20         --          to store user comment.
  21
  22 uses Attribute         from TDF,
  23      Label             from TDF,
  24      GUID              from Standard,
  25      ExtendedString    from TCollection,
  26      DataSet           from TDF,
  27      RelocationTable   from TDF,
  28      AttributeSequence from TDF,
  29      Data              from TDF
  30
  31
  32 is
  33
  34
  35     ---Purpose: class methods
  36     --          =============
  37
  38     GetID (myclass)
  39         ---C++: return const &
  40         ---Purpose: Returns the GUID for comments.
  41     returns GUID from Standard;
  42
  43     Set (myclass; label : Label from TDF)
  44     ---Purpose:  Find, or create  a   Comment attribute.  the  Comment
  45     --          attribute is returned.
  46     returns Comment from TDataStd;
  47
  48     Set (myclass; label : Label from TDF; string  : ExtendedString from TCollection)
  49     ---Purpose: Finds, or creates a Comment attribute and sets the string.
  50     --          the Comment attribute is returned.
  51     returns Comment from TDataStd;
  52
  53     ---Purpose: Comment methods
  54     --          ============
  55
  56     Create
  57     returns mutable Comment from TDataStd;
  58
  59     Set (me : mutable; S : ExtendedString from TCollection);
  60
  61
  62     Get (me)
  63     returns ExtendedString from TCollection;
  64     ---Purpose:
  65     --    Returns the comment attribute.
  66     ---C++: return const &
  67
  68     ---Category: TDF_Attribute methods
  69     --           =====================
  70
  71     ID (me)
  72         ---C++: return const &
  73     returns GUID from Standard;
  74
  75     Restore (me: mutable; with : Attribute from TDF);
  76
  77     NewEmpty (me)
  78     returns mutable Attribute from TDF;
  79
  80     Paste (me; into : mutable Attribute from TDF;
  81                RT   : mutable RelocationTable from TDF);
  82
  83     Dump(me; anOS : in out OStream from Standard)
  84         returns OStream from Standard
  85         is redefined;
  86         ---C++: return &
  87
  88     AfterRetrieval(me: mutable;
  89                    forceIt : Boolean from Standard = Standard_False)
  90         returns Boolean from Standard
  91         is redefined static;
  92
  93
  94 fields
  95
  96     myString : ExtendedString from TCollection;
  97
  98 end Comment;