All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

MechanicalCommands Interface CATIUdfFeatureInstance

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

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


interface CATIUdfFeatureInstance

Interface to edit a User Feature instance.
Role: This interface is implemented on a User Feature to modify it. You can change its inputs or/and modify the value of its published parameters.
Note:Before any calls, you must call Init, and the last call must be Reset.

See also:
CATIUdfFactory


Method Index


o FilterInput(CATUnicodeString&,CATPathElement*,CATPathElement**)
Filters the selection.
o FilterInput(int,CATPathElement*,CATPathElement**)
Filters the selection.
o GetInput(CATUnicodeString&,CATBaseUnknown_var&)
Retrieves one input.
o GetInput(int,CATBaseUnknown_var&)
Retrieves one input.
o GetInputRole(int,CATUnicodeString&)
Retrieves the role of one input.
o GetInputsNumber(int&)
Retrieves the input count.
o GetOutput(CATUnicodeString&,CATBaseUnknown_var&)
Retrieves one output.
o GetOutput(int,CATBaseUnknown_var&)
Retrieves one output.
o GetOutputsNumber(int&)
Retrieves the output count.
o GetParameter(CATUnicodeString&,CATBaseUnknown_var&)
Retrieves a published parameter from its role.
o GetParameterRole(CATBaseUnknown_var&,CATUnicodeString&)
Retrieves the role of a published parameter.
o GetParameters(CATListValCATBaseUnknown_var*&)
Retrieves all published parameters.
o GetSourceInput(CATUnicodeString&,CATBaseUnknown_var&)
Retrieves the source input.
o Init()
Initializes the modification transaction.
o Reset()
Ends the modification transaction.
o SetNewInput(CATUnicodeString&,CATPathElement*)
Changes one input.
o SetNewInput(int,CATPathElement*)
Changes one input.

Methods


o FilterInput
public virtual HRESULT FilterInput( const CATUnicodeString& iRole,
CATPathElement* iSelection,
CATPathElement** oFilteredSelection) = 0
Filters the selection.
Parameters:
iRole
The role of the input.
The role of an input, is the NLS String which appears in the instantiate or in the edit dialog box.
iSelection
A CATPathElement with the new object, this path must contains the full selection path for a valid import mechanism in multidocument context.
oFilteredSelection
A subpath of iSelection
o FilterInput
public virtual HRESULT FilterInput( const int iPos,
CATPathElement* iSelection,
CATPathElement** oFilteredSelection) = 0
Filters the selection.
Parameters:
iPos
Input position, from 1 to
GetInputsNumber
iSelection
A CATPathElement with the new object, this path must contains the full selection path for a valid import mechanism in multidocument context.
oFilteredSelection
A subpath of iSelection
o GetInput
public virtual HRESULT GetInput( const CATUnicodeString& iRole,
CATBaseUnknown_var& oInput) = 0
Retrieves one input.
Role:This method returns an input from its role. You can consult the returned input, but don't try to modify it. Use the SetNewInput method to change it.
Parameters:
iRole
The role of the input.
The role of an input, is the NLS String which appears in the instantiate or in the edit dialog box.
oInput
The input.
o GetInput
public virtual HRESULT GetInput( const int iPos,
CATBaseUnknown_var& oInput) = 0
Retrieves one input.
Role:This method returns the iPos input. You can consult the returned input, but don't try to modify it. Use the SetNewInput method to change it.
Parameters:
iPos
Input position, from 1 to
GetInputsNumber
oInput
The iPos input.
o GetInputRole
public virtual HRESULT GetInputRole( const int iPos,
CATUnicodeString& oRole) = 0
Retrieves the role of one input.
Parameters:
iPos
Input position, from 1 to
GetInputsNumber
oRole
The role of the iPos input.
The role of an input, is the NLS String which appears in the instantiate or in the edit dialog box.
Note:The iPos role is the same for all instances, it is independant of the current instance.
o GetInputsNumber
public virtual HRESULT GetInputsNumber(int& oInputCount) = 0
Retrieves the input count.
Parameters:
oInputCount
Count of inputs.
Note:This value is the same for all instances, it is independant of the current instance.
o GetOutput
public virtual HRESULT GetOutput( const CATUnicodeString& iRole,
CATBaseUnknown_var& oInput) = 0
Retrieves one output.
Role:This method returns an output from its role.
Parameters:
iRole
The role of the output.
The role of an output is the Name of the ouput which appears in the tree
oInput
The input.
o GetOutput
public virtual HRESULT GetOutput( const int iPos,
CATBaseUnknown_var& oOutput) = 0
Retrieves one output.
Role:This method returns the iPos output.
Parameters:
iPos
Input position, from 1 to
GetOutputsNumber
oOutput
The iPos output.
o GetOutputsNumber
public virtual HRESULT GetOutputsNumber(int& oOutputCount) = 0
Retrieves the output count.
Parameters:
oOutputCount
Count of outputs.
Note:This value is the same for all instances, it is independant of the current instance.
o GetParameter
public virtual HRESULT GetParameter( const CATUnicodeString& iRole,
CATBaseUnknown_var& oParam) = 0
Retrieves a published parameter from its role.
Parameters:
iRole
The role of the parameter you want to retrieve.
The role of a parameter, is the NLS String which appears in the instantiate or in the edit dialog box and it is the string in the specifications tree under the User Feature instance or reference.
oParam
A published parameter.
Use the CATICkeParm to modify it.
o GetParameterRole
public virtual HRESULT GetParameterRole( const CATBaseUnknown_var& iParam,
CATUnicodeString& oRole) = 0
Retrieves the role of a published parameter.
Parameters:
iParam
A published parameter which must be one of the list given by
GetParameters
oRole
The role of the iParam parameter.
The role of a parameter, is the NLS String which appears in the instantiate or in the edit dialog box and it is the string in the specifications tree under the User Feature instance or reference.
Note:Roles are independant of the current instance.
o GetParameters
public virtual HRESULT GetParameters(CATListValCATBaseUnknown_var*& oParametersList) = 0
Retrieves all published parameters.
Parameters:
oParametersList
liste of published parameters.
Use the CATICkeParm to modify them.
o GetSourceInput
public virtual HRESULT GetSourceInput( const CATUnicodeString& iRole,
CATBaseUnknown_var& oSourceInput) = 0
Retrieves the source input.
Role:If the input is an external reference, it returns the reference of this external reference. Otherwise it returns the input. See GetInput.
Parameters:
iRole
The role of the input.
The role of an input, is the NLS String which appears in the instantiate or in the edit dialog box.
oSourceInput
The source input.
Returns:
Legal values:
S_OK
The source input is retrieved.
E_FAIL
The source input is not retrieved, for instance because the reference of the external reference is not loaded.
o Init
public virtual HRESULT Init()= 0
Initializes the modification transaction.
Role: Need to be called before all other services in one transaction. At the end of the transaction, call Reset to clean internal data.
o Reset
public virtual HRESULT Reset()= 0
Ends the modification transaction.
Role:: Need to be called at the end of a modification transaction to clean all internal data. At the beginning of the transation, you have call the Init method.
o SetNewInput
public virtual HRESULT SetNewInput( const CATUnicodeString& iRole,
CATPathElement* iSelection) = 0
Changes one input.
Role:This method replaces the input whose role is iRole by the new one.
Parameters:
iRole
The role of the input.
The role of an input, is the NLS String which appears in the instantiate or in the edit dialog box.
iSelection
A CATPathElement with the new object, this path must contains the full selection path for a valid import mechanism in multidocument context.
o SetNewInput
public virtual HRESULT SetNewInput( const int iPos,
CATPathElement* iSelection) = 0
Changes one input.
Role:This method replaces the iPos input by the new one.
Parameters:
iPos
Input position, from 1 to
GetInputsNumber
iSelection
A CATPathElement with the new object, this path must contains the full selection path for a valid import mechanism in multidocument context.

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

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