All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ManufacturingInterfaces Interface CATIMfgCutCopyPaste

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIMfgCutCopyPaste
 

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


interface CATIMfgCutCopyPaste

Interface dedicated to manage Cut, Copy and Paste.
Role: This interface offers services to customize the cut, copy and paste mechanisms.
To define specific behaviours to your manufacturing object during the Cut/Copy/Paste, derive from the supplied ObjectCCP_SPEC adapter class and called in the implementation of each method of CATICutAndPastable the corresponding method of this interface. Thus, you retrieve the default mechanism provided by the manufacturing infrastructure.


Method Index


o BoundaryExtract(ListOfVarBaseUnknown&,ListOfVarBaseUnknown*,CATFormat*)
Lists objects to extract.
o BoundaryRemove(ListOfVarBaseUnknown&,ListOfVarBaseUnknown*,CATFormat*)
Lists objects to remove.
o Create(CATBaseUnknown_Associations&,CATFormat*)
Creates in the client side, all objects required, and provides associations.
o Extract(ListOfVarBaseUnknown&,CATFormat*)
Creates a structure to receive the boundary object in the requested format.
o ListExtractFormats()
Lists formats which can be extracted from the selection.
o ListPasteFormats()
Lists formats which can be pasted.
o ListRemoveFormats()
Lists formats which can be removed from the selection.
o Paste(ListOfVarBaseUnknown&,ListOfVarBaseUnknown*,CATFormat*)
Returns the path of the object to copy.
o Remove(ListOfVarBaseUnknown&,CATFormat*)
Removes objects from the client.
o Update(CATBaseUnknown_Associations&,CATFormat*,ListOfVarBaseUnknown*)
Makes in the client, the update of data and relations.

Methods


o BoundaryExtract
public virtual int BoundaryExtract(ListOfVarBaseUnknown& ioObjectsAlreadyInBoundary,
const ListOfVarBaseUnknown* iObjectsToAdd= NULL,
const CATFormat* iAnImposedFormat=NULL) const = 0
Lists objects to extract.
Role: used on copy.
Parameters:
ioObjectsAlreadyInBoundary
list of objects to extract.
iObjectsToAdd
list objects to add to list of objects to extract.
iAnImposedFormat
if this format is not valid, it will be reinitialized.
Returns:
1 if there is at least one object extracted.
0 otherwise
o BoundaryRemove
public virtual int BoundaryRemove(ListOfVarBaseUnknown& ioObjectsAlreadyInBoundary,
const ListOfVarBaseUnknown* iObjectsToRemove= NULL,
const CATFormat* iAnImposedFormat= NULL) const = 0
Lists objects to remove.
Role: used on cut and delete.
Parameters:
ioObjectsAlreadyInBoundary
list of objects to remove.
iObjectsToRemove
list objects to remove to list of objects to extract.
iAnImposedFormat
if this format is not valid, it will be reinitialized.
Returns:
1 if there is at least one object removed.
0 otherwise
o Create
public virtual int Create(CATBaseUnknown_Associations& ioAssociationOfObjects,
const CATFormat* an_imposed_format= NULL) = 0
Creates in the client side, all objects required, and provides associations.
Parameters:
ioAssociationOfObjects
couples of objects source/target.
iAnImposedFormat
if this format is not valid, it will be reinitialized.
Returns:
0 if failed
o Extract
public virtual VarBaseUnknown Extract(ListOfVarBaseUnknown& iObjectToCopy,
const CATFormat* iAnImposedFormat= NULL) const = 0
Creates a structure to receive the boundary object in the requested format.
Role: used on copy.
Parameters:
iObjectToCopy
list of objects to copy.
iAnImposedFormat
if this format is not valid, it will be reinitialized.
Returns:
structure created by extract.
o ListExtractFormats
public virtual CATLISTP(CATFormat) ListExtractFormats()const = 0
Lists formats which can be extracted from the selection.
Role: used on copy.
o ListPasteFormats
public virtual CATLISTP(CATFormat) ListPasteFormats()const = 0
Lists formats which can be pasted.
Role: used on paste.
o ListRemoveFormats
public virtual CATLISTP(CATFormat) ListRemoveFormats()const = 0
Lists formats which can be removed from the selection.
Role: used on cut and delete.
o Paste
public virtual ListOfVarBaseUnknown Paste(ListOfVarBaseUnknown& iObjectToCopy,
ListOfVarBaseUnknown* iToCurObjects= NULL,
const CATFormat* iAnImposedFormat= NULL) = 0
Returns the path of the object to copy.
Role: used on copy and paste.
Parameters:
iObjectToCopy
list of objects to copy.
iToCurObjects
target objects for paste corresponding to selected objects.
iAnImposedFormat
if this format is not valid, it will be reinitialized.
o Remove
public virtual int Remove(ListOfVarBaseUnknown& iObjectToRemove,
const CATFormat* iAnImposedFormat= NULL) = 0
Removes objects from the client.
Role: used on cut and delete.
Parameters:
iObjectToRemove
list of objects to remove.
iAnImposedFormat
if this format is not valid, it will be reinitialized.
Returns:
structure created by remove.
o Update
public virtual int Update(CATBaseUnknown_Associations& ioAssociationOfObjects,
const CATFormat* iAnImposedFormat= NULL,
ListOfVarBaseUnknown* iToCurObjects= NULL) = 0
Makes in the client, the update of data and relations.
Parameters:
ioAssociationOfObjects
couples of objects source/target.
iAnImposedFormat
if this format is not valid, it will be reinitialized.
iToCurObjects
target objects for paste corresponding to selected objects.
Returns:
0 if failed

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

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