Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMFastenerUseItf Interface CATIFmaStandardBrowse

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

interface CATIFmaStandardBrowse

Fastener Standard.
Role : allows to access general Fastener Standard parameters definition.

Method Index

o Get2DAdditionalSymbol(CATUnicodeString*,CATUnicodeString&,CATUnicodeString&,int): Gets the drafting additional symbol assigned to a Parameter Value as specified in CATIA Fastener Standard.
o GetAppCategoryClassParametersID(CATListOfCATUnicodeString*,CATUnicodeString&): Gets the list of the CATIA Fastener Standard classification parameters for a given category name.
o GetClassParameterAppValues(CATICkeParm**,CATUnicodeString&): Gets the Cke parameter (multi valuated string type) that contains all the applicable values of the requested parameter.
o GetClassParameterValueSymbolMark(unsigned int*,CATUnicodeString&,CATUnicodeString&): Gets the Symbol Mark code assigned to a Parameter Value as specified in CATIA Fst Standard.
o GetDiameterColor(int*,int*,int*,double): Gets the color that was assigned to a given diameter value in the Fastener Standard definition.
o GetFeatureTypesID(CATListOfCATUnicodeString*): Gets the features types allowed by Fst standard.
o GetInstanceParametersID(CATListOfCATUnicodeString*): Gets the list of Fastener Instance attribute names as specified in CATIA Fastener Standard.
o GetPTypColor(int*,int*,int*,CATFmaFeatureType1,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Gets the color that was assigned to a given feature type, primary and secondary process type in the Fastener Standard definition.
o GetPTypIcon(CATUnicodeString&,CATFmaFeatureType1,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Gets the icon name (thumbnail) that was assigned to a given feature type (primary, secondary process type) in the Fastener Standard definition.
o GetPTypSymbol(unsigned int*,CATFmaFeatureType1,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Gets the symbol that was assigned to a given feature type (primary, secondary process type) in the Fastener Standard definition.
o GetProcessTyp1ID(CATListOfCATUnicodeString*,CATFmaFeatureType1,CATUnicodeString&): Gets the mandatory process primary type allowed by Fastener Standard for the specified feature type.
o GetProcessTyp2ID(CATListOfCATUnicodeString*,CATFmaFeatureType1,CATUnicodeString&,CATUnicodeString&): Gets all the secondary process types allowed by Fastener standard according to a feature type and process category search criteria.
o GetThicknessCountSymbol(unsigned int*,int): Gets the Symbol assigned to a given input Thickness Count as specified in CATIA Fst Standard.

Methods

o Get2DAdditionalSymbol

public virtual Get2DAdditionalSymbol(		`oAdditionalSymbolName`,
	const	`iParameter`,
	const	`iParameterValue`,
	const	`iDftSymbolIndex`)

Gets the drafting additional symbol assigned to a Parameter Value as specified in CATIA Fastener Standard.

Parameters:

oAdditionalSymbolName:: the additional symbol name
iParameter:: the Parameter
iParameterValue:: the Parameter Value
iDftSymbolIndex:: the additional symbol index (among 1 and 4)

o GetAppCategoryClassParametersID

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

Gets the list of the CATIA Fastener Standard classification parameters for a given category name.

Parameters:

oParameters: the parameters list.
iCategoryID: the category name.

o GetClassParameterAppValues

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

Gets the Cke parameter (multi valuated string type) that contains all the applicable values of the requested parameter.

Parameters:

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

o GetClassParameterValueSymbolMark

public virtual GetClassParameterValueSymbolMark(		`oSymbolMark`,
	const	`iParameter`,
	const	`iParameterValue`)

Gets the Symbol Mark code assigned to a Parameter Value as specified in CATIA Fst Standard.

Parameters:

oSymbolMark: The Mark Assignment (0: no Symbol Mark, 1: triangle Mark)
iParameter: the Parameter
iParameterValue: the Parameter Value

o GetDiameterColor

public virtual GetDiameterColor(		`oRedColor`,
		`oGreenColor`,
		`oBlueColor`,
	const	`iDiameterValue`)

Gets the color that was assigned to a given diameter value in the Fastener Standard definition.

Parameters:

oRedColor: the Red Color Value
oGreenColor: the Green Color Value
oBlueColor: the Blue Color Value
iDiameterValue: the diameter value

o GetFeatureTypesID

public virtual GetFeatureTypesID( oFeatureTypesList)

Gets the features types allowed by Fst standard.

Parameters:

oFeatureTypesList: list of feature types.

o GetInstanceParametersID

public virtual GetInstanceParametersID( oParameters)

Gets the list of Fastener Instance attribute names as specified in CATIA Fastener Standard.

Parameters:

oParameters:: the attribute names list

o GetPTypColor

public virtual GetPTypColor(		`oRedColor`,
		`oGreenColor`,
		`oBlueColor`,
	const	`iFTyp1`,
	const	`iFTyp2`,
	const	`iPTyp1`,
	const	`iPTyp2`)

Gets the color that was assigned to a given feature type, primary and secondary process type in the Fastener Standard definition.

Parameters:

oRedColor: the Red Color Value.
oGreenColor: the Green Color Value.
oBlueColor: the Blue Color Value.
iFTyp1: the primary feature type.
iFTyp2: the secondary feature type (can be empty string).
iPTyp1: the primary process type.
iPTyp2: the secondary process type (can be empty string).

o GetPTypIcon

public virtual GetPTypIcon(		`oIconName`,
	const	`iFTyp1`,
	const	`iFTyp2`,
	const	`iPTyp1`,
	const	`iPTyp2`)

Gets the icon name (thumbnail) that was assigned to a given feature type (primary, secondary process type) in the Fastener Standard definition.

Parameters:

oIconName: the icon name
iFTyp1: the primary feature type
iFTyp2: the secondary feature type (can be empty string)
iPTyp1: the primary process type
iPTyp2: the secondary process type (can be empty string)

o GetPTypSymbol

public virtual GetPTypSymbol(		`oSymbolValue`,
	const	`iFTyp1`,
	const	`iFTyp2`,
	const	`iPTyp1`,
	const	`iPTyp2`)

Gets the symbol that was assigned to a given feature type (primary, secondary process type) in the Fastener Standard definition.

Parameters:

oSymbolValue: the returned Symbol Value
iFTyp1: the primary feature type
iFTyp2: the secondary feature type (can be empty string)
iPTyp1: the primary process type
iPTyp2: the secondary process type (can be empty string)

o GetProcessTyp1ID

public virtual GetProcessTyp1ID(		`oProcessTyp1List`,
	const	`iFTyp1`,
	const	`iFTyp2`)

Gets the mandatory process primary type allowed by Fastener Standard for the specified feature type.

Parameters:

oProcessTyp1List: list of process categories.
iFTyp1: the primary feature type.
iFTyp2: the secondary feature type (can be empty string). If null, the process categories for all types of features are returned.

o GetProcessTyp2ID

public virtual GetProcessTyp2ID(		`oProcessTyp2List`,
	const	`iFTyp1`,
	const	`iFTyp2`,
	const	`iPTyp1`)

Gets all the secondary process types allowed by Fastener standard according to a feature type and process category search criteria.

Parameters:

oProcessTyp2List: list of secondary process types.
iFTyp1: the primary feature type.
iFTyp2: the secondary feature type (can be empty string).
iPTyp1: the primary process type.

o GetThicknessCountSymbol

public virtual GetThicknessCountSymbol(		`oSymbolValue`,
	const	`iThicknessCount`)

Gets the Symbol assigned to a given input Thickness Count as specified in CATIA Fst Standard.

Parameters:

oSymbolValue: the symbol value
oSymbolValue: the Thickness Count

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