include/opencascade/Units_Sentence.hxx

0001 // Created on: 1992-06-22
0002 // Created by: Gilles DEBARBOUILLE
0003 // Copyright (c) 1992-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 _Units_Sentence_HeaderFile
0018 #define _Units_Sentence_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Units_TokensSequence.hxx>
0025 #include <Standard_CString.hxx>
0026 class Units_Lexicon;
0027 class Units_Token;
0028
0029
0030 //! This class describes all the methods to create and
0031 //! compute an expression contained in a string.
0032 class Units_Sentence
0033 {
0034 public:
0035
0036   DEFINE_STANDARD_ALLOC
0037
0038
0039   //! Creates and  returns  a   Sentence, by  analyzing  the
0040   //! string <astring> with the lexicon <alexicon>.
0041   Standard_EXPORT Units_Sentence(const Handle(Units_Lexicon)& alexicon, const Standard_CString astring);
0042
0043   //! For each constant encountered, sets the value.
0044   Standard_EXPORT void SetConstants();
0045
0046   //! Returns <thesequenceoftokens>.
0047     Handle(Units_TokensSequence) Sequence() const;
0048
0049   //! Sets the field <thesequenceoftokens> to <asequenceoftokens>.
0050     void Sequence (const Handle(Units_TokensSequence)& asequenceoftokens);
0051
0052   //! Computes and  returns in a   token the result  of  the
0053   //! expression.
0054   Standard_EXPORT Handle(Units_Token) Evaluate();
0055
0056   //! Return True if number of created tokens > 0
0057   //! (i.e creation of sentence is successful)
0058     Standard_Boolean IsDone() const;
0059
0060   //! Useful for debugging.
0061     void Dump() const;
0062
0063
0064
0065
0066 protected:
0067
0068
0069
0070
0071
0072 private:
0073
0074
0075
0076   Handle(Units_TokensSequence) thesequenceoftokens;
0077
0078
0079 };
0080
0081
0082 #include <Units_Sentence.lxx>
0083
0084
0085
0086
0087
0088 #endif // _Units_Sentence_HeaderFile