include/opencascade/TDataStd_Relation.hxx

0001 // Created on: 1997-12-10
0002 // Created by: Denis PASCAL
0003 // Copyright (c) 1997-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 _TDataStd_Relation_HeaderFile
0018 #define _TDataStd_Relation_HeaderFile
0019
0020 #include <TDataStd_Expression.hxx>
0021
0022 //! Relation attribute.
0023 //! ==================
0024 //!
0025 //! * Data Structure of the Expression is stored in a
0026 //! string and references to variables used by the string
0027 //!
0028 //! Warning: To be consistent, each Variable referenced by the
0029 //! relation must have its equivalent in the string
0030 class TDataStd_Relation : public TDataStd_Expression
0031 {
0032
0033 public:
0034   //! class methods
0035   //! =============
0036   Standard_EXPORT static const Standard_GUID& GetID();
0037
0038   //! Find, or create, an Relation attribute.
0039   //! Real methods
0040   //! ============
0041   Standard_EXPORT static occ::handle<TDataStd_Relation> Set(const TDF_Label& label);
0042
0043   Standard_EXPORT TDataStd_Relation();
0044
0045   Standard_EXPORT void SetRelation(const TCollection_ExtendedString& E);
0046
0047   Standard_EXPORT const TCollection_ExtendedString& GetRelation() const;
0048
0049   Standard_EXPORT const Standard_GUID& ID() const override;
0050
0051   Standard_EXPORT Standard_OStream& Dump(Standard_OStream& anOS) const override;
0052
0053   //! Dumps the content of me into the stream
0054   Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const override;
0055
0056   DEFINE_DERIVED_ATTRIBUTE(TDataStd_Relation, TDataStd_Expression)
0057 };
0058
0059 #endif // _TDataStd_Relation_HeaderFile