include/opencascade/Units_UnitSentence.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_UnitSentence_HeaderFile
0018 #define _Units_UnitSentence_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Units_Sentence.hxx>
0025 #include <Standard_CString.hxx>
0026 #include <Units_QuantitiesSequence.hxx>
0027
0028
0029 //! This   class describes   all    the  facilities to
0030 //! manipulate and compute units contained in a string
0031 //! expression.
0032 class Units_UnitSentence  : public Units_Sentence
0033 {
0034 public:
0035
0036   DEFINE_STANDARD_ALLOC
0037
0038
0039   //! Creates   and   returns a   UnitSentence.   The string
0040   //! <astring> describes in natural  language the  unit  or
0041   //! the composed unit to be analysed.
0042   Standard_EXPORT Units_UnitSentence(const Standard_CString astring);
0043
0044   //! Creates  and returns    a  UnitSentence.  The   string
0045   //! <astring> describes in natural language the unit to be
0046   //! analysed.   The    sequence     of physical quantities
0047   //! <asequenceofquantities>   describes    the   available
0048   //! dictionary of units you want to use.
0049   Standard_EXPORT Units_UnitSentence(const Standard_CString astring, const Handle(Units_QuantitiesSequence)& aquantitiessequence);
0050
0051   //! Analyzes   the sequence  of   tokens  created  by  the
0052   //! constructor to  find  the true significance   of  each
0053   //! token.
0054   Standard_EXPORT void Analyse();
0055
0056   //! For each token which  represents a unit, finds  in the
0057   //! sequence    of    physical   quantities      all   the
0058   //! characteristics of the unit found.
0059   Standard_EXPORT void SetUnits (const Handle(Units_QuantitiesSequence)& aquantitiessequence);
0060
0061
0062
0063
0064 protected:
0065
0066
0067
0068
0069
0070 private:
0071
0072
0073
0074
0075
0076 };
0077
0078
0079
0080
0081
0082
0083
0084 #endif // _Units_UnitSentence_HeaderFile