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_Quantity.hxx>
0027 #include <NCollection_Sequence.hxx>
0028 #include <NCollection_HSequence.hxx>
0029
0030 //! This class describes all the facilities to
0031 //! manipulate and compute units contained in a string
0032 //! expression.
0033 class Units_UnitSentence : public Units_Sentence
0034 {
0035 public:
0036   DEFINE_STANDARD_ALLOC
0037
0038   //! Creates and returns a UnitSentence. The string
0039   //! <astring> describes in natural language the unit or
0040   //! the composed unit to be analysed.
0041   Standard_EXPORT Units_UnitSentence(const char* const astring);
0042
0043   //! Creates and returns a UnitSentence. The string
0044   //! <astring> describes in natural language the unit to be
0045   //! analysed. The sequence of physical quantities
0046   //! <asequenceofquantities> describes the available
0047   //! dictionary of units you want to use.
0048   Standard_EXPORT Units_UnitSentence(
0049     const char* const                                                      astring,
0050     const occ::handle<NCollection_HSequence<occ::handle<Units_Quantity>>>& aquantitiessequence);
0051
0052   //! Analyzes the sequence of tokens created by the
0053   //! constructor to find the true significance of each
0054   //! token.
0055   Standard_EXPORT void Analyse();
0056
0057   //! For each token which represents a unit, finds in the
0058   //! sequence of physical quantities all the
0059   //! characteristics of the unit found.
0060   Standard_EXPORT void SetUnits(
0061     const occ::handle<NCollection_HSequence<occ::handle<Units_Quantity>>>& aquantitiessequence);
0062 };
0063
0064 #endif // _Units_UnitSentence_HeaderFile