CATStrUseItf Interface CATIStrUseDetailFeature
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIStrUseDetailFeature
Interface to manage the Endcut / Slot.
There are two ways to initialize the attributes of a detailing feature:
- Automatic way (valid only for Endcut): use InitByName() to automatically set the type and parameters from the Endcut table
- Manual way: use SetType(), SetName() and SetParameters() to explicitly set the values. This mode is usefull for
defining features are not in the PRMTable or for multi-creation performance.
Method Index
- o
CreateSlotContourBody(CATBody_var&)
- Creates the slot contour body.
- o
GetCoordinates(CATMathPoint&)
- Retrieves the location of the connection.
- o
GetLinkedReferenceUdf(CATBaseUnknown_var&)
- If the detailing feature is linked with a UDF feature, retrieves it.
- o
GetName(CATUnicodeString&)
- Gets the name of this detailing feature.
- o
GetOperatedFunction(CATIMmiMechanicalFeature_var&)
- Retrieve the function operated by this detailing feature.
- o
GetParameters(CATListValCATICkeParm_var&)
- Gets the list of parameters of this detailing feature.
- o
GetParameters(CATLISTV(CATIMmiMechanicalFeature_var)&)
-
- o
GetType(CATUnicodeString&)
- Gets the type of this detailing feature.
- o
Get_SlotContour(CATIMmiMechanicalFeature_var&)
- Retrieves the Slot contour.
- o
InitByName(CATUnicodeString&)
- Automatically initializes an endcut with its reference name as defined in
the first column of the Endcut Table defined in the Data Setup.
- o
InitFromUdf(CATBaseUnknown_var&,int)
- Automatically intializes a detailing feature using a UDF feature.
- o
SetName(CATUnicodeString&)
- Sets the unique name of this detailing feature without valuating its parameters.
- o
SetParameters(CATListValCATICkeParm_var&)
- Sets the list of parameters of this detailing feature.
- o
SetParameters(CATLISTV(CATIMmiMechanicalFeature_var)&)
-
- o
SetType(CATUnicodeString&)
- Sets the type of this detailing feature without valuating its parameters.
- o
UnlinkWithReference()
- If the detailing feature is linked with its reference, cuts the link.
- o
Update()
- Updates the connection coordinate and visulization for this detailing feature.
Methods
o CreateSlotContourBody
| public virtual CreateSlotContourBody( | | ospBody) |
-
Creates the slot contour body.
- Parameters:
-
- ospBody
- Created slot contour.
o GetCoordinates
| public virtual GetCoordinates( | | oCoordinate) |
-
Retrieves the location of the connection. For a slot, this is the intersection of
trace of the penetrating profile with the molded surface of the Panel / Profile. Be aware
that this method does not perform any computation, make sure that the detail feature is
up to date.
This method is valid only for SFD.
- Parameters:
-
- oCoordinate
- Coordinates.
o GetLinkedReferenceUdf
| public virtual GetLinkedReferenceUdf( | | ospUdfFeature) |
-
If the detailing feature is linked with a UDF feature, retrieves it. Otherwise returns NULL_var.
The returned object adheres to CATIUdfInstantiate.
- Parameters:
-
- ospUdfFeature
- The UDF feature linked with the detailing feature.
o GetName
| public virtual GetName( | | oName) |
-
Gets the name of this detailing feature.
- Parameters:
-
- oName
- Name.
o GetOperatedFunction
| public virtual GetOperatedFunction( | | ospFunction) |
-
Retrieve the function operated by this detailing feature.
- Parameters:
-
- ospFunction
- Plate / Profile feature.
o GetParameters
| public virtual GetParameters( | | oListParams) |
-
Gets the list of parameters of this detailing feature.
- Parameters:
-
- oListOfParams
- List of parameters.
o GetParameters
| public virtual GetParameters( | | oListOfParams) |
-
- Deprecated:
- R216 use #GetParameters
Get the list of parameters of this endcut / slot.
- Parameters:
-
- oListOfParams
- List of parameters.
o GetType
| public virtual GetType( | | oType) |
-
Gets the type of this detailing feature.
- Parameters:
-
- oType
- Type.
o Get_SlotContour
| public virtual Get_SlotContour( | | oSpec) |
-
Retrieves the Slot contour.
This method is valid only for SFD.
- Parameters:
-
- oSpec
- Slot contour.
o InitByName
| public virtual InitByName( | const | iName) |
-
Automatically initializes an endcut with its reference name as defined in
the first column of the Endcut Table defined in the Data Setup.
- Parameters:
-
- iName
- Name.
o InitFromUdf
| public virtual InitFromUdf( | const | ispUdfFeature, |
| | iWithLink) |
-
Automatically intializes a detailing feature using a UDF feature.
- Parameters:
-
- ispUdfFeature
- The UDF feature to instantiate.
- iWithLink
- 1 iif the instantiated parameters need to be linked to the slot reference
0 otherwise
o SetName
| public virtual SetName( | const | iName) |
-
Sets the unique name of this detailing feature without valuating its parameters.
- Parameters:
-
- iName
- Name.
o SetParameters
| public virtual SetParameters( | const | iListParams) |
-
Sets the list of parameters of this detailing feature.
The parameters have to be persistent.
- Parameters:
-
- iListParams
- List of parameters.
o SetParameters
| public virtual SetParameters( | const | iListParams) |
-
- Deprecated:
- R216 use #SetParameters
Sets the list of parameters of this endcut / slot coming from the PRMTable by using CATIStrUseInitResources.
If some parameters already exist, this method does nothing.
- Parameters:
-
- iListParams
- List of parameters.
o SetType
| public virtual SetType( | const | iType) |
-
Sets the type of this detailing feature without valuating its parameters.
- Parameters:
-
- iType
- Type.
o UnlinkWithReference
| public virtual UnlinkWithReference( | ) |
-
If the detailing feature is linked with its reference, cuts the link.
o Update
-
Updates the connection coordinate and visulization for this detailing feature.
This object is included in the file: CATIStrUseDetailFeature.h
If needed, your Imakefile.mk should include the module: CATStrUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.