42cf5bc1 |
1 | // Created on: 1998-05-20 |
2 | // Created by: Christian CAILLET |
3 | // Copyright (c) 1998-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 | #ifndef _MoniTool_SignText_HeaderFile |
18 | #define _MoniTool_SignText_HeaderFile |
19 | |
20 | #include <Standard.hxx> |
21 | #include <Standard_Type.hxx> |
22 | |
25e59720 |
23 | #include <Standard_Transient.hxx> |
42cf5bc1 |
24 | #include <Standard_CString.hxx> |
25 | class TCollection_AsciiString; |
26 | class Standard_Transient; |
27 | |
28 | |
29 | class MoniTool_SignText; |
25e59720 |
30 | DEFINE_STANDARD_HANDLE(MoniTool_SignText, Standard_Transient) |
42cf5bc1 |
31 | |
32 | //! Provides the basic service to get a text which identifies |
33 | //! an object in a context |
34 | //! It can be used for other classes (general signatures ...) |
35 | //! It can also be used to build a message in which an object |
36 | //! is to be identified |
25e59720 |
37 | class MoniTool_SignText : public Standard_Transient |
42cf5bc1 |
38 | { |
39 | |
40 | public: |
41 | |
42 | |
43 | //! Returns an identification of the Signature (a word), given at |
44 | //! initialization time |
45 | Standard_EXPORT virtual Standard_CString Name() const = 0; |
46 | |
47 | //! Gives a text as a signature for a transient object alone, i.e. |
48 | //! without defined context. |
49 | //! By default, calls Text with undefined context (Null Handle) and |
50 | //! if empty, then returns DynamicType |
51 | Standard_EXPORT virtual TCollection_AsciiString TextAlone (const Handle(Standard_Transient)& ent) const; |
52 | |
53 | //! Gives a text as a signature for a transient object in a context |
54 | //! If the context is senseless, it can be given as Null Handle |
55 | //! empty result if nothing to give (at least the DynamicType could |
56 | //! be sent ?) |
57 | Standard_EXPORT virtual TCollection_AsciiString Text (const Handle(Standard_Transient)& ent, const Handle(Standard_Transient)& context) const = 0; |
58 | |
59 | |
60 | |
61 | |
25e59720 |
62 | DEFINE_STANDARD_RTTIEXT(MoniTool_SignText,Standard_Transient) |
42cf5bc1 |
63 | |
64 | protected: |
65 | |
66 | |
67 | |
68 | |
69 | private: |
70 | |
71 | |
72 | |
73 | |
74 | }; |
75 | |
76 | |
77 | |
78 | |
79 | |
80 | |
81 | |
82 | #endif // _MoniTool_SignText_HeaderFile |