All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATKinMechanismUseItf Interface CATIKinematicsServices

SystemTS.IUnknown

System.IDispatch

System.CATBaseUnknown

CATIKinematicsServices

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

interface CATIKinematicsServices

Kinematics interface Role: This interface contains method(s) dedicated for kinematics.

This interface is implemented on the CATKinematicsService component. It contains a method which gives a pointer on this component which adheres to CATIKinematicsServices interfaces.

Example:

     CATIKinematicsServices *pKinServices =  CATKinGetKinematicsService();
  
 use pKinServices::GetListOfMechanisms(...) 
  
 pKinServices->release(); pKinServices=NULL;

Method Index

o CreateMechanism(CATIPLMProducts_var,CATIKinematicsMechanism_var&,CATIType*): Create a Mechanism.
o GetListOfMechanisms(CATIPLMProducts_var&,CATListValCATBaseUnknown_var&): Returns the list all mechanisms in a given product.

Methods

o CreateMechanism

public virtual HRESULT CreateMechanism(	CATIPLMProducts_var	`iProd`,
	CATIKinematicsMechanism_var&	`oMechanism`,
	CATIType*	`iType`	`= NULL` )=0

Create a Mechanism.

Parameters:

iProd: The product which will contain the mechanisms.
oMechanism: The Created Mechanism.
iType: Optionnal parameter which allows to create a mechanim for a given Representation Type.

Returns:

HRESULT

o GetListOfMechanisms

public virtual HRESULT GetListOfMechanisms(	const CATIPLMProducts_var&	`iProd`,
	CATListValCATBaseUnknown_var&	`oListOfMechanisms`) const = 0

Returns the list all mechanisms in a given product.

Example:

 CATIPLMProducts_var Product;
 
CATListValCATBaseUnknown_var ListOfMechanisms ;
 
HRESULT = CATIKinematicsServices::GetListOfMechanisms(Product,ListOfMechanisms);

Parameters:

iProd: The product which contains the mechanisms.
oListOfMechanisms: The list of all mechanisms belonging to the product. The list should be defined and managed by the caller.

Returns:

HRESULT

See also:

CATListValCATBaseUnknown_var

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