All Frameworks  Object Hierarchy  This Framework  Indexes   

AnalysisImages (Collection)

The collection of analysis images.


Method Index

Add
Creates a new image and adds it to the analysis image collection.
Item
Returns an analysis image using its index or its name from the analysis images collection.
RemoveImage
Deletes the Analysis Image from the analysis images collection of the Analysis Set.

Methods


o Func Add( iImageName,
iHideExistingImages,
iShowMesh,
iDuplicate) As
Creates a new image and adds it to the analysis image collection.
Parameters:
iImageName
The name of the image to create.
iHideExistingImages
To deactivate or not all the activated images before create the new image.
iShowMesh
To show or not the mesh image.
iDuplicate
To duplicate or not the new image, if same image already exists in collection of images.
Returns:
The created Analysis Image
Example:
This example create ThisAnalysisImage in the analysisImagesanalysis
images collection. The image to create is supposed to be a mesh deformed image.
 Dim ThisAnalysisImage As AnalysisImage
 Set ThisAnalysisImage = analysisImages.Add("Mesh_Deformed", True, False, False)
 
o Func Item( iIndex) As
Returns an analysis image using its index or its name from the analysis images collection.
Parameters:
iIndex
The index or the name of the analysis image to retrieve from the collection of analysis images. This index is the rank of the analysis image in the collection. The index of the first analysis image in the collection is 1, and the index of the last analysis image is Count.
Returns:
The retrieved analysis image
Example:
This example retrieves in ThisAnalysisImage the third analysis image.
 Dim ThisAnalysisImage As AnalysisImage
 Set ThisAnalysisImage = analysisImages.Item(3)
 
o Sub RemoveImage( iImageIdentifier)
Deletes the Analysis Image from the analysis images collection of the Analysis Set.
Parameters:
iImageIdentifier
The index or the name of the analysis image to delete from the Analysis Set. Note: The index given is the position of the image in the Analysis Set. Note: The name given is the string got from analysisImage.Name If the index or the name specified is not present in the Analysis Set, this method FAILS. The index of the first analysis image in the collection is 1, and the index of the last analysis image is Count.
Example:
Example 1 In this example analysisImages1 is the Analysis Set and analysisImage1 is the image present in it. imageName = analysisImage1.Name analysisImages1.RemoveImage(imageName) Example 2 analysisImages1.RemoveImage(4) In this example 4 is the index of the Image to be deleted in Analysis Set: analysisImages1

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