All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATMecModUseItf Interface CATIMmiUseStructureAnalyse

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

interface CATIMmiUseStructureAnalyse

Interface used to retrieve parents and children in the mechanical structure.
Role: it shows the relationships between the different elements, based on defined inputs and outputs.

Note : for dressup features, the parent of a feature is not necessarily the previous feature in the tree but the feature used initially to build the feature. If a feature is not visible in the tree, it is replaced by its closest visible feature.

The interface may be used to retrieve the impacts of deletion : if a feature is deleted, it may be becessary to delete its children (otherwise, they may be broken). It is also possible to delete some of its parents (if they are no longer needed).

Method Index

o GetAllStructuralChildren(CATClassId,CATListValCATBaseUnknown_var&): Retrieves recursively all the children of the current object.
o GetAllStructuralParents(CATClassId,CATListValCATBaseUnknown_var&): Retrieves recursively all the parents of the current object.
o GetDirectStructuralChildren(CATClassId,CATListValCATBaseUnknown_var&): Retrieves the direct children of the current object.
o GetDirectStructuralParents(CATClassId,CATListValCATBaseUnknown_var&): Retrieves the direct parents of the current object.

Methods

o GetAllStructuralChildren

public virtual GetAllStructuralChildren(		`iIntfName`,
		`oList`)

Retrieves recursively all the children of the current object.

Parameters:

iIntfName: Name of the interface filtering the kind of objects to be returned.
oList: The list of all children of the current object.

Returns:

This method returns S_OK if the operation went through successfully and E_FAIL otherwise.

o GetAllStructuralParents

public virtual GetAllStructuralParents(		`iIntfName`,
		`oList`)

Retrieves recursively all the parents of the current object.

Parameters:

iIntfName: Name of the interface filtering the kind of objects to be returned.
oList: The list of all parents of the current object.

Returns:

This method returns S_OK if the operation went through successfully and E_FAIL otherwise.

o GetDirectStructuralChildren

public virtual GetDirectStructuralChildren(		`iIntfName`,
		`oList`)

Retrieves the direct children of the current object.

Parameters:

iIntfName: Name of the interface filtering the kind of objects to be returned.
oList: The list of direct children of the current object.

Returns:

This method returns S_OK if the operation went through successfully and E_FAIL otherwise.

o GetDirectStructuralParents

public virtual GetDirectStructuralParents(		`iIntfName`,
		`oList`)

Retrieves the direct parents of the current object.

Parameters:

iIntfName: Name of the interface filtering the kind of objects to be returned.
oList: The list of direct parents of the current object.

Returns:

This method returns S_OK if the operation went through successfully and E_FAIL otherwise.

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