All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMFmaModelerInterfaces Interface CATIFmaStandardServices

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

interface CATIFmaStandardServices

This service class provides access to the Fastener Standard and Fastener Type Standard.
Note: This information is not persistent.

Method Index

o CreateGetFstStandard(CATBaseUnknown**,CATBoolean,IID&): Gets (and creates if required) the Fst Standard object in session.
o CreateGetFstType(CATBaseUnknown**,CATBoolean,CATFmaFeatureType1,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,IID&): Gets (and creates if required) the Reference Fastener Type Standard object in Session.
o DecodeFastenerType(CATFmaFeatureType1*,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Returns the associated primary feature type, the secondary feature type (if defined), the primary process type, the secondary process type from the completed Fastener Type ID.
o DecodeFeatureType(CATFmaFeatureType1*,CATUnicodeString&,CATUnicodeString&): Returns the associated primary feature type and the secondary feature type (if defined) from the completed Feature Type name.

Methods

o CreateGetFstStandard

public virtual CreateGetFstStandard(		`oFstStandard`,
	const	`iCreate`,
	const	`iIID`	`= IID_CATIFmaStandardBrowse`)

Gets (and creates if required) the Fst Standard object in session.

Parameters:

oFstStandard: [out, CATBaseUnknown#Release] the Fst Standard object.
iCreate: TRUE in order to force the creation of the Fastener Standard object if it doesn’t already existed, else FALSE.
iIID: the required interface.

Returns:

S_OK: if the Fst Standard was successfully retrieved.
E_FAIL: otherwise.

o CreateGetFstType

public virtual CreateGetFstType(		`oFstType`,
	const	`iCreate`,
	const	`iFTyp1`,
	const	`iFTyp2`,
	const	`iPTyp1`,
	const	`iPTyp2`,
	const	`iIID`	`= IID_CATIFmaTypeBrowse`)

Gets (and creates if required) the Reference Fastener Type Standard object in Session.

Parameters:

oFstType: [out, CATBaseUnknown#Release] the reference fastener type standard object.
iCreate: TRUE in order to force the creation of the Reference Fastener Type Standard object if it doesn’t already existed, else FALSE.
iFTyp1: the primary PLM Fastener Model Feature Type. It must be CATFstSpotAssy for SpotAssembly fastener.
iFTyp2: the secondary feature type.
iPTyp1: the primary process type.
iPTyp2: the secondary process type.
iIID: the required interface.

Returns:

S_OK: if the Reference Fastener Type Standard was successfully retrieved.
E_FAIL: otherwise.

o DecodeFastenerType

public virtual DecodeFastenerType(		`oFTyp1`,
		`oFTyp2`,
		`oPTyp1`,
		`oPTyp2`,
	const	`iFstTypeID`)

Returns the associated primary feature type, the secondary feature type (if defined), the primary process type, the secondary process type from the completed Fastener Type ID.

Parameters:

oFTyp1: the primary feature type.
oFTyp2: secondary feature type (can be empty string).
oPTyp1: the primary Process type.
oPTyp2: the secondary Process type.
iFstTypeID: the Fastener type descriptor.

Returns:

S_OK: when operation is successful.
E_FAIL: if an error has occured.

o DecodeFeatureType

public virtual DecodeFeatureType(		`oFTyp1`,
		`oFTyp2`,
	const	`iFeatureTypeID`)

Returns the associated primary feature type and the secondary feature type (if defined) from the completed Feature Type name.

Parameters:

oFTyp1: the primary feature type.
oFTyp2: secondary feature type (can be empty string).
iFeatureTypeID: if the primary feature type and secondary feature type (if defined) were successfully retrieved.

Returns:

S_OK: if the Fst Standard was successfully retrieved.
E_FAIL: otherwise.

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