CATPLMFastenerUseItf Interface CATIFmaComponentBrowse
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIFmaComponentBrowse
Interface to get the information of the fastener component.
Role: Components that implement
CATIFmaComponentBrowse are Fst_Component
Method Index
- o
GetComponentID(CATUnicodeString&)
- Gets the name of this fastener component.
- o
GetLinked3DComponentShape(CATOmbObjectInContext**)
- Gets the pointed element by this fastener component.
- o
GetLocationParameterValue(double*,CATUnicodeString&)
- Gets the value of the location parameter (IOFFSET, JOFFSET, KOFFSET).
- o
GetLocationParameterValue(CATICkeParm**,CATUnicodeString&)
- Gets the value of the location parameter (IOFFSET, JOFFSET, KOFFSET).
- o
GetShapeDefinitionParameterValue(CATICkeParm**,CATUnicodeString&)
- Gets the knowledge parameter value of the requested shape definition parameter.
- o
GetShapeDefinitionValue(CATICkeParm**)
- Gets the knowledge parameter of the shape definition of this fastener component.
- o
GetShapeDefinitionValue(CATUnicodeString&)
- Gets the shape definition name of this fastener component.
Methods
o GetComponentID
| public virtual GetComponentID( | | oID) |
-
Gets the name of this fastener component.
- Parameters:
-
- oID
- the fastener component name.
- Returns:
-
- S_OK
- the component name was found.
- E_FAIL
- otherwise (no component).
o GetLinked3DComponentShape
| public virtual GetLinked3DComponentShape( | | oCompObjectInContext) |
-
Gets the pointed element by this fastener component.
- Parameters:
-
- oCompObjectInContext
- [out, CATOmbObjectInContext#Release] the information representing the pointed element.
- Returns:
-
- S_OK
- if the CATOmbObjectInContext was found.
- E_FAIL
- otherwise.
o GetLocationParameterValue
| public virtual GetLocationParameterValue( | | oParamValue, |
| const | iLocationParamID) |
-
Gets the value of the location parameter (IOFFSET, JOFFSET, KOFFSET).
- Parameters:
-
- iLocationParamID
- the location parameter name
- oParamValue
- the value of the location parameter
- Returns:
-
- S_OK
- the location parameter was successfully retrieved.
- E_FAIL
- otherwise.
o GetLocationParameterValue
| public virtual GetLocationParameterValue( | | oParm, |
| const | iLocationParamID) |
-
Gets the value of the location parameter (IOFFSET, JOFFSET, KOFFSET).
- Parameters:
-
- iLocationParamID
- the location parameter name
- oParamValue
- the knowledge parameter containing the value of the location parameter
- Returns:
-
- S_OK
- the location parameter was successfully retrieved.
- E_FAIL
- otherwise.
o GetShapeDefinitionParameterValue
| public virtual GetShapeDefinitionParameterValue( | | oParm, |
| const | iShapeDefParamID) |
-
Gets the knowledge parameter value of the requested shape definition parameter.
- Parameters:
-
- iShapeDefParamID
- the shape definition parameter name.
- oParm
- [out, CATICkeParm#Release] the knowledge parameter containing the value of the requested parameter.
- Returns:
-
- S_OK
- the shape definition parameter was found.
- E_FAIL
- otherwise.
o GetShapeDefinitionValue
| public virtual GetShapeDefinitionValue( | | oShapeDefParm) |
-
Gets the knowledge parameter of the shape definition of this fastener component.
- Parameters:
-
- oShapeDefParm
- [out, CATICkeParm#Release] the shape definition knowledge parameter.
- Returns:
-
- S_OK
- the shape definition parameter was found.
- E_FAIL
- otherwise.
S_OK:
E_FAIL:
o GetShapeDefinitionValue
| public virtual GetShapeDefinitionValue( | | oShapeDef) |
-
Gets the shape definition name of this fastener component.
- Parameters:
-
- oShapeDef
- the shape definition.
- Returns:
-
- S_OK
- the shape definition was found.
- E_FAIL
- otherwise.
This object is included in the file: CATIFmaComponentBrowse.h
If needed, your Imakefile.mk should include the module: CATPLMFmaBrowseInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.