include/opencascade/Expr_NamedExpression.hxx

0001 // Created on: 1991-01-10
0002 // Created by: Arnaud BOUZY
0003 // Copyright (c) 1991-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 _Expr_NamedExpression_HeaderFile
0018 #define _Expr_NamedExpression_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <TCollection_AsciiString.hxx>
0023 #include <Expr_GeneralExpression.hxx>
0024
0025 class Expr_NamedExpression;
0026 DEFINE_STANDARD_HANDLE(Expr_NamedExpression, Expr_GeneralExpression)
0027
0028 //! Describe an expression used  by its name (as constants
0029 //! or variables). A single reference is made to a
0030 //! NamedExpression in every Expression (i.e. a
0031 //! NamedExpression is shared).
0032 class Expr_NamedExpression : public Expr_GeneralExpression
0033 {
0034
0035 public:
0036   Standard_EXPORT const TCollection_AsciiString& GetName() const;
0037
0038   Standard_EXPORT void SetName(const TCollection_AsciiString& name);
0039
0040   //! Tests if <me> can be shared by one or more expressions
0041   //! or must be copied. This method redefines to a True
0042   //! value the GeneralExpression method.
0043   Standard_EXPORT virtual Standard_Boolean IsShareable() const Standard_OVERRIDE;
0044
0045   //! Tests if <me> and <Other> define the same expression.
0046   //! This method does not include any simplification before
0047   //! testing.
0048   Standard_EXPORT Standard_Boolean
0049     IsIdentical(const Handle(Expr_GeneralExpression)& Other) const Standard_OVERRIDE;
0050
0051   //! returns a string representing <me> in a readable way.
0052   Standard_EXPORT TCollection_AsciiString String() const Standard_OVERRIDE;
0053
0054   DEFINE_STANDARD_RTTIEXT(Expr_NamedExpression, Expr_GeneralExpression)
0055
0056 protected:
0057 private:
0058   TCollection_AsciiString myName;
0059 };
0060
0061 #endif // _Expr_NamedExpression_HeaderFile