All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

Visualization Class CATXSO

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATEventSubscriber
        |
        +---System.CATCallbackManager
          |
          +---CATXSO
 

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


public class CATXSO

Base class of set of objects.
Role: Class representing a set of objects which must be visualized in a particular way.
Used by inheritance by CATHSO and CATPSO .


Constructor and Destructor Index


o ~CATXSO()

Method Index


o AddElement(CATBaseUnknown*)
Adds just one element to the set.
o AddElements(CATBaseUnknown*)
Adds one element in the set, among a list of several elements.
o EndAddElements()
Completes the action of adding elements to the set.
o EndRemoveElements()
Completes the action of removing elements from the set.
o GetCATAddElements()
Returns the name of the notification which is sent when elements are added to the set.
o GetCATEmptyElements()
Returns the name of the notification which is sent when it is empty.
o GetCATRemoveElements()
Returns the name of the notification which is sent when elements are removed from the set.
o GetSize()
Returns the count of elements in the set.
o IsMember(CATBaseUnknown*)
Checks if an element is already in the set.
o RemoveElement(CATBaseUnknown*)
Removes just one element from the set.
o RemoveElements(CATBaseUnknown*)
Removes one element in the set, among a list of several elements.
o operator [](int)
Subscripting operator.

Constructor and Destructor


o ~CATXSO
public virtual ~CATXSO()

Methods


o AddElement
public virtual void AddElement(CATBaseUnknown* iElement)
Adds just one element to the set.
The method EndAddElements is automatically called after.
Parameters:
iElement
The element to add.It must be a
CATPathElement
If iElement is already a member of the set, the element is not add.
o AddElements
public virtual void AddElements(CATBaseUnknown* iElement)
Adds one element in the set, among a list of several elements.
Role : To add several elements to the set, use this method as many times as you need and call EndAddElements at the end to indicate the end of the operation.
Parameters:
iElement
The element to add. It must be a
CATPathElement.
If iElement is already a member of the set, the element is not add.
o EndAddElements
public virtual void EndAddElements()
Completes the action of adding elements to the set.
Role : This method must be overridden to complete all necessary actions to add elements to the set.
See also:
AddElements
o EndRemoveElements
public virtual void EndRemoveElements()
Completes the action of removing elements from the set.
Role : This method must be overridden to complete all necessary actions to remove elements from the set.
See also:
RemoveElements
o GetCATAddElements
public static const char * GetCATAddElements()
Returns the name of the notification which is sent when elements are added to the set.
Returns:
The name of the notification.
o GetCATEmptyElements
public static const char * GetCATEmptyElements()
Returns the name of the notification which is sent when it is empty.
Returns:
The name of the notification.
o GetCATRemoveElements
public static const char * GetCATRemoveElements()
Returns the name of the notification which is sent when elements are removed from the set.
Returns:
The name of the notification.
o GetSize
public int GetSize()
Returns the count of elements in the set.
Returns:
The size of the set.
o IsMember
public int IsMember(CATBaseUnknown* iElement)
Checks if an element is already in the set.
Role: At first this method makes a pointer comparison and it's failed, the method makes a comparison in using the CATPathElement.operator== .
Parameters:
iElement
The element to look for.
Returns:
0 if iElement is not a member of the set, otherwise 1.
o RemoveElement
public virtual void RemoveElement(CATBaseUnknown* iElement)
Removes just one element from the set.
The method EndRemoveElements is automatically called after.
Parameters:
iElement
The element to remove. It must be a
CATPathElement
o RemoveElements
public virtual void RemoveElements(CATBaseUnknown* iElement)
Removes one element in the set, among a list of several elements.
Role : To remove several elements from the set, use this method as many times as you need and call EndRemoveElements at the end to indicate the end of the operation.
Parameters:
iElement
The element to remove. It must be a
CATPathElement
o operator []
public inline CATBaseUnknown * operator [](int iIndex) const
Subscripting operator.
Role: Returns an object using the object index.
Lifecycle rules deviation: This method doesn't AddRef the returned value.
Parameters:
iIndex
The index
Legal values: iIndex values are between 0 and GetSize()-1.
Returns:
The object at the iIndex position

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

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