include/opencascade/Units_Lexicon.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_Lexicon_HeaderFile
0018 #define _Units_Lexicon_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Time.hxx>
0024 #include <Units_TokensSequence.hxx>
0025 #include <Standard_Transient.hxx>
0026 #include <Standard_CString.hxx>
0027 #include <Standard_Boolean.hxx>
0028 #include <Standard_Real.hxx>
0029
0030 class Units_Lexicon;
0031 DEFINE_STANDARD_HANDLE(Units_Lexicon, Standard_Transient)
0032
0033 //! This class defines a lexicon useful to analyse and
0034 //! recognize the  different key words  included  in a
0035 //! sentence.  The lexicon is stored  in a sequence of
0036 //! tokens.
0037 class Units_Lexicon : public Standard_Transient
0038 {
0039
0040 public:
0041   //! Creates an empty instance of Lexicon.
0042   Standard_EXPORT Units_Lexicon();
0043
0044   //! Reads the file <afilename> to create a sequence  of tokens
0045   //! stored in <thesequenceoftokens>.
0046   Standard_EXPORT void Creates();
0047
0048   //! Returns the first item of the sequence of tokens.
0049   Handle(Units_TokensSequence) Sequence() const;
0050
0051   //! Adds to the lexicon a new token with <aword>, <amean>,
0052   //! <avalue>  as  arguments.  If there is  already a token
0053   //! with   the  field  <theword>  equal    to <aword>, the
0054   //! existing token is updated.
0055   Standard_EXPORT void AddToken(const Standard_CString aword,
0056                                 const Standard_CString amean,
0057                                 const Standard_Real    avalue);
0058
0059   //! Useful for debugging.
0060   virtual void Dump() const;
0061
0062   DEFINE_STANDARD_RTTIEXT(Units_Lexicon, Standard_Transient)
0063
0064 protected:
0065 private:
0066   Handle(Units_TokensSequence) thesequenceoftokens;
0067 };
0068
0069 #include <Units_Lexicon.lxx>
0070
0071 #endif // _Units_Lexicon_HeaderFile