src/TDataStd/TDataStd_AsciiString.cdl

   1 -- Created on: 2007-07-31
   2 -- Created by: Sergey ZARITCHNY
   3 -- Copyright (c) 2007-2012 OPEN CASCADE SAS
   4 --
   5 -- The content of this file is subject to the Open CASCADE Technology Public
   6 -- License Version 6.5 (the "License"). You may not use the content of this file
   7 -- except in compliance with the License. Please obtain a copy of the License
   8 -- at http://www.opencascade.org and read it completely before using this file.
   9 --
  10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  12 --
  13 -- The Original Code and all software distributed under the License is
  14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  15 -- Initial Developer hereby disclaims all such warranties, including without
  16 -- limitation, any warranties of merchantability, fitness for a particular
  17 -- purpose or non-infringement. Please see the License for the specific terms
  18 -- and conditions governing the rights and limitations under the License.
  19
  20
  21
  22 class AsciiString from TDataStd inherits Attribute from TDF
  23
  24         ---Purpose: Used to define an AsciiString attribute containing a TCollection_AsciiString
  25
  26 uses
  27     Attribute         from TDF,
  28     Label             from TDF,
  29     GUID              from Standard,
  30     AsciiString       from TCollection,
  31     RelocationTable   from TDF
  32
  33 is
  34     ---Purpose: class methods
  35     --          =============
  36
  37     GetID (myclass)
  38         ---C++: return const &
  39         ---Purpose: Returns the GUID of the attribute.
  40     returns GUID from Standard;
  41
  42     Set (myclass; label : Label from TDF; string  : AsciiString from TCollection)
  43     ---Purpose: Finds, or creates an AsciiString attribute and sets the string.
  44     --          the AsciiString attribute is returned.
  45     returns AsciiString from TDataStd;
  46
  47     ---Purpose: AsciiString methods
  48     --          ===================
  49
  50     Create
  51     returns mutable AsciiString from TDataStd;
  52     -- Constructor
  53
  54     Set (me : mutable; S : AsciiString from TCollection);
  55     -- Sets the ascii string <S>
  56
  57     Get (me)
  58     returns AsciiString from TCollection;
  59     -- Returns the AsciiString  <myString>
  60     ---C++: return const &
  61
  62     IsEmpty(me)
  63     returns Boolean from Standard;
  64     -- Returns True if the string of <me> contains zero characters.
  65
  66     ---Category: TDF_Attribute methods
  67     --           =====================
  68
  69     ID (me)
  70         ---C++: return const &
  71     returns GUID from Standard;
  72
  73     Restore (me: mutable; with : Attribute from TDF);
  74     --  Restores the backuped content from <with> into this one.
  75
  76     NewEmpty (me)
  77     returns mutable Attribute from TDF;
  78     -- Returns an new empty AsciiString attribute.
  79
  80     Paste (me; into : mutable Attribute from TDF;
  81                RT   : mutable RelocationTable from TDF);
  82     -- This method is used when copying an attribute from a source structure
  83     -- into a target structure.
  84
  85     Dump(me; anOS : in out OStream from Standard)
  86         returns OStream from Standard
  87         is redefined;
  88         ---C++: return &
  89     -- This method dumps the attribute value into the stream
  90 fields
  91     myString : AsciiString from TCollection;
  92
  93 end AsciiString;