include/opencascade/TDataStd_Expression.hxx

0001 // Created on: 1997-12-16
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_Expression_HeaderFile
0018 #define _TDataStd_Expression_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <TCollection_ExtendedString.hxx>
0023 #include <TDF_AttributeList.hxx>
0024 #include <TDF_DerivedAttribute.hxx>
0025 #include <Standard_OStream.hxx>
0026 class Standard_GUID;
0027 class TDF_Label;
0028 class TDF_RelocationTable;
0029
0030 class TDataStd_Expression;
0031 DEFINE_STANDARD_HANDLE(TDataStd_Expression, TDF_Attribute)
0032
0033 //! Expression attribute.
0034 //! ====================
0035 //!
0036 //! * Data Structure  of the Expression   is stored in a
0037 //! string and references to variables used by the string
0038 //!
0039 //! Warning:  To be consistent,  each  Variable  referenced by  the
0040 //! expression must have its equivalent in the string
0041 class TDataStd_Expression : public TDF_Attribute
0042 {
0043
0044 public:
0045   //! class methods
0046   //! =============
0047   Standard_EXPORT static const Standard_GUID& GetID();
0048
0049   //! Find, or create, an Expression attribute.
0050   //! Expressionmethods
0051   //! ============
0052   Standard_EXPORT static Handle(TDataStd_Expression) Set(const TDF_Label& label);
0053
0054   Standard_EXPORT TDataStd_Expression();
0055
0056   //! build and return the expression name
0057   Standard_EXPORT TCollection_ExtendedString Name() const;
0058
0059   Standard_EXPORT void SetExpression(const TCollection_ExtendedString& E);
0060
0061   Standard_EXPORT const TCollection_ExtendedString& GetExpression() const;
0062
0063   Standard_EXPORT TDF_AttributeList& GetVariables();
0064
0065   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0066
0067   Standard_EXPORT void Restore(const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
0068
0069   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0070
0071   Standard_EXPORT void Paste(const Handle(TDF_Attribute)&       Into,
0072                              const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0073
0074   Standard_EXPORT virtual Standard_OStream& Dump(Standard_OStream& anOS) const Standard_OVERRIDE;
0075
0076   //! Dumps the content of me into the stream
0077   Standard_EXPORT virtual void DumpJson(Standard_OStream& theOStream,
0078                                         Standard_Integer  theDepth = -1) const Standard_OVERRIDE;
0079
0080   DEFINE_STANDARD_RTTIEXT(TDataStd_Expression, TDF_Attribute)
0081
0082 protected:
0083   TCollection_ExtendedString myExpression;
0084   TDF_AttributeList          myVariables;
0085 };
0086
0087 #endif // _TDataStd_Expression_HeaderFile