summaryrefslogtreecommitdiff
path: root/inc/StepSelect_FloatFormat.hxx
blob: e175d02fc6029796d8818baff3c0a643fdc037cd (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
// 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 _StepSelect_FloatFormat_HeaderFile
#define _StepSelect_FloatFormat_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_StepSelect_FloatFormat_HeaderFile
#include <Handle_StepSelect_FloatFormat.hxx>
#endif

#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _TCollection_AsciiString_HeaderFile
#include <TCollection_AsciiString.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _StepSelect_FileModifier_HeaderFile
#include <StepSelect_FileModifier.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Standard_CString_HeaderFile
#include <Standard_CString.hxx>
#endif
class TCollection_AsciiString;
class IFSelect_ContextWrite;
class StepData_StepWriter;


//! This class gives control out format for floatting values : <br>
//!           ZeroSuppress or no, Main Format, Format in Range (for values <br>
//!           around 1.), as StepWriter allows to manage it. <br>
//!           Formats are given under C-printf form <br>
class StepSelect_FloatFormat : public StepSelect_FileModifier {

public:

  //! Creates a new FloatFormat, with standard options : <br>
//!           ZeroSuppress, Main Format = %E, <br>
//!           Format between 0.001 and 1000. = %f <br>
  Standard_EXPORT   StepSelect_FloatFormat();
  //! Sets FloatFormat to default value (see Create) but if <digits> <br>
//!           is given positive, it commands Formats (main and range) to <br>
//!           ensure <digits> significant digits to be displayed <br>
  Standard_EXPORT     void SetDefault(const Standard_Integer digits = 0) ;
  //! Sets ZeroSuppress mode to a new value <br>
  Standard_EXPORT     void SetZeroSuppress(const Standard_Boolean mode) ;
  //! Sets Main Format to a new value <br>
//!           Remark : SetFormat, SetZeroSuppress and SetFormatForRange are <br>
//!           independant <br>
  Standard_EXPORT     void SetFormat(const Standard_CString format = "%E") ;
  //! Sets Format for Range to a new value with its range of <br>
//!           application. <br>
//!           To cancel it, give format as "" (empty string) <br>
//!           Remark that if the condition (0. < Rmin < Rmax)  is not <br>
//!           verified, this secondary format will be ignored. <br>
//!           Moreover, this secondary format is intended to be used in a <br>
//!           range around 1. <br>
  Standard_EXPORT     void SetFormatForRange(const Standard_CString format = "%f",const Standard_Real Rmin = 0.1,const Standard_Real Rmax = 1000.0) ;
  //! Returns all recorded parameters : <br>
//!           zerosup  : ZeroSuppress status <br>
//!           mainform : Main Format (which applies out of the range, or <br>
//!                       for every real if no range is set) <br>
//!           hasrange : True if a FormatInRange is set, False else <br>
//!                      (following parameters do not apply if it is False) <br>
//!           forminrange : Secondary Format (it applies inside the range) <br>
//!           rangemin, rangemax : the range in which the secondary format <br>
//!                                applies <br>
  Standard_EXPORT     void Format(Standard_Boolean& zerosup,TCollection_AsciiString& mainform,Standard_Boolean& hasrange,TCollection_AsciiString& forminrange,Standard_Real& rangemin,Standard_Real& rangemax) const;
  //! Sets the Floatting Formats of StepWriter to the recorded <br>
//!           parameters <br>
  Standard_EXPORT     void Perform(IFSelect_ContextWrite& ctx,StepData_StepWriter& writer) const;
  //! Returns specific Label : for instance, <br>
//!           "Float Format [ZeroSuppress] %E [, in range R1-R2 %f]" <br>
  Standard_EXPORT     TCollection_AsciiString Label() const;




  DEFINE_STANDARD_RTTI(StepSelect_FloatFormat)

protected:




private: 


Standard_Boolean thezerosup;
TCollection_AsciiString themainform;
TCollection_AsciiString theformrange;
Standard_Real therangemin;
Standard_Real therangemax;


};





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


#endif