All Frameworks  Class Hierarchy  This Framework  Indexes   

CATInstantCollabDesignCAAItf Interface CATICollabServices

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


interface CATICollabServices


Method Index


o AssignCollabId(CATBaseUnknown*)
Create a new CATIColId for iObject
o AssociateCollabId(CATBaseUnknown*,void*)
Associate iObject with a collaboration Id built from iUUIDBuffer
o CompareCollaborativeFeatures(CATBaseUnknown*,CATBaseUnknown*,int&)
Compare two collaborative features with a unique sorting key
This service is usefull in a multiple concurrent design environement to guarantee that
the features will be positionned in the same order in any document.
o GetCollabIdManager(CATIColIdManager**,CATBaseUnknown*)
Get a pointer to the collab id manager
o GetCollabUUID(CATBaseUnknown*,CATIColId**,int)
Retreive the Collaboration Id opCollId of a given feature iObject
o GetCurrentDocumentPtr(CATDocument*&,CATBaseUnknown*)
Get a pointer to the current document
o GetPublicSharableFather(CATISpecObject_var&)
Return the first sharable iObject's father with PUBLIC_SHARE access
o GetSharableChildren(CATBaseUnknown*&,CATLISTP(CATBaseUnknown)*&)
Get all the children of iObject inside the list oList
o GetSharableFathers(CATBaseUnknown*&,CATLISTP(CATBaseUnknown)*&)
Get all the father chain of iObject and fill the oList list
o GetSharableInternalDependencies(CATBaseUnknown*&,CATLISTP(CATBaseUnknown)*&)
Get all the dependencies (tk_specobject links) of iObject inside the list oList
o ListKnowlegdeRelations(CATISpecObject*,CATListPtrCATBaseUnknown&,CATListPtrCATBaseUnknown*)
Get all the relations valuating the params of iObject inside the list oList.

Methods


o AssignCollabId
public virtual AssignCollabId( const iObject)
Create a new CATIColId for iObject
o AssociateCollabId
public virtual AssociateCollabId( const iObject,
iUUIDBuffer)
Associate iObject with a collaboration Id built from iUUIDBuffer
Parameters:
iObject
Object to identify
iUUIDBuffer
Buffer used to create the CATIColId which will indetify the input object
The buffer MUST contain 16 bytes
o CompareCollaborativeFeatures
public virtual CompareCollaborativeFeatures( const pObj1,
const pObj2,
oRes)
Compare two collaborative features with a unique sorting key
This service is usefull in a multiple concurrent design environement to guarantee that
the features will be positionned in the same order in any document.
Parameters:
oRes
oRes= -1 if pObj1 must be before pObj2 oRes = 0 if pObj1 and pOb2 have the same id oRes = 1 if pObj1 must be after pObj2
o GetCollabIdManager
public virtual GetCollabIdManager( oManager,
const iReferenceObject= NULL)
Get a pointer to the collab id manager
Parameters:
oManager
[out, CATBaseUnknown#Release]
iReferenceObject
: If iReferenceObject is not null the id manager which is responsible of this object is returned. If iReferenceObject is null, default id manager is retrieved.
o GetCollabUUID
public virtual GetCollabUUID( const iObject,
opCollId,
iCreateIfNeeded=0)
Retreive the Collaboration Id opCollId of a given feature iObject
Parameters:
iObject
object for wich Id is requested
opCollId
[out, CATBaseUnknown#Release]
o GetCurrentDocumentPtr
public virtual GetCurrentDocumentPtr( oDocument,
const iReferenceObject= NULL)
Get a pointer to the current document
Parameters:
oDocument
the current document. No addRef is done !!!
iReferenceObject
if not null, the document returned thanks to CATILinkableObject interface is returned. if null, the FrmEditor is used
o GetPublicSharableFather
public virtual GetPublicSharableFather( iObject)
Return the first sharable iObject's father with PUBLIC_SHARE access
o GetSharableChildren
public virtual GetSharableChildren( iObject,
oList)
Get all the children of iObject inside the list oList
Parameters:
iObject
Object to process
oList
OUT : list containing the children
o GetSharableFathers
public virtual GetSharableFathers( iObject,
oList)
Get all the father chain of iObject and fill the oList list
Parameters:
iObject
Object to process
oList
OUT : list containing the fathers
o GetSharableInternalDependencies
public virtual GetSharableInternalDependencies( iObject,
oList)
Get all the dependencies (tk_specobject links) of iObject inside the list oList
Parameters:
iObject
Object to process
oList
OUT : list containing the tk_specobject dependencies
o ListKnowlegdeRelations
public virtual ListKnowlegdeRelations( iObject,
oList,
oParamList=NULL)
Get all the relations valuating the params of iObject inside the list oList.
Parameters:
iObject
Object to process
oList
OUT : list containing the knowledge relations

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

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