All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectSpecsModeler Interface CATIDescendants

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIDescendants
 

Usage: you can freely reimplement this interface.


interface CATIDescendants

Interface to manage ordered components' agregation within a feature.
Role: ability to scan the tree structure or to add components and order them.
Note: order in the list of components is important.


Method Index


o AddChild(CATISpecObject_var&,int)
Adds a component to this feature at a given position in the list of components agregated to this feature .
o Append(CATISpecObject_var&)
Adds a component to this feature at last position in the list of components agregated to this feature .
o ChangePosition(CATISpecObject_var&,int)
Modifies the position of a given component in the list of components agregated to this feature .
o GetAllChildren(CATClassId,CATListValCATISpecObject_var&)
Retrieves all children recursively.
o GetChildAtPosition(int)
Gets a component by its position in the list of components agregated to this feature .
o GetDirectChildren(CATClassId,CATListValCATISpecObject_var&)
Retrieves all direct children.
o GetNumberOfChildren()
Returns number of components agregated to this feature.
o GetPosition(CATISpecObject_var&)
Returns the position of a given component in the list of components agregated to this feature .
o Prepend(CATISpecObject_var&)
Adds a component to this feature at first position in the list of components agregated to this feature .
o RemoveChild(CATISpecObject_var&)
Removes a given component from this feature .

Methods


o AddChild
public virtual void AddChild( const CATISpecObject_var& iFeature,
int iPosition) = 0
Adds a component to this feature at a given position in the list of components agregated to this feature ..
Parameters:
iFeature
SpecObject to add as a component.
iPosition
position of the component inside the list of agregated features.
o Append
public virtual void Append( const CATISpecObject_var& iFeature)= 0
Adds a component to this feature at last position in the list of components agregated to this feature .
Parameters:
iFeature
SpecObject to add as a component.
o ChangePosition
public virtual void ChangePosition( const CATISpecObject_var& iFeature,
int iNewPosition)= 0
Modifies the position of a given component in the list of components agregated to this feature .
Parameters:
iFeature
concerned component.
iNewPosition
new position of the concerned component in the list of agregated features.
o GetAllChildren
public virtual void GetAllChildren(CATClassId iIntfName,
CATListValCATISpecObject_var& oLst) = 0
Retrieves all children recursively.
Parameters:
iIntfName
to get only children answering to interface iIntfName.
oLst
list of children.
o GetChildAtPosition
public virtual CATISpecObject_var GetChildAtPosition(int iPosition)= 0
Gets a component by its position in the list of components agregated to this feature .
Parameters:
iPosition
given position. If 1, gets the first component in the list.
Returns:
the component found at the given position in the list.
o GetDirectChildren
public virtual void GetDirectChildren(CATClassId iIntfName,
CATListValCATISpecObject_var& oLst) = 0
Retrieves all direct children.
Parameters:
iIntfName
to get only children answering to interface iIntfName.
oLst
list of children.
o GetNumberOfChildren
public virtual int GetNumberOfChildren()= 0
Returns number of components agregated to this feature.
o GetPosition
public virtual int GetPosition( const CATISpecObject_var& iFeature)= 0
Returns the position of a given component in the list of components agregated to this feature .
Parameters:
iFeature
search SpecObject.
o Prepend
public virtual void Prepend( const CATISpecObject_var& iFeature) = 0
Adds a component to this feature at first position in the list of components agregated to this feature ..
Parameters:
iFeature
SpecObject to add as a component.
o RemoveChild
public virtual void RemoveChild( const CATISpecObject_var& iFeature)= 0
Removes a given component from this feature .
Parameters:
iFeature
component to remove.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.