All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchAppMultiImage

System.IUnknown
  |
  +---CATISchAppMultiImage
 

Usage: you can reimplement this interface by deriving the supplied CATEASchAppMultiImage adapter class.


interface CATISchAppMultiImage

Interface to manage the image object in the Multi-Image-Object concept.
Application must derived implementation of this interface from CATEASchAppMultiImage. Role: Manage the image object.

BOA information: this interface CANNOT be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.


Method Index


o AppGetMasterDocument(CATDocument*&,CATUnicodeString&,CATUnicodeString&)
Get the document where the master of this image object resides.
o AppGetMasterObject(CATISchAppMultiImageMaster**)
Get the master object of this image.
o AppIsUpToDate(CATSchMIOImageStatus&)
Check if the image object is up-to-date.
o AppUpdate(CATISchAppMultiImageMaster*,CATISchAppMultiImage**)
Update the image object.

Methods


o AppGetMasterDocument
public virtual HRESULT AppGetMasterDocument(CATDocument*& oDocument,
CATUnicodeString& oDocumentName,
CATUnicodeString& oSymbolicLinkName) = 0
Get the document where the master of this image object resides.
Parameters:
oDocument
Pointer to the document. Do not release output pointer (no AddRef is done).
oDocumentName
Name of the document containing the master.
oSymbolicLinkName
Name of the symbolic link.
o AppGetMasterObject
public virtual HRESULT AppGetMasterObject(CATISchAppMultiImageMaster** oMasterImage) = 0
Get the master object of this image.
Parameters:
oMasterImage
[out, IUnknown#Release] Pointer to the master object.
o AppIsUpToDate
public virtual HRESULT AppIsUpToDate(CATSchMIOImageStatus& oStatus) = 0
Check if the image object is up-to-date.
Parameters:
oStatus
Possible Enum values: Enum values need to be mapped to those provided by PSP.
o AppUpdate
public virtual HRESULT AppUpdate( const CATISchAppMultiImageMaster* iMasterImage,
CATISchAppMultiImage** oImage) = 0
Update the image object.
Parameters:
iMasterImage
This is an optional input. Not NULL - the application has a handle on the master to update this image (for example in DSA application, the application will make sure the ID of this image is the same as the input master). NULL - the application will find the master based on the specific way it models the MIO concept. Sample case: the application will make sure the ID of this image is the same as the input master.
oImage
Pointer to a new image object created if existing image object has to be replaced during the update process. This pointer is NULL if the image object is not replaced.

This object is included in the file: CATISchAppMultiImage.h

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