All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

SimulationInterfaces Interface CATISiList

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

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


interface CATISiList

Definition for CATISiList object.
It is used to hold simulation experiments. The build of the list disengages the following notification CATISiSpecEvents::GetBuildNotification().


Method Index


o GetComplementaryListOfObjects(CATListValCATBaseUnknown_var&)
Retrieves the remaining objects in the model not contained in the list.
o GetListName()
Retrieves the name of the list.
o GetListOfObjects(CATListValCATBaseUnknown_var&)
Retrieves the objects contained with in the list.
o GetModifyNoValidateNotification()
Callback used to notify if the results have been modified.
o GetModifyNotification()
Callback used to notify if the results have been modified.
o GetType()
Retrieves the type of the list.
o MarkForRebuild(int)
Mark list for rebuild.
o SetListName(CATUnicodeString)
Stores the name of the list.
o SetType(int)
Sets the type of the list.

Methods


o GetComplementaryListOfObjects
public virtual void GetComplementaryListOfObjects(CATListValCATBaseUnknown_var& oList) const=0
Retrieves the remaining objects in the model not contained in the list.
Parameters:
oList
Retrieves a collection of the complementary objects that in the list with respect to the remainder of the model.
o GetListName
public virtual CATUnicodeString GetListName()const=0
Retrieves the name of the list.
Returns:
Returns the name of the list.
o GetListOfObjects
public virtual void GetListOfObjects(CATListValCATBaseUnknown_var& oList) const=0
Retrieves the objects contained with in the list.
Parameters:
oList
A list of all the items contained in the CATISiList.
o GetModifyNoValidateNotification
public virtual CATCallbackEvent GetModifyNoValidateNotification()const=0
Callback used to notify if the results have been modified. (Called by a build).
o GetModifyNotification
public virtual CATCallbackEvent GetModifyNotification()const=0
Callback used to notify if the results have been modified. (Called by a build).
o GetType
public virtual int GetType()const=0
Retrieves the type of the list.
Returns:
Returns the type of the list.
o MarkForRebuild
public virtual void MarkForRebuild(int iNotif=LIST_GLOBALNOTIF) const=0
Mark list for rebuild. This is to tell the list that it needs to dispatch any necessary callbacks.
Parameters:
iNotif
The type of notification to dispatch.
o SetListName
public virtual void SetListName(CATUnicodeString iName) const=0
Stores the name of the list.
Parameters:
iName
The new name of the list
o SetType
public virtual void SetType(int iType=LIST_UNDEFINED) const=0
Sets the type of the list.
Parameters:
iType
The type of the list.

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

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