3D PLM PPR Hub Open Gateway

File XPDM (PX1)

Reading Product Structure Properties

How to use CATIxPDMItem

Use Case

Abstract

This article shows how to read all the properties of a Product model.

What You Will Learn With This Use Case
The CAAxPDMReadItemInfo Use Case
Step-by-Step
In Short
References

What You Will Learn With This Use Case

You will learn how to use the CATIXPDMItem interface and the LoadItemInSession method of the CATxPDMSessionServices class.

[Top]

The CAAxPDMReadItemInfo Use Case

CAAxPDMReadItemInfo 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 CAAxPDMReadItemInfo Do

The use case takes in argument a document path. Here are the traces generated for the Product4.CATProduct document located in the InputData of the CAAxPDMInterfaces.edu framework.

...
The CAAxPDMReadItemInfo main program begins ....

 A session is created
 
 --j:\bsf\CAAxPDMInterfaces.edu\InputData\SendTo\Product4.CATProduct
   DisplayName:Product4.CATProduct
   Type       :CATProduct
   Version    :51510
   List of properties
    1 CN_PART_NUMBER = Product4
    2 CN_REVISION =
    3 CN_DEFINITION =
    4 CN_NOMENCLATURE =
    5 CN_DESCRIPTIONREF =
    6 CN_SOURCE = unknown
    7 CN_VOLUME = 537062
    8 CN_MASS = 0.537062
    9 CN_SURFACE = 64106.2
   List of children
    Child 1
    --j:\bsf\CAAxPDMInterfaces.edu\InputData\SendTo\Part1.CATPart
      DisplayName:Part1.CATPart
      Type       :CATPart
      Version    :51510
      List of properties
       1 CN_PART_NUMBER = Part1
       2 CN_REVISION =
       3 CN_DEFINITION =
       4 CN_NOMENCLATURE =
       5 CN_DESCRIPTIONREF =
       6 CN_SOURCE = unknown
       7 CN_VOLUME = 100531
       8 CN_MASS = 0.100531
       9 CN_SURFACE = 15079.6
    Child 2
    --j:\bsf\CAAxPDMInterfaces.edu\InputData\SendTo\Part2.CATPart
      DisplayName:Part2.CATPart
      Type       :CATPart
      Version    :51510
      List of properties
       1 CN_PART_NUMBER = Part2
       2 CN_REVISION =
       3 CN_DEFINITION =
       4 CN_NOMENCLATURE =
       5 CN_DESCRIPTIONREF =
       6 CN_SOURCE = unknown
       7 CN_VOLUME = 436531
       8 CN_MASS = 0.436531
       9 CN_SURFACE = 49026.5
    Child 3
 The session is deleted

The CATxPDMtstCheckDocType main program is ended.

[Top]

How to Launch CAAxPDMReadItemInfo

To launch CAAxPDMReadItemInfo, you will need to set up the build time environment, then compile CAAxPDMReadItemInfo along with its prerequisites, set up the run time environment, and then execute the use case [1]. To launch it, execute the following command:

mkrun -c "CAAxPDMReadItemInfo FileName"

where Filenamei is the complete path of a file.

[Top]

Where to Find the CAAxPDMReadItemInfo Code

The CAAxPDMReadItemInfo use case is made of one single file, the CAAxPDMReadItemInfo.cpp file, located in the CAAxPDMReadItemInfo.m module of the CAAxPDMInterfaces.edu framework:

Windows	`InstallRootDirectory\CAAxPDMInterfaces.edu\CAAxPDMReadItemInfo.m\`
Unix	`InstallRootDirectory/CAAxPDMInterfaces.edu/CAAxPDMReadItemInfo.m/`

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

[Top]

Step-by-Step

[Top]

In Short

[Top]

References

[1]	Building and Launching a CAA V5 Use Case
[Top]

History

Version: 1 [Feb 2006]	Document created
[Top]