All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATMatInterfaces Interface CATIMaterialReferenceFactory

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

interface CATIMaterialReferenceFactory

Interface representing the factory of Material References.

Example:

 How to use it. 
  

  CATIMaterialReferenceFactory * piMatFact  =  NULL;  

  CATMaterialTools::GetMaterialFactory( piMatFact ) ;

  piMatFact -> CreateMaterialReference( ... ) ; 

  piMatFact -> Release() ; piMatFact = NULL ;

See also:

Method Index

o CreateMaterialReference(CATIType_var&,CATIMaterialReference*&,CATLISTV(CATICkeParm_var)*,CATIAdpEnvironment*): Creates and returns a new Material Reference.
o ListReferences(CATListValCATBaseUnknown_var&): Returns the list of materials in session.

Methods

o CreateMaterialReference

public virtual CreateMaterialReference(	const	`iType`,
		`opiMaterialReference`,
		`ipListAttributes`	`= NULL`,
	const	`ipiEnv`	`= NULL` )

Creates and returns a new Material Reference.
During the creation the initilization Business Logic is called to ensure all necessary attributes are valuated.

Parameters:

iType: Type of material reference to create. Can be Core, Covering or a customized type.
opiMaterialReference: [out, CATBaseUnknow#Release] The created material reference.
iListAttributes: List of attributes to valuate on the created material reference (may overide values computed by BL)
ipiEnv: The environment (if NULL, the current one is used).

Returns:

An HRESULT
Legal values:

S_OK: The reference was successfully created.
E_FAIL: The operation failed. Nothing created.

Example:

 To create a CATIType. 
  

 CATIType_var spiCoreType = NULL_var ; 

 CATMaterialTools::GetMaterialCoreType( spiCoreType ) ;

See also:

o ListReferences

public virtual ListReferences( ioReferencesList)

Returns the list of materials in session.

Parameters:

ioReferenceList: The list of material references in session.
If the list is not given empty, materials are added at the end of the list

Returns:

An HRESULT
Legal values:

S_OK: The list of materials was successfully returned.
E_FAIL: The operation failed. Nothing returned.

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