3D PLM PPR Hub Open Gateway

What You Will Learn With This Use Case

In this use case you will mainly earn how to use the ConnectToPX1 and DisconnectFromPX1 methods of the CATxPDMSessionUIServices class.

[Top]

The CAAxPDMUICommands Use Case

CAAxPDMUICommands is a use case of the CAAxPDMInterfaces.edu framework that illustrates CATxPDMInterfaces framework capabilities. Be careful, such as all use cases illustrating the CATxPDMInterfaces framework, the current one requires a PX1 licence.

[Top]

What Does CAAxPDMUICommands Do

• Launch CATIA,
• Create or load documents
• Retrieve the PX1 CAASample Toolbar
  • View / Toolbars / PX1 CAASample

The PX1 Toolbar containing several commands.

• Select the Connect To PX1 command
  Automatically, a new icon is added to all Read-Only items.
  It gives to user a direct feedback of Check-In status in PDM : item with specific mask should not be modified.
   
  
• Double-clic on an object with specific mask to UI Activate it and select Check Out command
  This command should be customized to perform Check-Out operation in PDM and change file right access from Read-Only to Read-Write.
  Icon in tree is refreshed, user can now modify document.
  
  
• You can repeat Check-In and Check-Out operations on all documents.
  Notice that Check-In operation is forbidden on modified documents. If user try to modify a read-only document, a specific mask will appear (see Product3 on picture).
  User has to launch Check-Out command to correct the problem else he will not be able to save.
  
  
• When you have finish, you can disconnect from through the Disconnect From PX1 command
  Automatically, a specific icons are removed in tree.
  

[Top]

How to Launch CAAxPDMUICommands

To launch CAAxPDMUICommands, you will need to set up the build time environment, then compile CAAxPDMUICommands along with its prerequisites, set up the run time environment, and then execute the use case [1]. To launch it, refer to the What Does CAAxPDMUICommands Do section.

[Top]

Where to Find the CAAxPDMUICommands Code

The CAAxPDMUICommands use case is made of three files,

• The CAAxPDMToolbar class, located in the CAAxPDMToolbar.m module of the CAAxPDMInterfaces.edu framework:

  Windows	InstallRootDirectory\CAAxPDMInterfaces.edu\CAAxPDMToolbar.m\
  Unix	InstallRootDirectory/CAAxPDMInterfaces.edu/CAAxPDMToolbar.m/

this file contains the addin to create the toolbar.

• The CAAxPDMConnectCmd.cpp class and the CAAxPDMCheckInOutCmd class

  Windows	InstallRootDirectory\CAAxPDMInterfaces.edu\CAAxPDMUICommands.m\
  Unix	InstallRootDirectory/CAAxPDMInterfaces.edu/CAAxPDMUICommands.m/

The first class is the state command launched when the end user push Connect To PX1 command. The second one defines Check-In and Check-Out commands (this is same command with a different argument) 

where InstallRootDirectory is the directory where the CAA CD-ROM is installed.

[Top]

Step-by-Step

Activation of PX1 icon mask

PX1 icon mask is activated through CATxPDMUIServicess::ConnectToPX1 APIs.
This API should be called after connection to your PDM (integrated in connection command).
An automatic refresh of all icons already displayed is included in this call.
Complete sample of connection is delivered in CAAxPDMConnectCmd.cpp, you can insert your own connection code in dedicated area (see comment in code).

Refreshing PX1 icon mask

There is no automatic update of PX1 icon mask in session (it will lead to bad performances if CATIA check Read/Write status on disc for each icon display). It means that this is responsability of CAA PDM Integration to update them after each Check-In or Check-Out operation.
This refresh should be done through CATxPDMSessionServices::RefreshItemInformation with CATxPDMSessionServices::ReadWrite parameter.
This call is updating two information:
         - Read/Write status of item in memory. Without this update, you will never be able to Save item, even if you have Read/Write access on disc.
         - Mask of all icons
Complete sample of check-in delivered in CAAxPDMCheckInOutCmd.cpp, you can insert your own connection code in dedicated area (see comment in code).

Remarks:

• Check-In operation should be forbidden if document is modified in session. PX1 API CATxPDMItem::NeedToBeSaved allows checking this before Check-In.
• Refresh of icons is designed to refresh automatically icons of Parts and Root Products. For Product Instance (for performance reason), API refreshes only icons of UI active object (the blue node). CAA Sample command is designed to Check-In (or Check-Out) automatically the blue node. If you design your interactive command to work on another object, you have to refresh yourself icon, you can do it with  CATIRedrawEvent::RedrawNodeVisu
  

[Top]

In Short

This sample show you :

• how to activate a specific icon mask on document which could not be modified in session because they are controled by PDM
• how to update this specific icon mask after each PDM operation like Check-In or Check-Out

[Top]

References

History

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