All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

ObjectSpecsModeler Class ObjectCCP_SPEC

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---ObjectModelerBase.CATICutAndPastable
        |
        +---ObjectCCP_SPEC
 

Usage: you can derive this class.


public class ObjectCCP_SPEC

Base class to give implementation for CATICutAndPastable.

See also:
CATICutAndPastable


Constructor and Destructor Index


o ObjectCCP_SPEC()
Constructs a ObjectCCP_SPEC
o ~ObjectCCP_SPEC()

Method Index


o BoundaryExtract(ListOfVarBaseUnknown&,ListOfVarBaseUnknown*,CATFormat*)
Lists objects to extract.
o BoundaryRemove(ListOfVarBaseUnknown&,ListOfVarBaseUnknown*,CATFormat*)
Creates a list of objects to be removed.
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 objects 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.
o Update(CATBaseUnknown_Associations&,CATFormat*,ListOfVarBaseUnknown*)
Makes in the client, the update of data and relations.

Constructor and Destructor


o ObjectCCP_SPEC
public ObjectCCP_SPEC()
Constructs a ObjectCCP_SPEC
o ~ObjectCCP_SPEC
public virtual ~ObjectCCP_SPEC()

Methods


o BoundaryExtract
public virtual int BoundaryExtract(ListOfVarBaseUnknown& ioObjectsAlreadyInBoundary,
const ListOfVarBaseUnknown* iObjectsToAdd=NULL,
const CATFormat* iAnImposedFormat=NULL) const
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
Creates a list of objects to be removed.
Role: used on cut and delete.
Parameters:
ioObjectsAlreadyInBoundary
list of objects to be removed.
iObjectsToRemove
list of objects to be removed to be added to existing list.
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* iAnImposedFormat=NULL)
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
Creates a structure to receive the boundary objects 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
Lists formats which can be extracted from the selection.
Role: used on copy.
o ListPasteFormats
public virtual CATLISTP(CATFormat) ListPasteFormats()const
Lists formats which can be pasted.
Role: used on paste.
o ListRemoveFormats
public virtual CATLISTP(CATFormat) ListRemoveFormats()const
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,
const CATFormat* iAnImposedFormat=NULL)
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& iObjectsToRemove,
const CATFormat* iAnImposedFormat=NULL)
Removes objects.
Role: used on cut and delete.
Parameters:
iObjectsToRemove
list of objects to be removed.
iAnImposedFormat
if this format is not valid, it will be reinitialized.
Returns:
1 if there is at least one object removed.
0 otherwise
o Update
public virtual int Update(CATBaseUnknown_Associations& ioAssociationOfObjects,
const CATFormat* iAnImposedFormat=NULL,
ListOfVarBaseUnknown* iToCurObjects=NULL)
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: ObjectCCP_SPEC.h
If needed, your Imakefile.mk should include the module: CATObjectSpecsModeler

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