CATAnnotationUseItf Interface CATIDrwDimFormat

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIDrwDimFormat

Manages the dimension value format.

Method Index


o GetAvailableFormatDisplayFactor(int&)
Gets the maximun level of factor available to be displayed.
o GetDisplayFactor()
o GetDisplayUnit()
o GetFormatDisplayFactor(int&)
Gets the level of factor to be displayed.
o GetFormatDisplayUnit(int&)
Gets the display unit.
o GetFormatName(CATUnicodeString&)
Gets the format name.
o GetFormatPrecision(double&)
Gets the precision.
o GetFormatType(int&)
Gets the type.
o GetFormatUnit(int&)
Gets the unit.
o GetLabel(CATUnicodeString&)
o GetPrecision()
o GetType()
o GetUnit()
o SetDisplayFactor(int)
o SetFormatDisplayFactor(int&)
Sets the level of factor to be displayed.
o SetFormatName(CATUnicodeString&)
Sets the format name.
o SetFormatPrecision(double&)
Sets the precision.
o SetFormatType(int&)
Sets the type.
o SetFormatUnit(int&)
Sets the unit.
o SetLabel(CATUnicodeString)
o SetPrecision(double)
o SetType(int)
o SetUnit(int)

Methods


o GetAvailableFormatDisplayFactor
public virtual HRESULT GetAvailableFormatDisplayFactor(int& oMaxDisplayFactor) const = 0
Gets the maximun level of factor available to be displayed. It may vary according to the name of the format.
Parameters:
oMaxDisplayFactor
[out] Maximum level of display factor.
Returns:
S_OK
if everything ran ok,
E_FAIL
if a problem occured.
o GetDisplayFactor
public virtual int GetDisplayFactor()= 0
Deprecated:
V5R18 use #GetFormatDisplayFactor
o GetDisplayUnit
public virtual int GetDisplayUnit()const = 0
Deprecated:
V5R18 use #GetFormatDisplayUnit
o GetFormatDisplayFactor
public virtual HRESULT GetFormatDisplayFactor(int& oDisplayFactor) const = 0
Gets the level of factor to be displayed.
Parameters:
oDisplayFactor
[out] Display factor
Returns:
S_OK
if everything ran ok,
S_UNDEFINED
if the property isn't set,
E_FAIL
if a problem occured.
o GetFormatDisplayUnit
public virtual HRESULT GetFormatDisplayUnit(int& oDisplayUnit) const = 0
Gets the display unit.
Parameters:
oDisplayUnit
[out] The dsiplay Unit
Legal values are: (see define definition file)
  1. Length units:
    CATDrwDimUnitNone
    None unit.
    CATDrwDimUnitMM
    Millimeter.
    CATDrwDimUnitINCH
    Inch.
    CATDrwDimUnitMETER
    Meter.
    CATDrwDimUnitCM
    Centimeter.
    CATDrwDimUnitKM
    Kilometer.
    CATDrwDimUnitFOOT
    Foot.
    CATDrwDimUnitF_I_F64
    Feet Inch Fraction 1/64.
    CATDrwDimUnitF_I_F16
    Feet Inch Fraction 1/16.
    CATDrwDimUnitF_I_DEC
    Feet Inch decimal.
  2. Angle units:
    CATDrwDimUnitDEGREE
    Degree.
    CATDrwDimUnitMINUTE
    Minute.
    CATDrwDimUnitSECOND
    Second.
    CATDrwDimUnitRADIAN
    Radian.
    CATDrwDimUnitGRADE
    Grade.
Returns:
S_OK
if everything ran ok,
S_UNDEFINED
if the property isn't set,
E_FAIL
if a problem occured.
o GetFormatName
public virtual HRESULT GetFormatName(CATUnicodeString& oDescr) const = 0
Gets the format name.
Parameters:
oDescr
[out] Name of the format
Returns:
S_OK
if everything ran ok,
S_UNDEFINED
if the property isn't set,
E_FAIL
if a problem occured.
o GetFormatPrecision
public virtual HRESULT GetFormatPrecision(double& oPrecision) const = 0
Gets the precision.
Parameters:
oPrecision
[out] Precision value.
Returns:
S_OK
if everything ran ok,
S_UNDEFINED
if the property isn't set,
E_FAIL
if a problem occured.
o GetFormatType
public virtual HRESULT GetFormatType(int& oType) const = 0
Gets the type.
Parameters:
oType
[out] Format Type
Legal values are: (see define definition file)
CATDrwDimFormatDec
Decimal.
CATDrwDimFormatFrac
Fractional.
Returns:
S_OK
if everything ran ok,
S_UNDEFINED
if the property isn't set,
E_FAIL
if a problem occured.
o GetFormatUnit
public virtual HRESULT GetFormatUnit(int& oUnit) const = 0
Gets the unit.
Parameters:
oUnit
[out] The Unit
Legal values are: (see define definition file)
  1. Length units:
    CATDrwDimUnitNone
    None unit.
    CATDrwDimUnitMM
    Millimeter.
    CATDrwDimUnitINCH
    Inch.
    CATDrwDimUnitMETER
    Meter.
    CATDrwDimUnitCM
    Centimeter.
    CATDrwDimUnitKM
    Kilometer.
    CATDrwDimUnitFOOT
    Foot.
    CATDrwDimUnitF_I_F64
    Feet Inch Fraction 1/64.
    CATDrwDimUnitF_I_F16
    Feet Inch Fraction 1/16.
    CATDrwDimUnitF_I_DEC
    Feet Inch decimal.
  2. Angle units:
    CATDrwDimUnitDEGREE
    Degree.
    CATDrwDimUnitMINUTE
    Minute.
    CATDrwDimUnitSECOND
    Second.
    CATDrwDimUnitRADIAN
    Radian.
    CATDrwDimUnitGRADE
    Grade.
Returns:
S_OK
if everything ran ok,
S_UNDEFINED
if the property isn't set,
E_FAIL
if a problem occured.
o GetLabel
public virtual int GetLabel(CATUnicodeString& oDescr) = 0
Deprecated:
V5R18 use #GetFormatName
o GetPrecision
public virtual double GetPrecision()const = 0
Deprecated:
V5R18 use #GetFormatPrecision
o GetType
public virtual int GetType()const = 0
Deprecated:
V5R18 use #GetFormatType
o GetUnit
public virtual int GetUnit()const = 0
Deprecated:
V5R18 use #GetFormatUnit
o SetDisplayFactor
public virtual void SetDisplayFactor(int iFact)= 0
Deprecated:
V5R18 use #SetFormatDisplayFactor
o SetFormatDisplayFactor
public virtual HRESULT SetFormatDisplayFactor( const int& iFact)= 0
Sets the level of factor to be displayed.
Parameters:
iFact
[in] Display factor
Returns:
S_OK
if everything ran ok,
E_INVALIDARG
if the property couldn't be set for compatibilty reasons,
E_FAIL
if a problem occured.
o SetFormatName
public virtual HRESULT SetFormatName( const CATUnicodeString& name)= 0
Sets the format name.
Parameters:
name
[inout] Name of the format
Returns:
S_OK
if everything ran ok,
E_INVALIDARG
if the description isn't avaliable,
E_FAIL
if a problem occured.
o SetFormatPrecision
public virtual HRESULT SetFormatPrecision( const double& iPrecision)= 0
Sets the precision.
Parameters:
iPrecision
[in] Precision value.
Returns:
S_OK
if everything ran ok,
E_INVALIDARG
if the property couldn't be set for compatibilty reasons,
E_FAIL
if a problem occured.
o SetFormatType
public virtual HRESULT SetFormatType( const int& iType)= 0
Sets the type.
Parameters:
iType
[in] Type.
Legal values are: (see define definition file)
CATDrwDimFormatDec
Decimal.
CATDrwDimFormatFrac
Fractional.
Returns:
S_OK
if everything ran ok,
E_INVALIDARG
if the property couldn't be set for compatibilty reasons,
E_FAIL
if a problem occured.
o SetFormatUnit
public virtual HRESULT SetFormatUnit( const int& iUnit)= 0
Sets the unit.
Parameters:
iUnit
Unit.
Legal values are: (see define definition file)
  1. Length units:
    CATDrwDimUnitNone
    None unit.
    CATDrwDimUnitMM
    Millimeter.
    CATDrwDimUnitINCH
    Inch.
    CATDrwDimUnitMETER
    Meter.
    CATDrwDimUnitCM
    Centimeter.
    CATDrwDimUnitKM
    Kilometer.
    CATDrwDimUnitFOOT
    Foot.
    CATDrwDimUnitF_I_F64
    Feet Inch Fraction 1/64.
    CATDrwDimUnitF_I_F16
    Feet Inch Fraction 1/16.
    CATDrwDimUnitF_I_DEC
    Feet Inch decimal.
  2. Angle units:
    CATDrwDimUnitDEGREE
    Degree.
    CATDrwDimUnitMINUTE
    Minute.
    CATDrwDimUnitSECOND
    Second.
    CATDrwDimUnitRADIAN
    Radian.
    CATDrwDimUnitGRADE
    Grade.
Returns:
S_OK
if everything ran ok,
E_INVALIDARG
if the property couldn't be set for compatibilty reasons,
E_FAIL
if a problem occured.
o SetLabel
public virtual void SetLabel(CATUnicodeString Name) =0
Deprecated:
V5R18 use #SetFormatName
o SetPrecision
public virtual void SetPrecision( const double iPrecision)= 0
Deprecated:
V5R18 use #SetFormatPrecision
o SetType
public virtual void SetType( const int iType)= 0
Deprecated:
V5R18 use #SetFormatType
o SetUnit
public virtual void SetUnit( const int iUnit)= 0
Deprecated:
V5R18 use #SetFormatUnit
This object is included in the file: CATIDrwDimFormat.h
If needed, your Imakefile.mk should include the module: CATAnnotationUseItf

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.