All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DMAPSInterfaces Interface CATISPPProcessContainer

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---DMAPSInterfaces.CATISPPContainer
        |
        +---CATISPPProcessContainer
 

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


interface CATISPPProcessContainer

Interface to manage process container which may be in several documents.


Method Index


o AddProductContext(CATILinkableObject_var&)
This method inserts the given product reference in a CATProcess document.
o AddResourceContext(CATILinkableObject_var&)
This method inserts the given resource (product) reference in a CATProcess document.
o CreateProcess(CATUnicodeString&)
Creates a process.
o GetAllProcess()
This method will return the list of root processes available under the ProcessList of the given CATProcess document.
o GetProductContext()
This method returns the list of products directly underneath the “ProductList” node in the PPR tree of the CATProcess document.
o GetResourceContext()
This method returns the list of resources directly underneath the “ResourceList” node in the PPR tree of CATProcess document.
o RemoveProcess(CATISPPActivityRoot_var&)
Removes a process.
o RemoveProductContext(CATILinkableObject_var&)
This method removes the given product reference from the CATProcess document.
o RemoveResourceContext(CATILinkableObject_var&)
This method removes the given resource (product) reference in a CATProcess document.

Methods


o AddProductContext
public virtual void AddProductContext( const CATILinkableObject_var& iLinkableObj)= 0
This method inserts the given product reference in a CATProcess document. This will add an instance of inserted product reference directly underneath the “ProductList” node of PPR Tree.
Parameters:
iLinkableObj
the reference product whose instance is to be added as product context to the CATProcess document.
o AddResourceContext
public virtual void AddResourceContext( const CATILinkableObject_var& iLinkableObj)= 0
This method inserts the given resource (product) reference in a CATProcess document. This will add an instance of inserted resource reference directly underneath the “ResourceList” node of PPR tree.
Parameters:
iLinkableObj
the reference product to add as resource context.
o CreateProcess
public virtual CATISPPActivityRoot_var CreateProcess( const CATUnicodeString& iTypeToCreate=NULL_string) const = 0
Creates a process.
Parameters:
iTypeToCreate
type of activity to create ( as a root ).
Returns:
Handler on the process newly created.
o GetAllProcess
public virtual CATListValCATBaseUnknown_var* GetAllProcess()const = 0
This method will return the list of root processes available under the ProcessList of the given CATProcess document. There is only ONE Root process available under the ProcessList of the CATProcess document in V5.
Returns:
Handler to the list of such root processes
o GetProductContext
public virtual CATListValCATBaseUnknown_var* GetProductContext()const = 0
This method returns the list of products directly underneath the “ProductList” node in the PPR tree of the CATProcess document.
Returns:
Pointer to the list of such products.
o GetResourceContext
public virtual CATListValCATBaseUnknown_var* GetResourceContext()const = 0
This method returns the list of resources directly underneath the “ResourceList” node in the PPR tree of CATProcess document.
Returns:
Pointer to the list of such resources.
o RemoveProcess
public virtual int RemoveProcess( const CATISPPActivityRoot_var& iProcess) const = 0
Removes a process.
Parameters:
iProcessRoot
activity to remove.
Returns:
Warning: returns 0 if succeded only since CXR3SP4 ( before, returns 1 when succeded ).
o RemoveProductContext
public virtual void RemoveProductContext( const CATILinkableObject_var& iLinkableObj)= 0
This method removes the given product reference from the CATProcess document. This will remove the product instance under the “ProductList” node of PPR Tree.
Parameters:
iLinkableObj
the reference product whose instance is to be removed from the CATProcess document
o RemoveResourceContext
public virtual void RemoveResourceContext( const CATILinkableObject_var& iLinkableObj)= 0
This method removes the given resource (product) reference in a CATProcess document. This will remove the product instance under the “ResourceList” node of PPR Tree.
Parameters:
iLinkableObj
the reference product whose instance is to be removed from the CATProcess document

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

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