All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMDesktopObjects Interface CATIVPMVDAModify2

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

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


interface CATIVPMVDAModify2

This interface defines the command to modify the values of attributes of existing objects.
Role : When an generic object exists, this command hides all the mechanism of changing the values of the object, and provides a way to access to the data by user-exit.


Method Index


o get_Object(CATIVpmFactoryObject*&)
This method gives access to the Object for which the values of the attributes will change.
o get_Value(CATListOfCATUnicodeString*&,_SEQUENCE_CORBAAny*&)
This method gives access to the list of attribute names to change and their new values.
o put_Object(CATIVpmFactoryObject*)
This method sets the Object for which the values of attributes will change.
o put_Value(CATListOfCATUnicodeString&,_SEQUENCE_CORBAAny&)
This method sets the list of attributes to change, with their names and their new values.

Methods


o get_Object
public virtual HRESULT get_Object(CATIVpmFactoryObject*& oObject)= 0
This method gives access to the Object for which the values of the attributes will change. It is designed for user-exit purposes and should not be used in another context.
Parameters:
oObject
The Object to modify.
Returns:
Always S_OK.
o get_Value
public virtual HRESULT get_Value(CATListOfCATUnicodeString*& oAttributeNames,
_SEQUENCE_CORBAAny*& oListOfValues)= 0
This method gives access to the list of attribute names to change and their new values. It is designed for user-exit purposes and should not be used in another context.
Parameters:
oAttributeNames
The list of attribute names to modify.
oListOfValues
The list of the corresponding new values to set.
Returns:
Always S_OK.
o put_Object
public virtual HRESULT put_Object(CATIVpmFactoryObject* iObject)= 0
This method sets the Object for which the values of attributes will change.
Parameters:
iObject
The Object to modify.
Returns:
Always S_OK.
o put_Value
public virtual HRESULT put_Value( const CATListOfCATUnicodeString& iAttributeNames,
const _SEQUENCE_CORBAAny& iListOfValues)= 0
This method sets the list of attributes to change, with their names and their new values.
Parameters:
iAttributeNames
The list of attribute names to change.
iListOfValues
The list of corresponding values (same order as the attribute names).
Returns:
Always S_OK, but if the two lists have not the same length, the command will not be executable.

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

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