All Frameworks Class Hierarchy This Framework Next Indexes
DNBD5IInterfaces Interface DNBID5IExtractKinematics
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---DNBID5IExtractKinematics
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface DNBID5IExtractKinematics
Role: Interface to extract kinematics information of D5 imported device.
The methods of this interface allows to explore D5 device data and extract
kinematic joint details of device parts.
Note: For proper use of this interface, users should turn ON env variable
DLM_DISABLE_D5_KIN_IMPORT while importing D5 devices. This will ensure
loading of only geometric data and not the kinematics data of the imported
D5 device.
Method Index
- o
GetAssociatedKinParts(CATIProduct_var&,CATListValCATBaseUnknown_var&)
- Gets the list of inner parts.
- o
GetFixedPart(CATIProduct_var&)
- Gets fixed part of the D5 device mechanism.
- o
GetPartKinematicsInfo(CATIProduct_var&,CATIProduct_var&,CATUnicodeString&,DNBD5JointType&,CATIProduct_var&,CATIProduct_var&,int&)
- From the inner part and outer part pair get the underlying joint
details
- o
GetPartKinematicsInfo(CATIProduct_var&,CATIProduct_var&,CATUnicodeString&,DNBD5JointType&,CATMathTransformation&,CATMathTransformation&,int&)
- From the inner part and outer part pair get the underlying joint
details
- o
GetPartsOfDevice(CATListValCATBaseUnknown_var&)
- Gets all the parts of the device in a list.
Methods
o GetAssociatedKinParts
public virtual HRESULT GetAssociatedKinParts( | const CATIProduct_var& | iOuterPart, |
| CATListValCATBaseUnknown_var& | oInnerPartList) = 0 |
-
Gets the list of inner parts. For all the joints defined on the part
(iOuterPart) where part happens to be outer part of the joint, get
inner part of the joint and add to the inner parts list (oInnerPartList).
- Parameters:
-
- iOuterPart
- Part which happens to be outer part of a joint.
- oInnerPartList
- List of inner part of joints defined on the iOuterPart.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetFixedPart
public virtual HRESULT GetFixedPart( | CATIProduct_var& | oFixedPart) = 0 |
-
Gets fixed part of the D5 device mechanism.
- Parameters:
-
- oFixedPart
- Fixed part of the D5 mechanism.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPartKinematicsInfo
public virtual HRESULT GetPartKinematicsInfo( | const CATIProduct_var& | iOuterPart, |
| const CATIProduct_var& | iInnerPart, |
| CATUnicodeString& | oJointName, |
| DNBD5JointType& | oJntType, |
| CATIProduct_var& | oOuterAxisPrd, |
| CATIProduct_var& | oInnerAxisPrd, |
| int& | oCommand) = 0 |
-
From the inner part and outer part pair get the underlying joint
details
- Parameters:
-
- iOuterPart
- Outer part of the joint
- iInnerPart
- Inner part of the joint
- oJointName
- Name of the joint
- oJntType
- Joint type
- oOuterAxisPrd
- Frame of interest indicating joint location with respect to Outer
part
- oInnerAxisPrd
- Frame of intereat indicating joint location with respect to inner
part
- oCommand
- Integer value, a non zero value indicates the given joint is command
joint
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPartKinematicsInfo
-
From the inner part and outer part pair get the underlying joint
details
- Parameters:
-
- iOuterPart
- Outer part of the joint
- iInnerPart
- Inner part of the joint
- oJointName
- Name of the joint
- oJntType
- Joint type
- oOuterTransform
- Absolute Transformation matrix indicating join location with
respect to outer part
- oInnerTransform
- Absolute Transformation matrix indicating join location with
respect to inner part
- oCommand
- Integer value, a non zero value indicates the given joint is command
joint
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPartsOfDevice
public virtual HRESULT GetPartsOfDevice( | CATListValCATBaseUnknown_var& | oPartList) = 0 |
-
Gets all the parts of the device in a list.
- Parameters:
-
- oPartList
- List of parts belonging to the Device.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
This object is included in the file: DNBID5IExtractKinematics.h
If needed, your Imakefile.mk should include the module: DNBD5IItf