pycatia.cat_sch_platform_interfaces.sch_app_multi_image

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.cat_sch_platform_interfaces.sch_app_multi_image.SchAppMultiImage(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
SchAppMultiImage

Interface to manage the image object in the Multi-Image-Object
concept.
app_get_master_document(o_document: Document, o_document_name: str, o_symbolic_link_name: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppGetMasterDocument(Document oDocument,
CATBSTR oDocumentName,
CATBSTR oSymbolicLinkName)

Get the document where the master of this image object
resides.

Parameters:

oDocument
Pointer to the document.
oDocumentName
Name of the document containing the master.
oSymbolicLinkName
Name of the symbolic link.

Example:



Dim objThisIntf As SchAppMultiImage
Dim objDoc As Document
Dim strDocName As String
Dim strLinkName As String
…
objThisIntf.AppGetMasterDocument
objDoc,strDocName,strLinkName
Parameters:

  • o_document (Document) –

  • o_document_name (str) –

  • o_symbolic_link_name (str) –

Return type:

None

app_get_master_object() → SchAppMultiImageMaster

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AppGetMasterObject() As SchAppMultiImageMaster

Get the master object of this image.

Parameters:

oMasterImage
Pointer to the master object.

Example:



Dim objThisIntf As SchAppMultiImage
Dim objMaster As SchMultiImageMaster
…
Set objMaster = objThisIntf.AppGetMasterObject
Return type:

SchAppMultiImageMaster

app_is_up_to_date() → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppIsUpToDate(CatSchIDLMultiImageStatus oStatus)

Check if the image object is up-to-date.

Parameters:

oStatus
Status of the image object.

Example:



Dim objThisIntf As SchAppMultiImage
…
objThisIntf.AppIsUpToDate
CatSchIDLMultiImageStatus_Enum
Returns:

enum cat_sch_idl_multi_image_status

Return type:

int

app_update(i_master_image: SchAppMultiImageMaster, o_image: SchAppMultiImage) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppUpdate(SchAppMultiImageMaster iMasterImage,
SchAppMultiImage oImage)

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.

Example:

Dim objThisIntf As SchAppMultiImage
Dim objMaster As SchAppMultiImageMaster
Dim objNewImage As SchAppMultiImage
…
objThisIntf.AppUpdate objMaster,objNewImage
Parameters:
Return type:

None