Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMFmaModelerInterfaces Interface CATIFmaPLMFactoryServices

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

interface CATIFmaPLMFactoryServices

Interface to give the capability to extend a specified reference product into a Fastener one.

Method Index

o CreateFastenerReferenceFromType(CATBaseUnknown**,CATIType_var&,CATIType_var&,CATFmaFeatureType1,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): This method creates a CATIA Fastener Product reference and a new PLM Fastener Representation compatible with 'New Typing' system.
o CreateMCXAsFastener(CATBaseUnknown**,CATBaseUnknown*)
o CreateMCXAsFastenerFromType(CATBaseUnknown**,CATBaseUnknown*,CATIType_var&): This method creates a new PLM Fastener Connection compatible with 'New Typing' system.
o ExtendMCXAsFastener(CATBaseUnknown*)
o ExtendPrdAsFastener(CATBaseUnknown*,CATFmaFeatureType1,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)

Methods

o CreateFastenerReferenceFromType

public virtual CreateFastenerReferenceFromType(		`opFstReferenceProduct`,
		`iFastenerType`,
		`iRepresentationType`,
	const	`iFTyp1`,
	const	`iFTyp2`,
	const	`iPTyp1`,
	const	`iPTyp2`,
	const	`iCatalogID`,
	const	`iClientID`)

This method creates a CATIA Fastener Product reference and a new PLM Fastener Representation compatible with 'New Typing' system. Both Fastener & Representation are of Knowledge type as defined in the metadata. It also creates into the Fastener representation, the fastener Feature in the CATFastenerCont container. The type of feature is given by input iFTyp1 and iFTyp2 parameters. It retrieves the created CAA fastener feature created thanks to iFTyp2 (see below explanations) and aggregates it as a child of the Mechanical Part feature. For information, this method sets the PLM Fastener Reference Exposed attributes:

the VPMReference and VPMRepReference V_Discipline attributes.
the "Fastener" exposed V_FastenerType attribute is set to a string built from the input Fastener Feature Type name FTyp (iFTyp1, iFTyp2) and the Fastener Process Type PTyp (iPTyp1, iPTyp2) parameters according to the following rules:

Feature type FTyp is built by concatenating the PLM Fastener Feature Type and if it exists the specific CAA Applicative input Feature Type iFTyp2.
Process type PTyp is built by concatenating (Use “!” Character as a separator) the primary iPTyp1 string parameter with the secondary parameter iPTyp2 if iPTyp2 is not a Null string.
The full Fastener Type descriptor is built by concatenating iFTyp and iPTyp (Use “_” Character as separator).

It also adds the dynamic attributes (see data model) and set-up their default values.

Parameters:

opFstReferenceProduct

created Fastener product reference.

iFastenerType

the Knowledge type for Fastener reference (can be a modeler type, a discipline at creation of a functional specialization)

iRepresentationType

the Knowledge type for Fastener Representation (can be a modeler type, a discipline at creation of a functional specialization) currently, creation of Fastener Representation of user-defined Knowledge type is not supported. Hence this argument must be passed as NULL_var.

iFTyp1

the primary PLM Fastener Model Feature Type. It must be CATFstSpotAssy for SpotAssembly fastener creation. It may have several values:

CATFstSpot for Fst_Spot creation (like fasteners are generated by the DS Automotive Body in White Fasteners application).
CATFstBead for Fst_Bead creation (like fasteners are generated by the DS F&A fasteners application.
CATFstSpotAssy for Fst_SpotAssy creation (like fasteners will be generated in further released by DS mechanical Fasteners applications).

iFTyp2

the secondary feature type.

iPTyp1

the primary process type.

iPTyp2

the secondary process type.

iCatalogID

the catalog name containing the iFTyp2 CAA feature.

iClientID

the client id related to catalog iCatalogID.

Returns:

S_OK: if this Product Reference was successfully extended to a PLM Fastener product reference.
E_FAIL: otherwise.

o CreateMCXAsFastener

public virtual CreateMCXAsFastener(		`opMCX`,
		`ipRootReference`)

Deprecated:

R214 use
This method creates a new PLM Fastener Connection implemented by a given fastener instance in a given root reference product.

Parameters:

ipRootReference: [in] the root reference product that will contain the created Engineering Connection.
opMCX: [out, CATBaseUnknown#Release] the created Engineering Connection.

Returns:

S_OK: if the Engineering Connection has been successfully created and extended with fastener properties.
E_INVALIDARG: if ipRootReference is NULL or not a reference product.
E_FAIL: otherwise.

o CreateMCXAsFastenerFromType

public virtual CreateMCXAsFastenerFromType(		`opMCX`,
		`ipRootReference`,
		`iMCXType`)

This method creates a new PLM Fastener Connection compatible with 'New Typing' system.

Parameters:

ipRootReference: [in] the root reference product that will contain the created Engineering Connection.
iMCXType: [in] the Knowledge type for Connection if passed NULL_var handler, then standard Connection will be created
opMCX: [out, CATBaseUnknown#Release] the created Engineering Connection.

Returns:

S_OK: if the Engineering Connection has been successfully created and extended with fastener properties.
E_INVALIDARG: if ipRootReference is NULL or not a reference product.
E_FAIL: otherwise.

o ExtendMCXAsFastener

public virtual ExtendMCXAsFastener( iopMCX)

Deprecated:

R214 use
This method enriches a newly created Engineering Connection into a PLM Fastener Connection implemented by a given fastener instance.

Parameters:

iopMCX: the newly created Engineering Connection.

Returns:

S_OK: if the Engineering Connection has been successfully extended with fastener properties.
E_INVALIDARG: if iopMCX is NULL or not an engineering connection.
E_FAIL: otherwise.

o ExtendPrdAsFastener

public virtual ExtendPrdAsFastener(		`ipReference`,
	const	`iFTyp1`,
	const	`iFTyp2`,
	const	`iPTyp1`,
	const	`iPTyp2`,
	const	`iCatalogID`,
	const	`iClientID`)

Deprecated:

R214 use
This method creates a CATIA Fastener in a new PLM Fastener Representation associated to the input Reference Product. The new created Fastener is exposed by the input reference product thanks to the creation of a PLM Fastener Extension whose Type and Fastener Type descriptor are set depending on the input PLM Fastener Type Template. It also creates into the Fastener representation, the fastener Feature in the CATFastenerCont container. The type of feature is given by input iFTyp1 and iFTyp2 parameters. It retrieves the created CAA fastener feature created thanks to iFTyp2 (see below explanations) and aggregates it as a child of the Mechanical Part feature. For information, this method sets the PLM Fastener Reference Exposed attributes:

the VPMReference and VPMRepReference V_Discipline attributes.
the PLM extension exposed V_Fastener Type attribute is set to a string built from the input Fastener Feature Type name FTyp (iFTyp1, iFTyp2) and the Fastener Process Type PTyp (iPTyp1, iPTyp2) parameters according to the following rules:

Feature type FTyp is built by concatenating the PLM Fastener Feature Type and if it exists the specific CAA Applicative input Feature Type iFTyp2.
Process type PTyp is built by concatenating (Use “!” Character as a separator) the primary iPTyp1 string parameter with the secondary parameter iPTyp2 if iPTyp2 is not a Null string.
The full Fastener Type descriptor is built by concatenating iFTyp and iPTyp (Use “_” Character as separator).

It also adds the dynamic attributes (see data model) and set-up their default values.

Parameters:

ipReference

product reference to extend as a fastener one.

iFTyp1

the primary PLM Fastener Model Feature Type. It must be CATFstSpotAssy for SpotAssembly fastener creation. It may have several values:

CATFstSpot for Fst_Spot creation (like fasteners are generated by the DS Automotive Body in White Fasteners application).
CATFstBead for Fst_Bead creation (like fasteners are generated by the DS F&A fasteners application.
CATFstSpotAssy for Fst_SpotAssy creation (like fasteners will be generated in further released by DS mechanical Fasteners applications).

iFTyp2

the secondary feature type.

iPTyp1

the primary process type.

iPTyp2

the secondary process type.

iCatalogID

the catalog name containing the iFTyp2 CAA feature.

iClientID

the client id related to catalog iCatalogID.

Returns:

S_OK: if this Product Reference was successfully extended to a PLM Fastener product reference.
E_FAIL: otherwise.

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