All Frameworks Class Hierarchy This Framework Indexes
MechanicalCommands Interface CATIUdfFeatureUser
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIUdfFeatureUser
Interface which enables advanced edition for UserFeature reference.
Role: Interface that enables edition for UserFeature reference.
This interface should be use only for modification of UserFeature reference.
For instantiation, you should use CATIUdfInstantiate interface. For instance edition, use
CATIUdfFeatureInstance .
Method Index
- o
AddOutput(CATISpecObject_var&)
- Creates a new external output.
- o
GetOutputRole(int,CATUnicodeString&)
- Retrieves the role of an output.
- o
GetOutputs(CATListValCATBaseUnknown_var*&)
- Retrieves the list of outputs.
- o
GetPossibleOutputs(CATListValCATBaseUnknown_var*&)
- Retrieves the list of possible outputs.
- o
GetType(CATUnicodeString&)
- Gets the type of the user feature.
- o
RemoveOutput(CATISpecObject_var&)
- Removes an external output.
- o
ReplaceOutput(int,CATISpecObject_var&)
- Replaces the result of an output.
- o
SetOutputRole(int,CATUnicodeString&)
- Sets the role of an output
Role: The role is the name of the output in the tree
The role of the User Feature can not be modified.
- o
SetType(CATUnicodeString&)
- Sets the type of the user feature.
Methods
o AddOutput
| public virtual AddOutput( | const | iInternal) |
-
Creates a new external output.
Role: The result of the output is given by iInternal.
- Parameters:
-
- iInternal
- [in] an internal element.
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise
o GetOutputRole
| public virtual GetOutputRole( | const | iPos, |
| | oRole) |
-
Retrieves the role of an output.
Role: The role is the name of the output in the tree.
- Parameters:
-
- iPos
- [in] The parameter role
iPos=1 corresponds to the User Feature. Always return "MainResult"
iPos=2..,N corresponds to the external outputs.
- oRole
- [out] The role of the output.
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise
o GetOutputs
| public virtual GetOutputs( | | oInternals) |
-
Retrieves the list of outputs.
- Parameters:
-
- oInternals
- The list of ouputs.
This list containts the internal geometrical elements which have
been used for the User Feature or external output result definition.
This list contains elements which have been defined as output
with the AddOuput method.
The size of the list is N.
Element 1 corresponds to the main result (User Feature result).
Element 2..,N corresponds to the external outputs result.
o GetPossibleOutputs
| public virtual GetPossibleOutputs( | | oInternals) |
-
Retrieves the list of possible outputs.
Role: This list contains all the internal geometrical elements which
can be used for the User Feature or external output result definition.
- Parameters:
-
- oInternals
- [out] the list of possible outputs.
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise
o GetType
| public virtual GetType( | | oType) |
-
Gets the type of the user feature.
- Parameters:
-
- oType
- The type of the User Feature
o RemoveOutput
| public virtual RemoveOutput( | const | iInternal) |
-
Removes an external output.
Role: This output was initially created using AddOutput(iInternal).
- Parameters:
-
- iInternal
- [in] an internal element.
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise
o ReplaceOutput
| public virtual ReplaceOutput( | const | iPos, |
| const | iInternal) |
-
Replaces the result of an output.
- Parameters:
-
- iPos
- [in] iPos=1 corresponds to the main result (User Feature result).
iPos=2..,N corresponds to the external outputs result.
- iInternal
- [in] iInternal is the internal element retrieved with GetPossibleOutputs method
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise.
o SetOutputRole
| public virtual SetOutputRole( | const | iPos, |
| const | iRole) |
-
Sets the role of an output
Role: The role is the name of the output in the tree
The role of the User Feature can not be modified.
- Parameters:
-
- iPos
- [in] 1..N. N is the size of the list retrieve with GetOutputs method
iPos=1 corresponds to the User Feature. Always fails.
iPos=2..,N corresponds to the external outputs.
- iRole
- [in] the role of the output.
The role of the User Feature can not be modified.
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise
o SetType
| public virtual SetType( | const | iType) |
-
Sets the type of the user feature.
- Parameters:
-
- iType
- The type of the User Feature
This object is included in the file: CATIUdfFeatureUser.h
If needed, your Imakefile.mk should include the module: CATUdfInterfaces