include/opencascade/MoniTool_SignText.hxx

0001 // Created on: 1998-05-20
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 _MoniTool_SignText_HeaderFile
0018 #define _MoniTool_SignText_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Transient.hxx>
0024 class TCollection_AsciiString;
0025
0026 //! Provides the basic service to get a text which identifies
0027 //! an object in a context
0028 //! It can be used for other classes (general signatures ...)
0029 //! It can also be used to build a message in which an object
0030 //! is to be identified
0031 class MoniTool_SignText : public Standard_Transient
0032 {
0033
0034 public:
0035   //! Returns an identification of the Signature (a word), given at
0036   //! initialization time
0037   Standard_EXPORT virtual const char* Name() const = 0;
0038
0039   //! Gives a text as a signature for a transient object alone, i.e.
0040   //! without defined context.
0041   //! By default, calls Text with undefined context (Null Handle) and
0042   //! if empty, then returns DynamicType
0043   Standard_EXPORT virtual TCollection_AsciiString TextAlone(
0044     const occ::handle<Standard_Transient>& ent) const;
0045
0046   //! Gives a text as a signature for a transient object in a context
0047   //! If the context is senseless, it can be given as Null Handle
0048   //! empty result if nothing to give (at least the DynamicType could
0049   //! be sent ?)
0050   Standard_EXPORT virtual TCollection_AsciiString Text(
0051     const occ::handle<Standard_Transient>& ent,
0052     const occ::handle<Standard_Transient>& context) const = 0;
0053
0054   DEFINE_STANDARD_RTTIEXT(MoniTool_SignText, Standard_Transient)
0055 };
0056
0057 #endif // _MoniTool_SignText_HeaderFile