All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Visualization Class CATSO

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

Usage: you must use this class as is. You should never derive it.


public class CATSO

A set of objects.

Role : Enclosed objects are instances of the CATBaseUnknown class. This class makes use of the AddRef/Release mechanism when adding or removing object.


Constructor and Destructor Index


o CATSO(int)
Default constructor.
o ~CATSO()

Method Index


o AddElement(CATBaseUnknown*,int)
Adds an element to the set.
o Empty()
Remove all elements from the set.
o Gather(CATSO*)
Gathers an other set with this one.
o GetSize()
Returns the count of elements in the set.
o IsMember(CATBaseUnknown*)
Checks if an element ready exists in the set.
o RemoveElement(CATBaseUnknown*)
Removes an element from the set.
o operator [](int)
Subscripting operator.

Constructor and Destructor


o CATSO
public CATSO(int iThereIsNoDuplicata= 0)
Default constructor.
Parameters:
iThereIsNoDuplicata
Parameter use to avoid the check of each object added.
Legal values :
The default comportment expressed by the default value 0 is
to check if the object still exist before added it.
If the value is set to 1 you must be sure that each new object
not still exist in the set.
o ~CATSO
public virtual ~CATSO()

Methods


o AddElement
public virtual HRESULT AddElement(CATBaseUnknown* iElement,
int iCheckIfThere= 1)
Adds an element to the set.
Parameters:
iElement
The element to add to the set.
Cyclic reference: A copy of iElementToAdd is kept and an AddRef is performed. It is Released either when the element is removed from the set, or by the CATSO destructor.
iCheckIfThere
Unused argument
o Empty
public virtual void Empty()
Remove all elements from the set. A Release is done for each element.
Cyclic reference: each object is released.
o Gather
public void Gather(CATSO* iSo)
Gathers an other set with this one.
Parameters:
iSo
The set of elements to add.
o GetSize
public int GetSize()
Returns the count of elements in the set.
Returns:
Return the size of the set.
o IsMember
public int IsMember(CATBaseUnknown* iElem)
Checks if an element ready exists in the set.
Parameters:
iElem
The object to look for.
Returns:

Legal values : return 0 if the element isn't in the set, otherwise return 1.
o RemoveElement
public virtual void RemoveElement(CATBaseUnknown* iElem)
Removes an element from the set.
Parameters:
iElem
The objectto remove.
Cyclic reference : the removed object is released.
o operator []
public CATBaseUnknown * operator [](int iIndex) const
Subscripting operator.
Role : returns an object using the object index.
Lifecycle rules deviation : This method doesn't AddRef returned value.
Parameters:
iIndex
The index
Legal values : iIndex values are between 0 and GetSize()-1.
Returns:
The object.

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

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