summaryrefslogtreecommitdiff
path: root/inc/Units_UnitsSystem.hxx
blob: c61939da9dbcb6ad9f8c10d51ccbce37479ece84 (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
// 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_UnitsSystem_HeaderFile
#define _Units_UnitsSystem_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_Units_UnitsSystem_HeaderFile
#include <Handle_Units_UnitsSystem.hxx>
#endif

#ifndef _Handle_Units_QuantitiesSequence_HeaderFile
#include <Handle_Units_QuantitiesSequence.hxx>
#endif
#ifndef _Handle_TColStd_HSequenceOfInteger_HeaderFile
#include <Handle_TColStd_HSequenceOfInteger.hxx>
#endif
#ifndef _MMgt_TShared_HeaderFile
#include <MMgt_TShared.hxx>
#endif
#ifndef _Standard_CString_HeaderFile
#include <Standard_CString.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
class Units_QuantitiesSequence;
class TColStd_HSequenceOfInteger;
class Units_NoSuchUnit;
class Units_NoSuchType;
class TCollection_AsciiString;


//! This class  allows  the  user  to  define his  own <br>
//!          system of units. <br>
class Units_UnitsSystem : public MMgt_TShared {

public:

  //! Returns an instance of UnitsSystem initialized to the <br>
//!          S.I. units system. <br>
  Standard_EXPORT   Units_UnitsSystem();
  //! Returns an instance of UnitsSystem initialized to the <br>
//!          S.I. units system upgraded by the base system units decription <br>
//!	 	file. <br>
//!          Attempts to find the four following files: <br>
//!          $CSF_`aName`Defaults/.aName <br>
//!          $CSF_`aName`SiteDefaults/.aName <br>
//!          $CSF_`aName`GroupDefaults/.aName <br>
//!          $CSF_`aName`UserDefaults/.aName <br>
//!		See : Resource_Manager for the description of this file. <br>
  Standard_EXPORT   Units_UnitsSystem(const Standard_CString aName,const Standard_Boolean Verbose = Standard_False);
  //! Returns the sequence of refined quantities. <br>
  Standard_EXPORT     Handle_Units_QuantitiesSequence QuantitiesSequence() const;
  //! Returns a sequence of integer in correspondance with <br>
//!          the sequence of quantities, which indicates, for each <br>
//!          redefined quantity, the index into the sequence of <br>
//!          units, of the active unit. <br>
  Standard_EXPORT     Handle_TColStd_HSequenceOfInteger ActiveUnitsSequence() const;
  //! Specifies for <aquantity> the unit <aunit> used. <br>
  Standard_EXPORT     void Specify(const Standard_CString aquantity,const Standard_CString aunit) ;
  //! Removes for <aquantity> the unit <aunit> used. <br>
  Standard_EXPORT     void Remove(const Standard_CString aquantity,const Standard_CString aunit) ;
  //! Specifies for <aquantity> the unit <aunit> used. <br>
  Standard_EXPORT     void Activate(const Standard_CString aquantity,const Standard_CString aunit) ;
  //! Activates the first unit of all defined system quantities <br>
  Standard_EXPORT     void Activates() ;
  //! Returns for <aquantity> the active unit. <br>
  Standard_EXPORT     TCollection_AsciiString ActiveUnit(const Standard_CString aquantity) const;
  //! Converts a real value <avalue> from the unit <aunit> <br>
//!          belonging to the physical dimensions <aquantity> to <br>
//!          the corresponding unit of the user system. <br>
  Standard_EXPORT     Standard_Real ConvertValueToUserSystem(const Standard_CString aquantity,const Standard_Real avalue,const Standard_CString aunit) const;
  //! Converts the real value <avalue> from the S.I. system <br>
//!          of units to the user system of units. <aquantity> is <br>
//!          the physical dimensions of the measurement. <br>
  Standard_EXPORT     Standard_Real ConvertSIValueToUserSystem(const Standard_CString aquantity,const Standard_Real avalue) const;
  //! Converts the real value <avalue> from the user system <br>
//!          of units to the S.I. system of units. <aquantity> is <br>
//!          the physical dimensions of the measurement. <br>
  Standard_EXPORT     Standard_Real ConvertUserSystemValueToSI(const Standard_CString aquantity,const Standard_Real avalue) const;
  
  Standard_EXPORT     void Dump() const;
  //! Returns TRUE if no units has been defined in the system. <br>
  Standard_EXPORT     Standard_Boolean IsEmpty() const;




  DEFINE_STANDARD_RTTI(Units_UnitsSystem)

protected:




private: 


Handle_Units_QuantitiesSequence thequantitiessequence;
Handle_TColStd_HSequenceOfInteger theactiveunitssequence;


};





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


#endif