KnowledgeInterfaces Interface CATICkeScalesServices

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

interface CATICkeScalesServices

Role: This interface is mono implemented.
It is obtained from CATCkeGlobalFunctions::GetScalesServices() method.

Method Index

o GetActivatedScales(): Gets the list of scales that are currently used
o GetCATToleranceFromObject(CATBaseUnknown_var&): This method returns the tolerance associated to the scale deduced from the object
o GetCurrentScale(): This method returns the current design range chosen in preferences
o GetScaleFromObject(CATBaseUnknown_var&,CATCkeScale&): This method allows retrieving the scale of the PLM Component containing the object passed in argument
o GetScaleName(CATCkeScale): This method returns the NLS name of a given scale
o IsScaleSettingLocked(): This method checks if the scale setting can be modified by the caller or not
o SetCurrentScale(CATCkeScale): This method sets the current design range in preferences.

Methods

o GetActivatedScales

public virtual GetActivatedScales(

)

Gets the list of scales that are currently used

Returns:: a list of integers : each integer is the result of the cast of a CATCkeScale enum value into integer

o GetCATToleranceFromObject

public virtual GetCATToleranceFromObject( const iObject)

This method returns the tolerance associated to the scale deduced from the object

Parameters:

iObject: can be any linkable object. The tolerance is deduced from the scale retrieved from the PLM Component containing iObject

Returns:

the tolerance associated to the scale deduced from object. It returns normal scale tolerance if the scale cannot be deduced from the passed object

o GetCurrentScale

public virtual GetCurrentScale(

)

This method returns the current design range chosen in preferences

Returns:: the current scale

o GetScaleFromObject

public virtual GetScaleFromObject(	const	`iObject`,
		`oScale`)

This method allows retrieving the scale of the PLM Component containing the object passed in argument

Parameters:

iObject: can be any linkable object. The scale is retrieved from the PLM Component containing iObject
oScale: the scale found on PLM component. It is equal to CATNormalScale if the PLM Component does not support scales management

Returns:

S_OK if the method succeds, E_FAIL if passed object does not allow retrieving PLM component, E_POINTER if passed object is NULL_var

o GetScaleName

public virtual GetScaleName( iScale)

This method returns the NLS name of a given scale

Parameters:

iScale: the scale whose name is looked for

Returns:

the translated name of the passed scale

o IsScaleSettingLocked

public virtual IsScaleSettingLocked(

)

This method checks if the scale setting can be modified by the caller or not

Returns:: TRUE if the setting is locked, FALSE otherwise

o SetCurrentScale

public virtual SetCurrentScale( iScale)

This method sets the current design range in preferences. The setting mustn't be locked by an administrator

Parameters:

iScale: the scale factor to set as current one. This scale has to one of the activated scales (@see GetActivatedScales)

Returns:

S_OK if the method succeeds, E_FAIL otherwise

This object is included in the file: CATICkeScalesServices.h
If needed, your Imakefile.mk should include the module: KnowledgeItf