All Frameworks  Object Hierarchy  This Framework  Indexes

Mechanism (Object)

Interface to access the Mechanism object.

Property Index

Commands
Returns the collection of commands in the mechanism.
FixedPart
Returns or sets the fixed part of the mechanism.
Joints
Returns the collection of joints in the mechanism.
NbCommands
Returns the number of commands in the mechanism.
NbDof
Returns the degree of freedom of the mechanism.
NbJoints
Returns the number of joints in the mechanism.
NbProducts
Returns the number of products (i.

Method Index

AddCommand
Adds a command in the mechanism, on a joint.
AddJoint
Adds a joint in the mechanism.
GetCommandValues
Allows to retrieve current state of the mechanism.
GetProductMotion
Retrieves motion from initial state to current state for a part of the mechanism.
GetProduct
Returns an item from the list of the products involved in the mechanism.
PutCommandValuesWithMultiSteps
Puts command values in given number of steps.
PutCommandValues
Triggers immediate mechanism solving (motion is NOT applied to the model).
ResetCmdValueToZero
Sets the command value to zero for the given command without disturbing part positions.
Update
Reassembles the mechanism after dimension changes in the parts.

Properties


o Property Commands() As (Read Only)
Returns the collection of commands in the mechanism.
Parameters:
oCommands
The collection of commands. This property is read only because because list is aggregated in the Mechanism
o Property FixedPart() As
Returns or sets the fixed part of the mechanism.
Parameters:
oFixedPart
The fixed part.
o Property Joints() As (Read Only)
Returns the collection of joints in the mechanism.
Parameters:
oJoints
The collection of joints. This property is read only because because list is aggregated in the Mechanism
o Property NbCommands() As (Read Only)
Returns the number of commands in the mechanism.
Parameters:
oNbCommands
The number of commands. This property is read only because number depends on commands creation/destruction
o Property NbDof() As (Read Only)
Returns the degree of freedom of the mechanism.
Parameters:
oNbDof
The degree of freedom. This property is read only because because it depends on joints and commands
o Property NbJoints() As (Read Only)
Returns the number of joints in the mechanism.
Parameters:
oNbJoints
The number of joints. This property is read only because number depends on joints creation/destruction
o Property NbProducts() As (Read Only)
Returns the number of products (i.e. bodies) involved in the mechanism.
Parameters:
oNbProducts
The number of products. This property is read only because number depends on joints creation/destruction

Methods


o Func AddCommand( iCmdType,
iJoint) As
Adds a command in the mechanism, on a joint.
Parameters:
iCmdType
The command type.
iJoint
The joint to be driven.
oNewCommand
The newly created command.
o Func AddJoint( iJointType,
iListElem) As
Adds a joint in the mechanism.
Parameters:
iJointType
The joint type.
iListElem
The list of elements expected to locate the joint, depending on the type.
oNewJoint
The newly created joint.
o Sub GetCommandValues( ioCmdValues)
Allows to retrieve current state of the mechanism.
Parameters:
ioCmdValues
current command values
o Sub GetProductMotion( iProduct,
ioMotion)
Retrieves motion from initial state to current state for a part of the mechanism.
Parameters:
iProduct
The moving product
ioMotion
The motion matrix (12 real values, compatible with the Move object)
See also:
Move
o Func GetProduct( iIndex) As
Returns an item from the list of the products involved in the mechanism.
Parameters:
iIndex
The index for the product.
oProduct
The product at that index.
Returns:
HRESULT
o Sub PutCommandValuesWithMultiSteps( iCmdValues,
iNbSteps,
oStepReached)
Puts command values in given number of steps. Visualization is updated after every step.
Parameters:
iCmdValues
Array of target command values (position to achieve)
inbSteps
Number of steps in witch the target command value is to be reached.
Legal values
inbSteps greater than 0
Number of step must be greater than zero.
oStepReached
Number of steps reached successfully.
o Sub PutCommandValues( iCmdValues)
Triggers immediate mechanism solving (motion is NOT applied to the model).
Parameters:
iCmdValues
command values to be solved for
o Sub ResetCmdValueToZero( iCommand)
Sets the command value to zero for the given command without disturbing part positions.
Parameters:
iCommand
The command to reset to zero
o Sub Update()
Reassembles the mechanism after dimension changes in the parts.

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