pycatia.cat_sch_platform_interfaces.sch_app_multi_image_master

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_master.SchAppMultiImageMaster(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
SchAppMultiImageMaster

Interface to manage the master object in the Multi-Image-Object
concept.
app_add_image(i_image: SchAppConnectable) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppAddImage(SchAppConnectable iImage)

Add an image for this master object.

Parameters:

iImage
Pointer to the image to link this master to.

Example:



Dim objThisIntf As SchAppMultiImageMaster
Dim objImage As SchAppConnectable
…
objThisIntf.AppAddImage objImage
Parameters:

i_image (SchAppConnectable) –

Return type:

None

app_is_ok_to_create_image(i_image_doc: Document, o_b_yes: bool, o_nls_file_name: str, o_nls_file_key_to_message: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppIsOKToCreateImage(Document iImageDoc,
boolean oBYes,
CATBSTR oNLSFileName,
CATBSTR oNLSFileKeyToMessage)

Check if OK to create an image of this master object.

Parameters:

iImageDoc
Pointer to the document the image is in.
oBYes
TRUE if this object is valid to be the master of a MIO
relationship.
oNLSFileName
File name for the NLS messages.
oNLSFileKeyToMessage
Message key to the application specific diagnostics.


Example:



Dim objThisIntf As SchAppMultiImageMaster
Dim objImageDoc As Document
Dim bYes As boolean
Dim strFileName As String
Dim strFileKeyToMsg As String
…
objThisIntf.AppIsOKToCreateImage
objImageDoc,bYes,strFileName,strFileKeyToMsg
Parameters:

  • i_image_doc (Document) –

  • o_b_yes (bool) –

  • o_nls_file_name (str) –

  • o_nls_file_key_to_message (str) –

Return type:

None

app_list_images(i_l_filter: SchListOfBSTRs, o_l_images: SchListOfObjects) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppListImages(SchListOfBSTRs iLFilter,
SchListOfObjects oLImages)

List the images of this master object.

Parameters:

iLFilter
A list of image class names for filtering (can be NULL).

oLUKImages
A list of image pointers (a list of CATIASchAppMultiImage
pointers).

Example:



Dim objThisIntf As SchAppMultiImageMaster
Dim objLFilter As SchListOfBSTRs
Dim objLImages As SchListOfObjects
…
objThisIntf.AppListImages objLFilter,objLImages
Parameters:
Return type:

None