#include <OdUnitsFormatter.h>

Inheritance diagram for OdUnitsFormatter:

Classes
struct	DimazinValues

struct	DimzinValues

Public Types
enum	LUnits { kScientific = 1 , kDecimal = 2 , kEngineering = 3 , kArchitectural = 4 , kFractional = 5 , kWindowsDesktop = 6 }

enum	AUnits { kDegrees = 0 , kDegMinSec = 1 , kGrads = 2 , kRadians = 3 , kSurveyors = 4 }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdUnitsFormatter)

virtual OdString	formatCmColor (const OdCmColorBase &value) const =0

virtual OdSharedPtr< OdCmColorBase >	unformatCmColor (const OdString &string) const =0

virtual OdString	formatLinear (double value) const =0

virtual double	unformatLinear (const OdString &string) const =0

virtual OdString	formatAngle (double value) const =0

virtual double	unformatAngle (const OdString &string) const =0

Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()

	OdRxObject ()

virtual	~OdRxObject ()

virtual OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () const

virtual void	addRef ()=0

virtual void	release ()=0

virtual long	numRefs () const

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual void	copyFrom (const OdRxObject *pSource)

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Static Public Member Functions
static bool	isZeroFeetSuppressed (int dimzin)

static bool	isZeroInchesSuppressed (int dimzin)

static bool	isZeroFeetSuppressed2 (int dimzin)

static bool	isZeroInchesSuppressed2 (int dimzin)

static OdString	formatL (double value, LUnits lUnits, int precision, int dimzin, int unitMode, const OdChar decsep=0, const OdChar thsep=0, bool useStdRound=true)

static OdString	formatArea (double value, LUnits lUnits, int precision, int dimzin, int unitMode, const OdChar decsep=0, const OdChar thsep=0)

static double	unformatL (const OdString &string)

static OdString	formatA (double value, AUnits aUnits, int precision, int dimazin, int unitMode, const OdChar *decsep=0)

static OdString	formatA_unnorm (double value, AUnits aUnits, int precision, int dimazin, int unitMode, const OdChar *decsep=0)

static double	unformatA (const OdString &string)

static double	unformatA_unnorm (const OdString &string, bool refuseDots=false)

Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

static void	rxInit ()

static void	rxUninit ()

Detailed Description

Definition at line 61 of file OdUnitsFormatter.h.

Member Enumeration Documentation

◆ AUnits

enum OdUnitsFormatter::AUnits

Enumerator
kDegrees
kDegMinSec
kGrads
kRadians
kSurveyors

Definition at line 219 of file OdUnitsFormatter.h.

◆ LUnits

enum OdUnitsFormatter::LUnits

Enumerator
kScientific
kDecimal
kEngineering
kArchitectural
kFractional
kWindowsDesktop

Definition at line 66 of file OdUnitsFormatter.h.

Member Function Documentation

◆ formatA()

static OdString OdUnitsFormatter::formatA	(	double	value,
		AUnits	aUnits,
		int	precision,
		int	dimazin,
		int	unitMode,
		const OdChar *	decsep = 0 )

static

Converts angular value to string using specified formatting settings.

Returns: specified angular value as a string.

Parameters

value	[in] Value to format.
aUnits	[in] Angle units.
precision	[in] Number of decimal places.
dimazin	[in] A combination of ZeroSuppressionFlags from OdDbDatabase variable dimazin.
unitMode	[in] UNITMODE value.
decsep	[in] Decimal separator.

Remarks: A zero value for decsep specifies the default separator is to be used.; All angles are expressed as radians.

◆ formatA_unnorm()

static OdString OdUnitsFormatter::formatA_unnorm	(	double	value,
		AUnits	aUnits,
		int	precision,
		int	dimazin,
		int	unitMode,
		const OdChar *	decsep = 0 )

static

Converts angular value to string using specified formatting settings without normalizing it to [0, 2*Pi] range.

Returns: the specified angular value as a string.

Parameters

value	[in] Value to format.
aUnits	[in] Angle units.
precision	[in] Number of decimal places.
dimazin	[in] A combination of ZeroSuppressionFlags from OdDbDatabase variable dimazin.
unitMode	[in] UNITMODE value.
decsep	[in] Decimal separator.

Remarks: A zero value for decsep specifies the default separator is to be used.; All angles are expressed as radians.

◆ formatAngle()

virtual OdString OdUnitsFormatter::formatAngle ( double value ) const

pure virtual

Returns the specified angle value as a string.

Parameters

value [in] Value to format.

Remarks: The returned value depends on the ANGBASE, AUNITS, AUPREC, DIMAZIN, and UNITMODE system variables.; All angles are expressed in radians.

Implemented in CFxUnitsFormatter, OdDbBaseUnitsFormatter, and OdDbUnitsFormatterImpl.

◆ formatArea()

static OdString OdUnitsFormatter::formatArea	(	double	value,
		LUnits	lUnits,
		int	precision,
		int	dimzin,
		int	unitMode,
		const OdChar *	decsep = 0,
		const OdChar *	thsep = 0 )

static

Converts area value to string using specified formatting settings.

Returns: specified area value as a string.

Parameters

value	[in] Value to format.
lUnits	[in] Length units.
precision	[in] Number of decimal places.
dimzin	[in] A combination of ZeroSuppressionFlags.
unitMode	[in] UNITMODE value.
decsep	[in] Decimal separator.
thsep	[in] Thousands separator.

Remarks: A zero value for decsep specifies the default separator is to be used. A zero value for thsep specifies that no separator is to be used.

◆ formatCmColor()

virtual OdString OdUnitsFormatter::formatCmColor ( const OdCmColorBase & value ) const

pure virtual

Returns the specified color value or OdCmColorBase object as a string.

Parameters

value [in] Value to format.

Implemented in CFxUnitsFormatter, OdDbBaseUnitsFormatter, and OdDbUnitsFormatterImpl.

◆ formatL()

static OdString OdUnitsFormatter::formatL	(	double	value,
		LUnits	lUnits,
		int	precision,
		int	dimzin,
		int	unitMode,
		const OdChar *	decsep = 0,
		const OdChar *	thsep = 0,
		bool	useStdRound = true )

static

Converts linear value to string using specified formatting settings.

Returns: specified linear value as a string.

Parameters

value	[in] Value to format.
lUnits	[in] Length units.
precision	[in] Number of decimal places.
dimzin	[in] A combination of ZeroSuppressionFlags.
unitMode	[in] UNITMODE value.
decsep	[in] Decimal separator.
thsep	[in] Thousands separator.
useStdRound	[in] Usage of std::round.

Remarks: A zero value for decsep specifies the default separator is to be used. A zero value for thsep specifies that no separator is to be used. A true value for useStdRound specifies that std::round will be used in decimal value rounding. This means that rounding starts from 5, otherwise it starts from 5 + 1e-15.

◆ formatLinear()

virtual OdString OdUnitsFormatter::formatLinear ( double value ) const

pure virtual

Returns the specified distance value as a string.

Parameters

value [in] Value to format.

Remarks: The returned value depends on the DIMZIN, LUNITS, LUPREC, and UNITMODE system variables.

Implemented in CFxUnitsFormatter, OdDbBaseUnitsFormatter, and OdDbUnitsFormatterImpl.

◆ isZeroFeetSuppressed()

static bool OdUnitsFormatter::isZeroFeetSuppressed ( int dimzin )

static

Checks if dimzin value specifies zero feet suppression.

Returns: true if the specified dimzin values contains kIncludesZeroFeetAndPreciselyZeroInches flag.

Parameters

dimzin [in] Value to check.

◆ isZeroFeetSuppressed2()

static bool OdUnitsFormatter::isZeroFeetSuppressed2 ( int dimzin )

static

Checks if dimzin value specifies zero feet suppression.

Returns: true if the specified dimzin values contains kIncludesZeroFeetAndPreciselyZeroInches flag.

Parameters

dimzin [in] Value to check.

◆ isZeroInchesSuppressed()

static bool OdUnitsFormatter::isZeroInchesSuppressed ( int dimzin )

static

Checks if dimzin value specifies zero inch suppression.

Returns: true if the specified dimzin values contains kIncludesZeroFeetAndSuppressesZeroInches flag.

Parameters

dimzin [in] Value to check.

◆ isZeroInchesSuppressed2()

static bool OdUnitsFormatter::isZeroInchesSuppressed2 ( int dimzin )

static

Checks if dimzin value specifies zero inch suppression.

Returns: true if the specified dimzin values contains kIncludesZeroFeetAndSuppressesZeroInches flag.

Parameters

dimzin [in] Value to check.

◆ ODRX_DECLARE_MEMBERS()

OdUnitsFormatter::ODRX_DECLARE_MEMBERS ( OdUnitsFormatter )

◆ unformatA()

static double OdUnitsFormatter::unformatA ( const OdString & string )

static

Converts string to angular value using specified formatting settings.

Returns: specified string as an angular value.

Parameters

string [in] String to unformat.

Remarks: All angles are expressed as radians.

◆ unformatA_unnorm()

static double OdUnitsFormatter::unformatA_unnorm	(	const OdString &	string,
		bool	refuseDots = false )

static

Converts string to angular value using specified formatting settings without normalizing it to [0, 2*Pi] range.

Returns: specified string as an angular value.

Parameters

string	[in] String to unformat.
refuseDots	[in] Specifies whether to refuse having dots in formatted value.

Remarks: All angles are expressed as radians.

◆ unformatAngle()

virtual double OdUnitsFormatter::unformatAngle ( const OdString & string ) const

pure virtual

Returns the specified string as an angle value.

Parameters

string [in] String to unformat.

Remarks: The returned value depends on the ANGBASE system variable.; All angles are expressed in radians.

Implemented in CFxUnitsFormatter, OdDbBaseUnitsFormatter, and OdDbUnitsFormatterImpl.

◆ unformatCmColor()

virtual OdSharedPtr< OdCmColorBase > OdUnitsFormatter::unformatCmColor ( const OdString & string ) const

pure virtual

Returns the specified string as an wrapped OdCmColorBase object.

Parameters

string [in] String to unformat.

Implemented in CFxUnitsFormatter, OdDbBaseUnitsFormatter, and OdDbUnitsFormatterImpl.

◆ unformatL()

static double OdUnitsFormatter::unformatL ( const OdString & string )

static

Returns the specified length string as a length value.

Parameters

string [in] String to unformat.

◆ unformatLinear()

virtual double OdUnitsFormatter::unformatLinear ( const OdString & string ) const

pure virtual

Returns the specified string as a distance value.

Parameters

string [in] String to unformat.

Remarks: The returned value depends on the UNITMODE system variable.

Implemented in CFxUnitsFormatter, OdDbBaseUnitsFormatter, and OdDbUnitsFormatterImpl.

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

OdUnitsFormatter.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ AUnits

◆ LUnits

Member Function Documentation

◆ formatA()

◆ formatA_unnorm()

◆ formatAngle()

◆ formatArea()

◆ formatCmColor()

◆ formatL()

◆ formatLinear()

◆ isZeroFeetSuppressed()

◆ isZeroFeetSuppressed2()

◆ isZeroInchesSuppressed()

◆ isZeroInchesSuppressed2()

◆ ODRX_DECLARE_MEMBERS()

◆ unformatA()

◆ unformatA_unnorm()

◆ unformatAngle()

◆ unformatCmColor()

◆ unformatL()

◆ unformatLinear()