All Frameworks Class Hierarchy This Framework Indexes
SimulationInterfaces Interface 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 GetComplementaryListOfObjects( | | oList) |
-
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 GetListName( | ) |
-
Retrieves the name of the list.
- Returns:
- Returns the name of the list.
o GetListOfObjects
| public virtual GetListOfObjects( | | oList) |
-
Retrieves the objects contained with in the list.
- Parameters:
-
- oList
- A list of all the items contained in the CATISiList.
o GetModifyNoValidateNotification
| public virtual GetModifyNoValidateNotification( | ) |
-
Callback used to notify if the results have been modified.
(Called by a build).
o GetModifyNotification
| public virtual GetModifyNotification( | ) |
-
Callback used to notify if the results have been modified.
(Called by a build).
o GetType
-
Retrieves the type of the list.
- Returns:
- Returns the type of the list.
o MarkForRebuild
| public virtual MarkForRebuild( | | iNotif | =LIST_GLOBALNOTIF) |
-
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 SetListName( | | iName) |
-
Stores the name of the list.
- Parameters:
-
- iName
- The new name of the list
o SetType
| public virtual SetType( | | iType | =LIST_UNDEFINED) |
-
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