include/opencascade/Interface_SignType.hxx

0001 // Created on: 1998-02-04
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1998-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Interface_SignType_HeaderFile
0018 #define _Interface_SignType_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <MoniTool_SignText.hxx>
0024 class TCollection_AsciiString;
0025 class Standard_Transient;
0026 class Interface_InterfaceModel;
0027
0028 //! Provides the basic service to get a type name, according
0029 //! to a norm
0030 //! It can be used for other classes (general signatures ...)
0031 class Interface_SignType : public MoniTool_SignText
0032 {
0033
0034 public:
0035   //! Returns an identification of the Signature (a word), given at
0036   //! initialization time
0037   //! Specialised to consider context as an InterfaceModel
0038   Standard_EXPORT TCollection_AsciiString
0039     Text(const occ::handle<Standard_Transient>& ent,
0040          const occ::handle<Standard_Transient>& context) const override;
0041
0042   //! Returns the Signature for a Transient object. It is specific
0043   //! of each sub-class of Signature. For a Null Handle, it should
0044   //! provide ""
0045   //! It can work with the model which contains the entity
0046   Standard_EXPORT virtual const char* Value(
0047     const occ::handle<Standard_Transient>&       ent,
0048     const occ::handle<Interface_InterfaceModel>& model) const = 0;
0049
0050   //! From a CDL Type Name, returns the Class part (package dropped)
0051   //! WARNING : buffered, to be immediately copied or printed
0052   Standard_EXPORT static const char* ClassName(const char* const typnam);
0053
0054   DEFINE_STANDARD_RTTIEXT(Interface_SignType, MoniTool_SignText)
0055 };
0056
0057 #endif // _Interface_SignType_HeaderFile