All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMDesktopObjects Interface CATIAVPMVDADuplicatePRC

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATBaseDispatch
        |
        +---System.CATIABase
          |
          +---VPMDesktopObjects.CATIAVPMVDACommand
            |
            +---CATIAVPMVDADuplicatePRC
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIAVPMVDADuplicatePRC

Interface to define the command to generate a new PRC from an existing PRC.
For each first level instance of a standard part, create an instance of the same part in the new PRC. For non-standard parts, create a new evolution of the part, including new document and resolution of the black box children (if any), and create an instance of this new part in the new PRC. Caller can request to process only ii's linked to GCO's, skipping first level ii's which are not linked to any GCo. For ii's which are linked to GCo's, the new ii in the new PRC will be linked to the same-named GCo, if it exists. The assumption is that the new PRC is already created and contains a GCo tree (if desired) created via Import Template in the Component Editor.


Method Index


o get_ErrorMsgs()
Returns the error messages associated with creating any of the duplicate instances.
o get_KeepInstanceID()
Retrieves the value set in put_KeepInstanceID().
o get_ManageUnlinkedInstances()
Gets the intent for managing first level item instances which are not linked to a GCo.
o get_NewPRC(ENOVIABOProductRootClass_var&)
Retrieves the PRC set in put_NewPRC.
o get_OriginIIList(CATListOfCATIAVPMItemInstance&)
Returns the list of ii's from OriginPRC which were considered for duplication.
o get_OriginPRC(ENOVIABOProductRootClass_var&)
Retrieves the PRC set in put_OriginPRC.
o get_Password()
Returns the value set in put_Password().
o get_ReportName()
Retrieves the value set in put_ReportName().
o get_Results(CATListOfCATIAVPMItemInstance&)
Returns the list of newly created ii's.
o get_Role()
Returns the value set in put_Role().
o get_Server()
Returns the value set in put_Server().
o get_Simul()
Returns the value set in put_Simul().
o get_User()
Returns the value set in put_User().
o put_KeepInstanceID(boolean&)
Sets the intent for naming the new instances in the new PRC.
o put_ManageUnlinkedInstances(int&)
Sets the intent for managing first level item instances which are not linked to a GCo.
o put_NewPRC(ENOVIABOProductRootClass_var&)
Sets the product root class which will be populated with instances based on the OriginPRC.
o put_OriginPRC(ENOVIABOProductRootClass_var&)
Sets the origin product root class, from which the new PRC will be populated.
o put_Password(CATUnicodeString&)
Sets the Enovia password.
o put_ReportName(CATUnicodeString&)
Sets the full path name of the file for the report.
o put_Role(CATUnicodeString&)
Sets the Enovia role
Role: The Enovia role is needed by external CATIA program(s) to connect to Enovia and get contents of workpackage documents.
o put_Server(CATUnicodeString&)
Sets the Enovia serverhost.
o put_Simul(boolean&)
Run simulation of duplication operation.
o put_User(CATUnicodeString&)
Sets the Enovia user.

Methods


o get_ErrorMsgs
public virtual CATListOfCATUnicodeString get_ErrorMsgs()= 0
Returns the error messages associated with creating any of the duplicate instances.
Returns:
CATListOfCATUnicodeString
o get_KeepInstanceID
public virtual boolean get_KeepInstanceID()= 0
Retrieves the value set in put_KeepInstanceID().
Returns:
boolean: true = keep same V_instance_ID in new PRC. false = name according to CATIAVPMVDAComputeInstanceID in new PRC.
o get_ManageUnlinkedInstances
public virtual int get_ManageUnlinkedInstances()= 0
Gets the intent for managing first level item instances which are not linked to a GCo.
Returns:
int: 0 = ignore -- don't duplicate. 1 = copy -- simply re-instanciate, don't create new part evolutions. 2 = evolve -- folow same logic as for gco-linked item instances.
o get_NewPRC
public virtual HRESULT get_NewPRC(ENOVIABOProductRootClass_var& oNewPRC)= 0
Retrieves the PRC set in put_NewPRC.
Returns:
ENOVIABOProductRootClass_var.
o get_OriginIIList
public virtual HRESULT get_OriginIIList(CATListOfCATIAVPMItemInstance& oOriginIIs) = 0
Returns the list of ii's from OriginPRC which were considered for duplication.
Returns:
CATListOfCATIAVPMItemInstance: ii's from orig PRC.
o get_OriginPRC
public virtual HRESULT get_OriginPRC(ENOVIABOProductRootClass_var& oOriginPRC) = 0
Retrieves the PRC set in put_OriginPRC.
Returns:
ENOVIABOProductRootClass_var.
o get_Password
public virtual CATUnicodeString get_Password()= 0
Returns the value set in put_Password().
If put_Password() never called, then value will be an empty string.
Returns:
Enovia password
o get_ReportName
public virtual CATUnicodeString get_ReportName()= 0
Retrieves the value set in put_ReportName(). If put_ReportName() never called, then value will be an empty string.
Returns:
CATUnicodeString: full path name of the report filename, if any.
o get_Results
public virtual HRESULT get_Results(CATListOfCATIAVPMItemInstance& oNewIIs)= 0
Returns the list of newly created ii's.
Returns:
CATListOfCATIAVPMItemInstance: ii's created in new PRC. OriginIIList and ResultsList have equal length. Element 1 in Result list is created from element 1 in OriginList, etc. If there is an error during duplication, the corresponding element in the ResultsList will be NULL_var.
o get_Role
public virtual CATUnicodeString get_Role()= 0
Returns the value set in put_Role().
If put_Password() never called, then value will be an VPMADMIN.DEFAULT.ADMIN.
Returns:
Enovia role
o get_Server
public virtual CATUnicodeString get_Server()= 0
Returns the value set in put_Server().
If put_Server() never called, then value will be a string obtained from the Orbix environment.
Returns:
Enovia server host (servername:serverport)
o get_Simul
public virtual boolean get_Simul()= 0
Returns the value set in put_Simul().
If put_Simul never called, then value will be FALSE.
Returns:
true = Operation will run in simulation mode. false = Operation will run in simulation mode.
o get_User
public virtual CATUnicodeString get_User()= 0
Returns the value set in put_User().
If put_User() never called, then value will be a string obtained from the Orbix environment.
Returns:
Enovia user
o put_KeepInstanceID
public virtual HRESULT put_KeepInstanceID( const boolean& iKeepID) = 0
Sets the intent for naming the new instances in the new PRC.
Parameters:
iKeepID:
true = keep same V_instance_ID in new PRC. false = name according to CATIAVPMVDAComputeInstanceID in new PRC.
Returns:
S_OK if successful, E_FAIL if error.
o put_ManageUnlinkedInstances
public virtual HRESULT put_ManageUnlinkedInstances( const int& iUnlinkedInstanceMode)= 0
Sets the intent for managing first level item instances which are not linked to a GCo.
Parameters:
iUnlinkedInstanceMode:
0 = ignore -- don't duplicate. 1 = copy -- simply re-instanciate, don't create new part evolutions. 2 = evolve -- folow same logic as for gco-linked item instances.
Returns:
S_OK if successful, E_FAIL if error.
o put_NewPRC
public virtual HRESULT put_NewPRC( const ENOVIABOProductRootClass_var& iNewPRC)=0
Sets the product root class which will be populated with instances based on the OriginPRC.
Parameters:
iNewPRC:
the new Product Root Class
Returns:
S_OK if successful, E_FAIL if error.
o put_OriginPRC
public virtual HRESULT put_OriginPRC( const ENOVIABOProductRootClass_var& iOriginPRC)=0
Sets the origin product root class, from which the new PRC will be populated.
Parameters:
iOriginPRC:
the origin Product Root Class.
Returns:
S_OK if successful, E_FAIL if error.
o put_Password
public virtual HRESULT put_Password( const CATUnicodeString& iPassword) = 0
Sets the Enovia password.
Role: The Enovia password is needed by external CATIA program(s) to connect to Enovia and get contents of workpackage documents. If value is not set by this method, then the password defaults to an empty string.
Parameters:
iPassword
The Enovia password
Returns:
S_OK if successful, E_FAIL if error.
o put_ReportName
public virtual HRESULT put_ReportName( const CATUnicodeString& iReportName) = 0
Sets the full path name of the file for the report.
Parameters:
CATUnicodeString:
full path name of the report file.
Returns:
S_OK if successful, E_FAIL if error.
o put_Role
public virtual HRESULT put_Role( const CATUnicodeString& iRole) = 0
Sets the Enovia role
Role: The Enovia role is needed by external CATIA program(s) to connect to Enovia and get contents of workpackage documents. If value is not set by this method, then the role defaults to VPMADMIN.DEFAULT.ADMIN.
Parameters:
iRole
Enovia role
Returns:
S_OK if successful, E_FAIL if error.
o put_Server
public virtual HRESULT put_Server( const CATUnicodeString& iServer) = 0
Sets the Enovia serverhost.
Role: An Enovia serverhost is needed by external CATIA program(s) to connect to Enovia and get contents of workpackage documents. If value is not set by this method, then a serverhost value will be obtained from the Orbix environment.
Parameters:
iServer
The Enovia server host (servername:serverport)
Returns:
S_OK if successful, E_FAIL if error.
o put_Simul
public virtual HRESULT put_Simul( const boolean& iSimul) = 0
Run simulation of duplication operation.
Role: If operation is a simulation newly created data will not be commited to the EV5 database.
Parameters:
iSimul
true = Operation will run in simulation mode. false = Operation will not run in simulation mode.
Returns:
S_OK if successful, E_FAIL if error.
o put_User
public virtual HRESULT put_User( const CATUnicodeString& iUser) = 0
Sets the Enovia user.
Role: An Enovia user is needed by external CATIA program(s) to connect to Enovia and get contents of workpackage documents. If value is not set by this method, then a user value will be obtained from the environment.
Parameters:
iUser
The Enovia user
Returns:
S_OK if successful, E_FAIL if error.

This object is included in the file: CATIAVPMVDADuplicatePRC.h
If needed, your Imakefile.mk should include the module: VDO0Commands

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