1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-21 10:13:43 +03:00
occt/src/StepSelect/StepSelect_FloatFormat.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

99 lines
4.2 KiB
Plaintext
Executable File

-- Created on: 1994-06-01
-- Created by: Christian CAILLET
-- Copyright (c) 1994-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
class FloatFormat from StepSelect inherits FileModifier from StepSelect
---Purpose : This class gives control out format for floatting values :
-- ZeroSuppress or no, Main Format, Format in Range (for values
-- around 1.), as StepWriter allows to manage it.
-- Formats are given under C-printf form
uses CString, AsciiString from TCollection, HSequenceOfInteger from TColStd,
CheckIterator, StepWriter , ContextWrite
is
Create returns mutable FloatFormat;
---Purpose : Creates a new FloatFormat, with standard options :
-- ZeroSuppress, Main Format = %E,
-- Format between 0.001 and 1000. = %f
SetDefault (me : mutable; digits : Integer = 0);
---Purpose : Sets FloatFormat to default value (see Create) but if <digits>
-- is given positive, it commands Formats (main and range) to
-- ensure <digits> significant digits to be displayed
SetZeroSuppress (me : mutable; mode : Boolean);
---Purpose : Sets ZeroSuppress mode to a new value
SetFormat (me : mutable; format : CString = "%E");
---Purpose : Sets Main Format to a new value
-- Remark : SetFormat, SetZeroSuppress and SetFormatForRange are
-- independant
SetFormatForRange (me : mutable; format : CString = "%f";
Rmin : Real = 0.1; Rmax : Real = 1000.0);
---Purpose : Sets Format for Range to a new value with its range of
-- application.
-- To cancel it, give format as "" (empty string)
-- Remark that if the condition (0. < Rmin < Rmax) is not
-- verified, this secondary format will be ignored.
-- Moreover, this secondary format is intended to be used in a
-- range around 1.
Format (me; zerosup : out Boolean;
mainform : out AsciiString from TCollection;
hasrange : out Boolean;
forminrange : out AsciiString from TCollection;
rangemin, rangemax : out Real);
---Purpose : Returns all recorded parameters :
-- zerosup : ZeroSuppress status
-- mainform : Main Format (which applies out of the range, or
-- for every real if no range is set)
-- hasrange : True if a FormatInRange is set, False else
-- (following parameters do not apply if it is False)
-- forminrange : Secondary Format (it applies inside the range)
-- rangemin, rangemax : the range in which the secondary format
-- applies
Perform (me; ctx : in out ContextWrite;
writer : in out StepWriter);
---Purpose : Sets the Floatting Formats of StepWriter to the recorded
-- parameters
Label (me) returns AsciiString from TCollection;
---Purpose : Returns specific Label : for instance,
-- "Float Format [ZeroSuppress] %E [, in range R1-R2 %f]"
fields
thezerosup : Boolean;
themainform : AsciiString from TCollection;
theformrange : AsciiString from TCollection;
therangemin : Real;
therangemax : Real;
end FloatFormat;