include/opencascade/Express_Type.hxx

0001 // Copyright (c) 1999-2020 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef _Express_Type_HeaderFile
0015 #define _Express_Type_HeaderFile
0016
0017 #include <Standard_Type.hxx>
0018
0019 class TCollection_AsciiString;
0020
0021 //! Provides basis for identification (reference) to some type
0022 //! in express schema
0023 class Express_Type : public Standard_Transient
0024 {
0025
0026 public:
0027
0028   //! Returns CPP-style name of the type
0029   Standard_EXPORT virtual const TCollection_AsciiString CPPName() const = 0;
0030
0031   //! Return True if type is defined in package Standard (False by default)
0032   Standard_EXPORT virtual Standard_Boolean IsStandard() const;
0033
0034   //! Return True if type is simple (not a class)
0035   //! (by default returns IsStandard())
0036   Standard_EXPORT virtual Standard_Boolean IsSimple() const;
0037
0038   //! Return True if type is Transient
0039   //! (by default returns ! IsSimple())
0040   Standard_EXPORT virtual Standard_Boolean IsHandle() const;
0041
0042   //! Declares type as used by some item being generated.
0043   //! Calls Use() for all referred types and schema items.
0044   //! Default instantiation does nothing
0045   Standard_EXPORT virtual Standard_Boolean Use() const;
0046
0047   //! Declares type as used by some item being generated.
0048   //! Calls Use() for all referred types and schema items.
0049   //! Default instantiation does nothing
0050   Standard_EXPORT virtual void Use2 (const TCollection_AsciiString& theRefName, const TCollection_AsciiString& theRefPack) const;
0051
0052   DEFINE_STANDARD_RTTIEXT(Express_Type, Standard_Transient)
0053
0054 protected:
0055
0056   //! Empty constructor
0057   Standard_EXPORT Express_Type();
0058
0059 private:
0060
0061 };
0062
0063 #endif // _Express_Type_HeaderFile