All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMUIInterfaces Interface CATIPLMNewFactory

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

interface CATIPLMNewFactory

Interface representing factory for PLM New Entity Creation.

Role: allows you to get a handle on PLM object created by the interactive launch of PLM New command. It provides definition for the PLM entity creation. Only unitary object can be created by this protocole and only a subset of all possible PLM entities can be created by this protocole.

See also:

Method Index

o CreateCommand(CATStateCommand*&): Method to create the PLM New interactive command.
o GetCreatedObject(CATBaseUnknown*&): Method to retrieve the PLM Object created through PLM New command.
o SetCustomizationScope(CATString): Method to OPTIONALLY specify which customization domain to use for PLM object creation.
o SetModelingScope(CATClassId,CATString): Mandatory Method to define the PLM object to create with the PLM Creation Method Name and the dedicated CAA interface.

Methods

o CreateCommand

public virtual CreateCommand( opNewCmd)

Method to create the PLM New interactive command.

Parameters:

opNewCmd: Output Interactive State command PLM New.
The returned command has not to be released because its life cycle is managed by DialogEngine.

Returns:

S_OK : PLM New command creation succeeds.
E_FAIL: PLM New command creation failed.

o GetCreatedObject

public virtual GetCreatedObject( oCAASpecialized)

Method to retrieve the PLM Object created through PLM New command.

Parameters:

oCAASpecialized: Output Resulting interface of the created object. The returned object has not to be released.

Returns:

S_OK : The PLM object creation succeeds.
E_FAILED: The PLM object creation fails.

o SetCustomizationScope

public virtual SetCustomizationScope( iDomain)

Method to OPTIONALLY specify which customization domain to use for PLM object creation.

Parameters:

iDomain: Input customization domain name. Is optional, can be undefined.
If this parameter is not set, then the data are created in the default authoring customization domain.
If this parameter is set, then the input customization domain is used to create the PLM data.
This domain is checked and set as current when the CreateCommand method is called and it stays as currrent as long as the current class is not released or as long as another occurence of this class is called to set the customization domain.
For instance iDomain="CAABodyPartView" to create "Body Part View" CAA sample Part Reference.

Returns:

S_OK : Method succeeds.
E_FAIL: Method fails.

o SetModelingScope

public virtual SetModelingScope(		`iCAASpecializedItf`,
		`iPLMCreationMethodType`)

Mandatory Method to define the PLM object to create with the PLM Creation Method Name and the dedicated CAA interface.
Mandatory Method for a successful return code.

Parameters:

iCAASpecializedItf

Input CAA defining interface which the object must adhere to.

iPLMCreationMethodType

Input Name of PLM Creation Method Type (ex: “Drawing”).

Current implemented capabilities:

iCAASpecializedItf = CATIPLMProducts::ClassName and iPLMCreationMethodType="" : To create a new Product.
iCAASpecializedItf = CATIPLMProducts::ClassName and iPLMCreationMethodType="3DPart" : To create a new 3DPart.
iCAASpecializedItf = CATIPsiRepresentationReference::ClassName and iPLMCreationMethodType="3DShape" : To create a new 3DShape.
iCAASpecializedItf = CATIPsiRepresentationReference::ClassName and iPLMCreationMethodType="Drawing" : To create a new Drawing.

Returns:

S_OK : Initialization successful.
E_FAIL: Initialization failed.

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