This class gives control out format for floatting values : ZeroSuppress or no, Main Format, Format in Range (for values around 1.), as IGESWriter allows to manage it. Formats are given under C-printf form. More...

#include <IGESSelect_FloatFormat.hxx>

Inheritance diagram for IGESSelect_FloatFormat:

[legend]

Public Member Functions
	IGESSelect_FloatFormat ()
	Creates a new FloatFormat, with standard options : ZeroSuppress, Main Format = E, Format between 0.001 and 1000. = f.
void	SetDefault (const int digits=0)
	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.
void	SetZeroSuppress (const bool modemode)
	Sets ZeroSuppress mode to a new value.
void	SetFormat (const char *const formatformat="%E")
	Sets Main Format to a new value Remark : SetFormat, SetZeroSuppress and SetFormatForRange are independent.
void	SetFormatForRange (const char *const formatformat="%f", const double Rmin=0.1, const double Rmax=1000.0)
	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.
void	Format (bool &zerosup, TCollection_AsciiString &mainform, bool &hasrange, TCollection_AsciiString &forminrange, double &rangemin, double &rangemax) const
	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.
void	Perform (IFSelect_ContextWrite &ctx, IGESData_IGESWriter &writer) const override
	Sets the Floatting Formats of IGESWriter to the recorded parameters.
TCollection_AsciiString	Label () const override
	Returns specific Label : for instance, "Float Format [ZeroSuppress] %E [, in range R1-R2 %f]".
Public Member Functions inherited from IFSelect_GeneralModifier
bool	MayChangeGraph () const
	Returns True if this modifier may change the graph of dependences (acknowledged at creation time).
void	SetDispatch (const occ::handle< IFSelect_Dispatch > &disp)
	Attaches to a Dispatch. If <disp> is Null, Resets it (to apply the Modifier on every Dispatch).
occ::handle< IFSelect_Dispatch >	Dispatch () const
	Returns the Dispatch to be matched, Null if not set.
bool	Applies (const occ::handle< IFSelect_Dispatch > &disp) const
	Returns True if a Model obtained from the Dispatch <disp> is to be treated (apart from the Selection criterium) If Dispatch(me) is Null, returns True. Else, checks <disp>.
void	SetSelection (const occ::handle< IFSelect_Selection > &sel)
	Sets a Selection : a Model is treated if it contains one or more Entities designated by the Selection.
void	ResetSelection ()
	Resets the Selection : this criterium is not longer active.
bool	HasSelection () const
	Returns True if a Selection is set as an additional criterium.
occ::handle< IFSelect_Selection >	Selection () const
	Returns the Selection, or a Null Handle if not set.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
bool	IsKind (const char *const theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.
Protected Member Functions inherited from IGESSelect_FileModifier
	IGESSelect_FileModifier ()
	Sets a File Modifier to keep the graph of dependences unchanges (because it works on the model already produced).
Protected Member Functions inherited from IFSelect_GeneralModifier
	IFSelect_GeneralModifier (const bool maychangegraph)
	Sets the Modifier criteria to default Values (i.e. "always applies") <maychangegraph> must be provided at creation time, to :

Detailed Description

This class gives control out format for floatting values : ZeroSuppress or no, Main Format, Format in Range (for values around 1.), as IGESWriter allows to manage it. Formats are given under C-printf form.

Constructor & Destructor Documentation

◆ IGESSelect_FloatFormat()

IGESSelect_FloatFormat::IGESSelect_FloatFormat ( )

Creates a new FloatFormat, with standard options : ZeroSuppress, Main Format = E, Format between 0.001 and 1000. = f.

Member Function Documentation

◆ Format()

void IGESSelect_FloatFormat::Format	(	bool &	zerosup,
		TCollection_AsciiString &	mainform,
		bool &	hasrange,
		TCollection_AsciiString &	forminrange,
		double &	rangemin,
		double &	rangemax ) const

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.

◆ Label()

TCollection_AsciiString IGESSelect_FloatFormat::Label ( ) const

overridevirtual

Returns specific Label : for instance, "Float Format [ZeroSuppress] %E [, in range R1-R2 %f]".

Implements IFSelect_GeneralModifier.

◆ Perform()

void IGESSelect_FloatFormat::Perform	(	IFSelect_ContextWrite &	ctx,
		IGESData_IGESWriter &	writer ) const

overridevirtual

Sets the Floatting Formats of IGESWriter to the recorded parameters.

Implements IGESSelect_FileModifier.

◆ SetDefault()

void IGESSelect_FloatFormat::SetDefault ( const int digits = 0 )

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.

◆ SetFormat()

void IGESSelect_FloatFormat::SetFormat ( const char *const format = "%E" )

Sets Main Format to a new value Remark : SetFormat, SetZeroSuppress and SetFormatForRange are independent.

◆ SetFormatForRange()

void IGESSelect_FloatFormat::SetFormatForRange	(	const char *const	format = "%f",
		const double	Rmin = 0.1,
		const double	Rmax = 1000.0 )

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.

◆ SetZeroSuppress()

void IGESSelect_FloatFormat::SetZeroSuppress ( const bool mode )

Sets ZeroSuppress mode to a new value.

The documentation for this class was generated from the following file:

IGESSelect_FloatFormat.hxx

Public Member Functions

Additional Inherited Members