summaryrefslogtreecommitdiff
path: root/inc/Units_Token.hxx
blob: 5638216012a5332ce84139da43387c0964d604d3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _Units_Token_HeaderFile
#define _Units_Token_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_Units_Token_HeaderFile
#include <Handle_Units_Token.hxx>
#endif

#ifndef _TCollection_AsciiString_HeaderFile
#include <TCollection_AsciiString.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Handle_Units_Dimensions_HeaderFile
#include <Handle_Units_Dimensions.hxx>
#endif
#ifndef _MMgt_TShared_HeaderFile
#include <MMgt_TShared.hxx>
#endif
#ifndef _Standard_CString_HeaderFile
#include <Standard_CString.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
class Units_Dimensions;


//! This class defines an elementary word contained in <br>
//!          a Sentence object. <br>
class Units_Token : public MMgt_TShared {

public:

  //! Creates and returns a empty token. <br>
  Standard_EXPORT   Units_Token();
  //! Creates  and returns  a token.   <aword>  is  a string <br>
//!          containing the available word. <br>
  Standard_EXPORT   Units_Token(const Standard_CString aword);
  //! Creates and returns a  token.  <atoken> is  copied  in <br>
//!          the returned token. <br>
  Standard_EXPORT   Units_Token(const Handle(Units_Token)& atoken);
  //! Creates  and  returns a  token.   <aword> is  a string <br>
//!          containing the  available word and  <amean>  gives the <br>
//!          signification of the token. <br>
  Standard_EXPORT   Units_Token(const Standard_CString aword,const Standard_CString amean);
  //! Creates   and  returns a  token.   <aword> is a string <br>
//!          containing   the available  word,  <amean> gives   the <br>
//!          signification of the token and <avalue> is the numeric <br>
//!          value of the dimension. <br>
  Standard_EXPORT   Units_Token(const Standard_CString aword,const Standard_CString amean,const Standard_Real avalue);
  //! Creates and returns  a  token.  <aword> is   a  string <br>
//!          containing the   available   word, <amean>   gives the <br>
//!          signification of  the  token, <avalue> is  the numeric <br>
//!          value  of the dimension,  and <adimensions>   is   the <br>
//!          dimension of the given word <aword>. <br>
  Standard_EXPORT   Units_Token(const Standard_CString aword,const Standard_CString amean,const Standard_Real avalue,const Handle(Units_Dimensions)& adimension);
  //! Creates and returns a  token, which is a ShiftedToken. <br>
  Standard_EXPORT   virtual  Handle_Units_Token Creates() const;
  //! Returns the length of the word. <br>
  Standard_EXPORT     Standard_Integer Length() const;
  //! Returns the string <theword> <br>
        TCollection_AsciiString Word() const;
  //! Sets the field <theword> to <aword>. <br>
        void Word(const Standard_CString aword) ;
  //! Returns the significance of the word  <theword>, which <br>
//!          is in the field <themean>. <br>
        TCollection_AsciiString Mean() const;
  //! Sets the field <themean> to <amean>. <br>
        void Mean(const Standard_CString amean) ;
  //! Returns the value stored in the field <thevalue>. <br>
        Standard_Real Value() const;
  //! Sets the field <thevalue> to <avalue>. <br>
        void Value(const Standard_Real avalue) ;
  //! Returns the dimensions of the token <thedimensions>. <br>
        Handle_Units_Dimensions Dimensions() const;
  //! Sets the field <thedimensions> to <adimensions>. <br>
  Standard_EXPORT     void Dimensions(const Handle(Units_Dimensions)& adimensions) ;
  //! Updates     the  token  <me>    with  the   additional <br>
//!          signification  <amean> by  concatenation   of the  two <br>
//!          strings   <themean>    and   <amean>.   If    the  two <br>
//!          significations are  the same  , an information message <br>
//!          is written in the output device. <br>
//! <br>
  Standard_EXPORT     void Update(const Standard_CString amean) ;
  
  Standard_EXPORT     Handle_Units_Token Add(const Standard_Integer aninteger) const;
  //! Returns a  token which is  the addition  of  <me>  and <br>
//!          another token <atoken>. The  addition  is  possible if <br>
//!          and only if the dimensions are the same. <br>
  Standard_EXPORT     Handle_Units_Token Add(const Handle(Units_Token)& atoken) const;
  //! Returns a token  which is the  subtraction of <me> and <br>
//!          another token <atoken>. The subtraction is possible if <br>
//!          and only if the dimensions are the same. <br>
  Standard_EXPORT     Handle_Units_Token Subtract(const Handle(Units_Token)& atoken) const;
  //! Returns a  token  which  is the  product of   <me> and <br>
//!          another token <atoken>. <br>
  Standard_EXPORT     Handle_Units_Token Multiply(const Handle(Units_Token)& atoken) const;
  //! This   virtual method is   called  by  the Measurement <br>
//!          methods,  to  compute    the   measurement   during  a <br>
//!          conversion. <br>
  Standard_EXPORT   virtual  Standard_Real Multiplied(const Standard_Real avalue) const;
  //! Returns a token which is the division of <me> by another <br>
//!          token <atoken>. <br>
  Standard_EXPORT     Handle_Units_Token Divide(const Handle(Units_Token)& atoken) const;
  //! This  virtual  method  is  called by  the  Measurement <br>
//!          methods,   to   compute   the measurement  during    a <br>
//!          conversion. <br>
  Standard_EXPORT   virtual  Standard_Real Divided(const Standard_Real avalue) const;
  //! Returns a token which is <me> to the power  of another <br>
//!          token <atoken>.  The computation  is possible  only if <br>
//!          <atoken> is a dimensionless constant. <br>
  Standard_EXPORT     Handle_Units_Token Power(const Handle(Units_Token)& atoken) const;
  //! Returns a token which is <me> to the power  of <anexponent>. <br>
  Standard_EXPORT     Handle_Units_Token Power(const Standard_Real anexponent) const;
  //! Returns true if  the  field <theword> and  the  string <br>
//!          <astring> are the same, false otherwise. <br>
  Standard_EXPORT     Standard_Boolean IsEqual(const Standard_CString astring) const;
  //! Returns true  if the  field  <theword> and  the string <br>
//!          <theword> contained  in  the  token <atoken>  are  the <br>
//!          same, false otherwise. <br>
  Standard_EXPORT     Standard_Boolean IsEqual(const Handle(Units_Token)& atoken) const;
  //! Returns false if  the field <theword>  and the  string <br>
//!          <astring> are the same, true otherwise. <br>
        Standard_Boolean IsNotEqual(const Standard_CString astring) const;
  //! Returns false if  the field <theword>  and the  string <br>
//!          <theword> contained  in the  token  <atoken>  are  the <br>
//!          same, true otherwise. <br>
        Standard_Boolean IsNotEqual(const Handle(Units_Token)& atoken) const;
  //! Returns   true  if the   field <theword>  is  strictly <br>
//!          contained at  the beginning  of the string  <astring>, <br>
//!          false otherwise. <br>
        Standard_Boolean IsLessOrEqual(const Standard_CString astring) const;
  //! Returns false  if   the field   <theword> is  strictly <br>
//!          contained at  the  beginning  of the string <astring>, <br>
//!          true otherwise. <br>
        Standard_Boolean IsGreater(const Standard_CString astring) const;
  //! Returns false  if   the field   <theword> is  strictly <br>
//!          contained at  the  beginning  of the string <astring>, <br>
//!          true otherwise. <br>
        Standard_Boolean IsGreater(const Handle(Units_Token)& atoken) const;
  //! Returns true  if  the string <astring>   is   strictly <br>
//!          contained   at the  beginning  of  the field <theword> <br>
//!          false otherwise. <br>
        Standard_Boolean IsGreaterOrEqual(const Handle(Units_Token)& atoken) const;
  //! Destroies the Token <br>
  Standard_EXPORT   virtual  void Destroy() ;
~Units_Token()
{
  Destroy();
}
  //! Useful for debugging <br>
  Standard_EXPORT   virtual  void Dump(const Standard_Integer ashift,const Standard_Integer alevel) const;



  DEFINE_STANDARD_RTTI(Units_Token)

protected:




private: 


TCollection_AsciiString theword;
TCollection_AsciiString themean;
Standard_Real thevalue;
Handle_Units_Dimensions thedimensions;


};


#include <Units_Token.lxx>



// other Inline functions and methods (like "C++: function call" methods)


#endif