src/Standard/Standard_Transient.cdl

   1 -- Created on: 1992-08-24
   2 -- Created by: Ramin BARRETO
   3 -- Copyright (c) 1992-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 deferred class Transient from Standard
  18
  19     ---Purpose: Abstract class which forms the root of the entire
  20     --          Transient class hierarchy.
  21     ---Warning: This CDL file is actually a stub, even if it attempts to be correct.
  22     --          See actual header in Standard_Transient_proto.hxx
  23
  24 uses
  25     Type from Standard,
  26     Boolean from Standard,
  27     Integer from Standard
  28
  29 is
  30
  31         Initialize;
  32             ---Purpose: Empty constructor
  33             ---Warning: Copy constructor and assignment operators cannot be
  34             --          declared cleanly in CDL, so we use "C++ alias" for that
  35             ---C++: alias "Standard_Transient(const Standard_Transient&) : count(0) {}"
  36             ---C++: alias "Standard_Transient& operator= (const Standard_Transient&) { return *this; }"
  37
  38         Delete(me) is  virtual;
  39             ---Purpose: Memory deallocator for transient classes
  40             ---Level: Advanced
  41             ---C++: alias "Standard_EXPORT virtual ~Standard_Transient();"
  42
  43         DynamicType (me) returns Type is virtual;
  44             ---Purpose: Returns a type information object about this object.
  45             ---Level: Advanced
  46
  47         IsInstance (me; TheType : Type) returns Boolean is static;
  48             ---Purpose: Returns a true value if this is an instance of Type.
  49             ---Level: Advanced
  50
  51         IsInstance (me; TheTypeName : CString) returns Boolean is static;
  52             ---Purpose: Returns a true value if this is an instance of TypeName.
  53             ---Level: Advanced
  54
  55         IsKind (me; TheType : Type) returns Boolean is static;
  56             ---Purpose: Returns true if this is an instance of Type or an
  57             --          instance of any class that inherits from Type.
  58             --          Note that multiple inheritance is not supported by OCCT RTTI mechanism.
  59             ---Level: Advanced
  60
  61         IsKind (me; TheTypeName : CString) returns Boolean is static;
  62             ---Purpose: Returns true if this is an instance of TypeName or an
  63             --         instance of any class that inherits from TypeName.
  64             --          Note that multiple inheritance is not supported by OCCT RTTI mechanism.
  65             ---Level: Advanced
  66
  67         This (me) returns Transient
  68             ---Purpose: Returns a Handle which references this object.
  69             ---Warning: Must never be called to objects created in stack.
  70             ---Level: Advanced
  71         is virtual protected;
  72
  73  ---Level: Advanced
  74
  75         GetRefCount(me)
  76             ---Purpose: get the reference counter
  77             --          of this object.
  78             returns  Integer  from  Standard;
  79
  80      fields
  81         count : Integer from Standard;
  82
  83 end Transient from Standard;
  84
  85
  86