0030773: Application Framework - To allow to inherit existing attributes to reuse...
[occt.git] / src / TDataStd / TDataStd_Relation.hxx
1 // Created on: 1997-12-10
2 // Created by: Denis PASCAL
3 // Copyright (c) 1997-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 _TDataStd_Relation_HeaderFile
18 #define _TDataStd_Relation_HeaderFile
19
20 #include <TDataStd_Expression.hxx>
21
22 class TDataStd_Relation;
23 DEFINE_STANDARD_HANDLE(TDataStd_Relation, TDataStd_Expression)
24
25 //! Relation attribute.
26 //! ==================
27 //!
28 //! *  Data Structure of  the  Expression is stored in a
29 //! string and references to variables used by the string
30 //!
31 //! Warning:  To be consistent,  each  Variable  referenced by  the
32 //! relation must have its equivalent in the string
33 class TDataStd_Relation : public TDataStd_Expression
34 {
35
36 public:
37
38   
39   //! class methods
40   //! =============
41   Standard_EXPORT static const Standard_GUID& GetID();
42   
43   //! Find, or create, an Relation attribute.
44   //! Real methods
45   //! ============
46   Standard_EXPORT static Handle(TDataStd_Relation) Set (const TDF_Label& label);
47   
48   Standard_EXPORT TDataStd_Relation();
49   
50   Standard_EXPORT void SetRelation (const TCollection_ExtendedString& E);
51   
52   Standard_EXPORT const TCollection_ExtendedString& GetRelation() const;
53   
54   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
55   
56   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
57
58   //! Dumps the content of me into the stream
59   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
60
61
62
63   DEFINE_DERIVED_ATTRIBUTE(TDataStd_Relation,TDataStd_Expression)
64 };
65
66 #endif // _TDataStd_Relation_HeaderFile