CATPLMFastenerUseItf Interface CATIFmaTypeBrowse

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

interface CATIFmaTypeBrowse

Fastener Type.
Role : allows to get the fastener standard parameters of a given reference fastener type.

Method Index

o GetAppCategoryClassParametersID(CATListOfCATUnicodeString*,CATUnicodeString&): Gets all the applicable classification parameters for a given category defined for this Fastener Type.
o GetClassParameterAppValues(CATICkeParm**,CATUnicodeString&): Gets the knowledge parameter that contains the applicable values of the requested parameter.
o GetCompLocationOffsetParam(CATFmaCompOffsetMode*,CATUnicodeString&,CATUnicodeString&): Gets the translation constraint for a given component with respect to Fastener Axis system along I or J or K axis.
o GetCompShapeDefinitionAppValues(CATListOfCATUnicodeString*,CATUnicodeString&): Gets the list of applicable shape definition of a given component.
o GetCompShapeDefinitionParamID(CATListOfCATUnicodeString*,CATUnicodeString&): Gets the list of applicable shape definition parameter for a given shape definition.
o GetFastenerComponentsCount(int*): Gets the number of associated components.
o GetFastenerComponentsID(CATListOfCATUnicodeString*): Gets the list of component names.

Methods

o GetAppCategoryClassParametersID

public virtual GetAppCategoryClassParametersID(		`oParameters`,
	const	`iCategoryID`)

Gets all the applicable classification parameters for a given category defined for this Fastener Type.

Parameters:

oParameters: the associated classification parameters.
iCategoryID: the category name.

o GetClassParameterAppValues

public virtual GetClassParameterAppValues(		`oParm`,
	const	`iParameterID`)

Gets the knowledge parameter that contains the applicable values of the requested parameter. This method has to be used for any engineering, manufacturing or user classification parameter.

Parameters:

oParm: [out, CATICkeParm#Release] the requested parameter
iParameterID: the parameter name

o GetCompLocationOffsetParam

public virtual GetCompLocationOffsetParam(		`oOffsetMode`,
	const	`iLocOffsetParamID`,
	const	`iCompID`)

Gets the translation constraint for a given component with respect to Fastener Axis system along I or J or K axis.

Parameters:

oOffsetMode

the translation type. It may have several values:

CATFmaNone : no translation is expected
CATFmaPos: a positive or null translation along the specified direction is expected
CATFmaNeg: a negative or null translation along the specified direction is expected
CATFmaUnspec: no constraint is expected

iLocOffsetParamID

the location offset parameter name (IOFFSET, JOFFSET, KOFFSET)

iCompID

the component ID

o GetCompShapeDefinitionAppValues

public virtual GetCompShapeDefinitionAppValues(		`oAppShapeID`,
	const	`iCompID`)

Gets the list of applicable shape definition of a given component.

Parameters:

oAppShapeID: the list of applicable shape definitions
iCompID: the component ID

o GetCompShapeDefinitionParamID

public virtual GetCompShapeDefinitionParamID(		`oShapeParamID`,
	const	`iShapeID`)

Gets the list of applicable shape definition parameter for a given shape definition.

Parameters:

oShapeParamID: the list of applicable shape definition parameters for the specified shape definition
iShapeID: the Shape Definition ID

o GetFastenerComponentsCount

public virtual GetFastenerComponentsCount( oCompNb)

Gets the number of associated components.

Parameters:

oCompNb: the number of components.

o GetFastenerComponentsID

public virtual GetFastenerComponentsID( oCompID)

Gets the list of component names.

Parameters:

oCompID: the list of the component names

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