All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPartUseItf Interface CATIPdgUseShape

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

interface CATIPdgUseShape

Interface which provides a basic behavior to a Mechanical Design feature.
Role: This interface allows users to manage the persistence of default values. It also provides various informations about the feature.

Method Index

o GetDefaultValue(CATUnicodeString&,int&): Retrieves a integer type default value.
o GetDefaultValue(CATUnicodeString&,double&): Retrieves a double type default value.
o GetDefaultValue(CATUnicodeString&,CATIMmiMechanicalFeature_var&): Retrieves a CATISpecObject type default value.
o IsFirstInTool(): Tests if the feature was created in first position in its mechanical body.
o SetDefaultValue(CATUnicodeString&,int): Stores a default value of integer type.
o SetDefaultValue(CATUnicodeString&,double): Stores a default value of double type.
o SetDefaultValue(CATUnicodeString&,CATBaseUnknown_var&): Stores a default value of CATISpecObject type.

Methods

o GetDefaultValue

public virtual GetDefaultValue(	const	`iStr`,
		`oVal`)

Retrieves a integer type default value.

Parameters:

iStr: The storage name.
oVal: The value.

o GetDefaultValue

public virtual GetDefaultValue(	const	`iStr`,
		`oVal`)

Retrieves a double type default value.

Parameters:

iStr: The storage name.
oVal: The value.

o GetDefaultValue

public virtual GetDefaultValue(	const	`iStr`,
		`oVal_output`)

Retrieves a CATISpecObject type default value.

Parameters:

iStr: The storage name.
oVal: The value.

o IsFirstInTool

public virtual IsFirstInTool(

)

Tests if the feature was created in first position in its mechanical body.

Returns:: 1 if the feature is in first position, 0 otherwise.

o SetDefaultValue

public virtual SetDefaultValue(	const	`iStr`,
		`iVal`)

Stores a default value of integer type.

Parameters:

iStr: The storage name. Use a characteristic name to avoid naming conflicts.
iVal: The value.

o SetDefaultValue

public virtual SetDefaultValue(	const	`iStr`,
		`iVal`)

Stores a default value of double type.

Parameters:

iStr: The storage name. Use a characteristic name to avoid naming conflicts.
iVal: The value.

o SetDefaultValue

public virtual SetDefaultValue(	const	`iStr`,
	const	`iVal_input`)

Stores a default value of CATISpecObject type.

Parameters:

iStr: The storage name. Use a characteristic name to avoid naming conflicts.
iVal: The value.

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