All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATAnalysisVisuInterfaces Interface CATISamImageFactory
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATISamImageFactory
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISamImageFactory
Analysis "images" creation.
Role: Analysis Images are 3D representation of analysis data.
Images are defined in one or several XML files that describe :
allowed analysis data ( physical types, value type, ...)
filters ( component, layer, ...)
dress up attributes
...
Query this interface on the post-pro container to create new images
or to add/remove XML image description files.
Note : if an image file named MyFile.xml is added,
the images NLS names will be searched in the file MyFile.CATNls.
Method Index
- o
AddImageFile(CATUnicodeString&)
- Add an XML image description file.
- o
CreateImage(CATString&,CATBaseUnknown*,CATISamImage*&,CATLISTP(CATBaseUnknown)*,CATLISTP(CATBaseUnknown)*,CATBoolean)
- Create a new image.
- o
GetImageFiles(int&,CATUnicodeString*&)
- Retrieve the list of loaded image files.
- o
RemoveImageFile(CATUnicodeString&)
- Remove an XML image description file.
Methods
o AddImageFile
-
Add an XML image description file.
If not called, the image description will be searched in the default files.
- Parameters:
-
- iFilePath
- The path to the file to be added.
o CreateImage
-
Create a new image.
- Parameters:
-
- iImageIdentifier
- the image's identifier (as found in the XML files).
- iOwner
- the analysis set or entity under which the image will be plugged, and the created image
will be added in the current Image Model.
If NULL, iValuesProviders has to be specified and the created image will not be added
in the Image Model.
- oNewImage
- the newly created image.
- iValuesProviders
- the list of objects from which the values will be retrieved with the
CATICharacCollector interface.
If not specified (default), values will be retrieved from the iOwner parameter.
- iDisplacementsProviders
- the list of objects from which the displacements will be retrieved with the
CATICharacCollector interface.
If not specified (default), displacements will be retrieved from the iOwner parameter.
- iUpdate
- specifies if the new created image must be updated or not.
By default, the image will be updated.
- See also:
- CATISamImage
- See also:
- CATICharacCollector
o GetImageFiles
-
Retrieve the list of loaded image files.
- Parameters:
-
- oNbImageFiles
- The number of loaded files
- oFilePathes
- The pathes of loaded files
o RemoveImageFile
-
Remove an XML image description file.
- Parameters:
-
- iFilePath
- The path to the file to be removed.
This object is included in the file: CATISamImageFactory.h
If needed, your Imakefile.mk should include the module: CATSamVisuUUID