src/TDataStd/TDataStd_AsciiString.cdl

   1 -- Created on: 2007-07-31
   2 -- Created by: Sergey ZARITCHNY
   3 -- Copyright (c) 2007-2014 OPEN CASCADE SAS
   4 --
   5 -- This file is part of Open CASCADE Technology software library.
   6 --
   7 -- This library is free software; you can redistribute it and/or modify it under
   8 -- the terms of the GNU Lesser General Public License version 2.1 as published
   9 -- by the Free Software Foundation, with special exception defined in the file
  10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 -- distribution for complete text of the license and disclaimer of any warranty.
  12 --
  13 -- Alternatively, this file may be used under the terms of Open CASCADE
  14 -- commercial license or contractual agreement.
  15
  16 class AsciiString from TDataStd inherits Attribute from TDF
  17
  18         ---Purpose: Used to define an AsciiString attribute containing a TCollection_AsciiString
  19
  20 uses
  21     Attribute         from TDF,
  22     Label             from TDF,
  23     GUID              from Standard,
  24     AsciiString       from TCollection,
  25     RelocationTable   from TDF
  26
  27 is
  28     ---Purpose: class methods
  29     --          =============
  30
  31     GetID (myclass)
  32         ---C++: return const &
  33         ---Purpose: Returns the GUID of the attribute.
  34     returns GUID from Standard;
  35
  36     Set (myclass; label : Label from TDF; string  : AsciiString from TCollection)
  37     ---Purpose: Finds, or creates an AsciiString attribute and sets the string.
  38     --          the AsciiString attribute is returned.
  39     returns AsciiString from TDataStd;
  40
  41     ---Purpose: AsciiString methods
  42     --          ===================
  43
  44     Create
  45     returns mutable AsciiString from TDataStd;
  46     -- Constructor
  47
  48     Set (me : mutable; S : AsciiString from TCollection);
  49     -- Sets the ascii string <S>
  50
  51     Get (me)
  52     returns AsciiString from TCollection;
  53     -- Returns the AsciiString  <myString>
  54     ---C++: return const &
  55
  56     IsEmpty(me)
  57     returns Boolean from Standard;
  58     -- Returns True if the string of <me> contains zero characters.
  59
  60     ---Category: TDF_Attribute methods
  61     --           =====================
  62
  63     ID (me)
  64         ---C++: return const &
  65     returns GUID from Standard;
  66
  67     Restore (me: mutable; with : Attribute from TDF);
  68     --  Restores the backuped content from <with> into this one.
  69
  70     NewEmpty (me)
  71     returns mutable Attribute from TDF;
  72     -- Returns an new empty AsciiString attribute.
  73
  74     Paste (me; into : mutable Attribute from TDF;
  75                RT   : mutable RelocationTable from TDF);
  76     -- This method is used when copying an attribute from a source structure
  77     -- into a target structure.
  78
  79     Dump(me; anOS : in out OStream from Standard)
  80         returns OStream from Standard
  81         is redefined;
  82         ---C++: return &
  83     -- This method dumps the attribute value into the stream
  84 fields
  85     myString : AsciiString from TCollection;
  86
  87 end AsciiString;