File: Units_Unit.hxx

package info (click to toggle)
oce 0.18.3-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 301,548 kB
  • sloc: cpp: 1,190,609; ansic: 67,225; sh: 11,630; tcl: 7,954; cs: 5,221; python: 2,867; java: 1,522; makefile: 342; xml: 292; perl: 37
file content (113 lines) | stat: -rw-r--r-- 3,399 bytes parent folder | download | duplicates (5)
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
// 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_Unit_HeaderFile
#define _Units_Unit_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineHandle.hxx>
#include <Handle_Units_Unit.hxx>

#include <Handle_TCollection_HAsciiString.hxx>
#include <Handle_TColStd_HSequenceOfHAsciiString.hxx>
#include <Standard_Real.hxx>
#include <Handle_Units_Quantity.hxx>
#include <MMgt_TShared.hxx>
#include <Standard_CString.hxx>
#include <TCollection_AsciiString.hxx>
#include <Handle_Units_Token.hxx>
#include <Standard_Boolean.hxx>
#include <Standard_Integer.hxx>
class TCollection_HAsciiString;
class TColStd_HSequenceOfHAsciiString;
class Units_Quantity;
class Units_Token;


//! This class defines an elementary word contained in
//! a physical quantity.
class Units_Unit : public MMgt_TShared
{

public:

  
  //! Creates  and returns a  unit.  <aname> is  the name of
  //! the  unit, <asymbol> is the  usual abbreviation of the
  //! unit,  and  <avalue> is the  value in relation to  the
  //! International System of Units.
  Standard_EXPORT Units_Unit(const Standard_CString aname, const Standard_CString asymbol, const Standard_Real avalue, const Handle(Units_Quantity)& aquantity);
  
  //! Creates  and returns a  unit.  <aname> is  the name of
  //! the  unit, <asymbol> is the  usual abbreviation of the
  //! unit.
  Standard_EXPORT Units_Unit(const Standard_CString aname, const Standard_CString asymbol);
  
  //! Creates  and returns a  unit.  <aname> is  the name of
  //! the  unit.
  Standard_EXPORT Units_Unit(const Standard_CString aname);
  
  //! Returns the name of the unit <thename>
      TCollection_AsciiString Name()  const;
  
  //! Adds a new symbol <asymbol> attached to <me>.
  Standard_EXPORT   void Symbol (const Standard_CString asymbol) ;
  
  //! Returns the  value in relation  with the International
  //! System of Units.
      Standard_Real Value()  const;
  
  //! Returns <thequantity> contained in <me>.
      Handle(Units_Quantity) Quantity()  const;
  
  //! Returns the sequence of symbols <thesymbolssequence>
      Handle(TColStd_HSequenceOfHAsciiString) SymbolsSequence()  const;
  
  //! Sets the value <avalue> to <me>.
      void Value (const Standard_Real avalue) ;
  
  //! Sets the physical Quantity <aquantity> to <me>.
      void Quantity (const Handle(Units_Quantity)& aquantity) ;
  
  //! Starting with <me>, returns a new Token object.
  Standard_EXPORT virtual   Handle(Units_Token) Token()  const;
  
  //! Compares all the symbols  linked  within <me> with the
  //! name of <atoken>,  and returns  True  if there is  one
  //! symbol equal to the name, False otherwise.
  Standard_EXPORT   Standard_Boolean IsEqual (const Standard_CString astring)  const;
  
  //! Useful for debugging
  Standard_EXPORT virtual   void Dump (const Standard_Integer ashift, const Standard_Integer alevel)  const;




  DEFINE_STANDARD_RTTI(Units_Unit)

protected:


  Handle(TColStd_HSequenceOfHAsciiString) thesymbolssequence;
  Standard_Real thevalue;


private: 


  Handle(TCollection_HAsciiString) thename;
  Handle(Units_Quantity) thequantity;


};


#include <Units_Unit.lxx>





#endif // _Units_Unit_HeaderFile