All Frameworks  Object Hierarchy  This Framework  Indexes  Previous Next

AnalysisImage (Object)

Represents the analysis image object.

Property Index

AnalysisImages
Returns the analysis images collection associated with an analysis image.

Method Index

ExportDataInGlobalAxis
Extracts image results.
ExportDataInManualAxis
Extracts image results.
ExportDataInUserAxis
Extracts image results.
ExportDataWithMeshPartId
Extracts image results and location with mesh part name (as identifier).
ExportData
Extracts image results.
ResetSelection
Resets all selections in an image.
SetActivationStatus
Activates oe deactivates an image.
SetCurrentOccurrence
Sets occurrence number for an image.
SetSelection
Adds a selection to an image.
Update
Updates an image.

Properties


o Property AnalysisImages() As AnalysisImages (Read Only)
Returns the analysis images collection associated with an analysis image.

Methods


o Sub ExportDataInGlobalAxis(Folder iFolder,
CATBSTR iFileName,
CATBSTR iExtensionType,
CATAxisOrientationType iAxisOrientationType,
boolean iExportMeshPartID)
Extracts image results.
The export is done related to an existing image and will be stored in a CATIA Folder as a Text file or as an Excel file.
Limitations:
  • The allowed output positions are: node, element, center of element, and node of element
  • The allowed values are: integer, real or double
  • The allowed value types are: average or discontinuous iso, symbol, fringe or text
Parameters:
iFolder
The folder to store the file to create
iFileName
The name of the file to create
iExtensionType
The extension of the file
Legal values:
  • "xls" for a Microsoft Excel workbook
  • "txt" for a text file.
iAxisOrientationType
Coordinate system type of location axis system
iExportMeshPartID
Flag for exporting with meshpartid or not
o Sub ExportDataInManualAxis(Folder iFolder,
CATBSTR iFileName,
CATBSTR iExtensionType,
CATSafeArrayVariant iOrigin,
CATSafeArrayVariant iXDirection,
CATSafeArrayVariant iYDirection,
CATSafeArrayVariant iZDirection,
CATAxisOrientationType iAxisOrientationType,
boolean iExportMeshPartID)
Extracts image results.
The export is done related to an existing image and will be stored in a CATIA Folder as a Text file or as an Excel file.
Limitations:
  • The allowed output positions are: node, element, center of element, and node of element
  • The allowed values are: integer, real or double
  • The allowed value types are: average or discontinuous iso, symbol, fringe or text
Parameters:
iFolder
The folder to store the file to create
iFileName
The name of the file to create
iExtensionType
The extension of the file
Legal values:
  • "xls" for a Microsoft Excel workbook
  • "txt" for a text file.
iOrigin
Origin of Location axis system
iXDirection
co-ordinates of a point on X- axis of Location axis system
iYDirection
co-ordinates of a point on Y- axis of Location axis system
iZDirection
co-ordinates of a point on Z- axis of Location axis system
iAxisOrientationType
Coordinate system type of location axis system
iExportMeshPartID
Flag for exporting with meshpartid or not
o Sub ExportDataInUserAxis(Folder iFolder,
CATBSTR iFileName,
CATBSTR iExtensionType,
AxisSystem iAxisSystem,
Product iProduct,
CATAxisOrientationType iAxisOrientationType,
boolean iExportMeshPartID)
Extracts image results.
The export is done related to an existing image and will be stored in a CATIA Folder as a Text file or as an Excel file.
Limitations:
  • The allowed output positions are: node, element, center of element, and node of element
  • The allowed values are: integer, real or double
  • The allowed value types are: average or discontinuous iso, symbol, fringe or text

To export data with mesh-part identification use ExportDataWithMeshPartId

Parameters:
iFolder
The folder to store the file to create
iFileName
The name of the file to create
iExtensionType
The extension of the file
Legal values:
  • "xls" for a Microsoft Excel workbook
  • "txt" for a text file.
iAxisSystem
Reference to the axis system to be used for location transformation.
iProduct
Reference to the product, where the above axis system is defined.
iAxisOrientationType
Coordinate system type of location axis system
iExportMeshPartID
Flag for exporting with meshpartid or not
o Sub ExportDataWithMeshPartId(Folder iFolder,
CATBSTR iFileName,
CATBSTR iExtensionType)
Extracts image results and location with mesh part name (as identifier).
The export is done related to an existing image and will be stored in a CATIA Folder as a Text file or as an Excel file.
Limitations:
  • The allowed output positions are: element, center of element, and node of element
  • The allowed values are: integer, real or double
  • The allowed value types are: average or discontinuous iso, symbol, fringe or text

To export data with mesh-part identification use ExportData

Parameters:
iFolder
The folder to store the file to create
iFileName
The name of the file to create
iExtensionType
The extension of the file
Legal values:
  • "xls" for a Microsoft Excel workbook
  • "txt" for a text file.
o Sub ExportData(Folder iFolder,
CATBSTR iFileName,
CATBSTR iExtensionType)
Extracts image results.
The export is done related to an existing image and will be stored in a CATIA Folder as a Text file or as an Excel file.
Limitations:
  • The allowed output positions are: node, element, center of element, and node of element
  • The allowed values are: integer, real or double
  • The allowed value types are: average or discontinuous iso, symbol, fringe or text

To export data with mesh-part identification use ExportDataWithMeshPartId

Parameters:
iFolder
The folder to store the file to create
iFileName
The name of the file to create
iExtensionType
The extension of the file
Legal values:
  • "xls" for a Microsoft Excel workbook
  • "txt" for a text file.
o Sub ResetSelection()
Resets all selections in an image.
This is done related to an existing image
o Sub SetActivationStatus(CATVariant iActivationStatus)
Activates oe deactivates an image.
This is done related to an existing image
Parameters:
iActivationStatus
To activate or not the current image.
o Sub SetCurrentOccurrence(CATVariant iOccurrenceNumber)
Sets occurrence number for an image.
This is done related to an existing image
Parameters:
iOccurrenceNumber
The number to select
Legal value: 1 ≤ iOccurrenceNumber ≤ nbOccurrence
o Sub SetSelection(Reference iReference,
CATVariant iReplaceMode)
Adds a selection to an image.
This is done related to an existing image
Parameters:
iReference
The selectionGroup to add
iReplaceMode
To replace or not the current selections.
o Sub Update()
Updates an image.
This is done related to an existing image

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