All Frameworks  Object Hierarchy  This Framework  Indexes

AnalysisCases (Collection)

The collection of analysis case making an Analysis.

Method Index

AddExistingCase
Adds an existing analysis case to the analysis cases collection.
Add
Creates a new case and adds it to the case collection.
Item
Returns a case using its index or its name from the case collection.
NewCase
Creates a new case and adds it to the case collection.
Remove
Removes a case using its index or its name from the case collection.

Methods


o Sub AddExistingCase( iCase)
Adds an existing analysis case to the analysis cases collection.
Parameters:
iCase
The Existing Analysis Case.
Example:
This example adds ThisAnalysisCase in the analysisCases analysis cases collection. 
 Dim ThisAnalysisCase As AnalysisCase
 Dim analysisCases As AnalysisCases
 ...
 analysisCases.AddExistingCase(ThisAnalysisCase)
o Func Add() As
Creates a new case and adds it to the case collection. This case will be plugged under the analysis model.
Returns:
The created case
Example:
The following example creates a case NewCase in the case collection of the ModelAnalysis Analysis model

. 

 Dim ModelAnalysis As AnalysisModel
 Dim NewCase As AnalysisCase
 Set NewCase = ModelAnalysis.AnalysisCases.Add()
o Func Item( iIndex) As
Returns a case using its index or its name from the case collection.
Parameters:
iIndex
The index or the name of the case to retrieve from the collection of cases. As a numeric, this index is the rank of the case in the collection. The index of the first case in the collection is 1, and the index of the last case is Count. As a string, it is the name you assigned to the case using the
AnyObject.Name property.
Returns:
The retrieved case.
Example:
This example retrieves in ThisCase the fifth case in the collection and in ThatCase the case named "MyCase in the case collection of the AnalysisModel Analysis model. 
 Set CaseColl = AnalysisModel.AnalysisCases
 Set ThisCase = CaseColl.Item(5)
 Set ThatCase = CaseColl.Item("MyCase")
o Func NewCase( iType) As
Creates a new case and adds it to the case collection. This case will be plugged under the analysis model.
Returns:
The created case
Example:
The following example creates a case NewCase in the case collection of the ModelAnalysis Analysis model

. 

 Dim ModelAnalysis As AnalysisModel
 Dim NewCase As AnalysisCase
 Set NewCase = ModelAnalysis.AnalysisCases.NewCase("AnalysisPreproCase")()
o Sub Remove( iIndex)
Removes a case using its index or its name from the case collection.
Parameters:
iIndex
The index or the name of the case to retrieve from the collection of cases. As a numeric, this index is the rank of the case in the collection. The index of the first case in the collection is 1, and the index of the last case is Count. As a string, it is the name you assigned to the case using the
AnyObject.Name property.
Example:
This example removes the fifth case in the collection. 
 AnalysisModel.AnalysisCases.Remove (5)

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