Public Member Functions | Public Attributes

MLSolidWorksMotionStudy Class Reference

Impliments the IMotionStudy interface of the SolidWorks API. More...

#include <+SolidWorks/MLSolidWorksMotionStudy.h>

Inheritance diagram for MLSolidWorksMotionStudy:
Inheritance graph
[legend]
Collaboration diagram for MLSolidWorksMotionStudy:
Collaboration graph
[legend]

List of all members.

Public Member Functions

function MLSolidWorksMotionStudy (in rawIMStudyPointer)
 Class constructor.
function Calculate (in obj)
 Runs the active study.
function GetTime (in obj)
 Gets the time, in seconds, where the timebar is on the timeline for this motion study.
function SetTime (in obj, in Time)
 Sets the time, in seconds, where the timebar is on the timeline for this motion study.
function SetExternalMotor (in obj, in motorName, in state)
 Sets the ExternalState property of a given motor.
function SetExternalForce (in obj, in forceName, in state)
 Sets the ExternalState property of a given force.
function SetFireOutputTimeStepEvents (in obj, in state)
 Sets whether the MotorOutputTimeStepChangeNotify event is.
function Play (in obj)
 Plays the animation; the start point is where the animation timebar is located.
function PlayFromStart (in obj)
 Plays the animation from the beginning.
function Stop (in obj)
 Stops the currently playing animation.

Public Attributes

 Name
 Starts running or calculating the study.
 m_CADRawPointer

Detailed Description

Impliments the IMotionStudy interface of the SolidWorks API.


Constructor & Destructor Documentation

function MLSolidWorksMotionStudy ( in  rawIMStudyPointer )

Class constructor.

Parameters:
rawIMStudyPointeris the COM pointer to the IMotionStudy object.

Member Function Documentation

function Calculate ( in  obj )

Runs the active study.

Parameters:
objis the instance if the object calling and is implicit.
Return values:
statusTrue if the calculation is performed, false if not
Remarks

You can only use this method on an active motion study.

function GetTime ( in  obj )

Gets the time, in seconds, where the timebar is on the timeline for this motion study.

Parameters:
objis the instance if the object calling and is implicit.
Return values:
simTimeTime, in seconds. It also controls where the timebar is on the timeline
function Play ( in  obj )

Plays the animation; the start point is where the animation timebar is located.

This does not perform a Calculate operation.

Parameters:
objis the instance if the object calling and is implicit.
function PlayFromStart ( in  obj )

Plays the animation from the beginning.

This does not perform a Calculate operation.

Parameters:
objis the instance if the object calling and is implicit.
function SetExternalForce ( in  obj,
in  forceName,
in  state 
)

Sets the ExternalState property of a given force.

Parameters:
objis the instance if the object calling and is implicit.
forceNameForce name to set as external.
stateTrue to set as external, false for a regular force.
Return values:
statusfalse if all is well, True otherwise.
function SetExternalMotor ( in  obj,
in  motorName,
in  state 
)

Sets the ExternalState property of a given motor.

Parameters:
objis the instance if the object calling and is implicit.
motorNameMotor name to set as external.
stateTrue to set as external, false for a regular motor.
Return values:
statusTrue if all is well, false otherwise.
function SetFireOutputTimeStepEvents ( in  obj,
in  state 
)

Sets whether the MotorOutputTimeStepChangeNotify event is.

fired at output time steps or integrator time steps.

Parameters:
objis the instance if the object calling and is implicit.
stateSet it to true ot false.
function SetTime ( in  obj,
in  Time 
)

Sets the time, in seconds, where the timebar is on the timeline for this motion study.

Parameters:
objis the instance if the object calling and is implicit.
TimeTime, in seconds, where to place the timebar on the timeline
Return values:
statusTrue if the timebar is set to the specified time, false if not.
function Stop ( in  obj )

Stops the currently playing animation.

Parameters:
objis the instance if the object calling and is implicit.

Member Data Documentation

m_CADRawPointer [inherited]
Name [inherited]

Starts running or calculating the study.

Parameters:
objis the instance if the object calling and is implicit.
Return values:
statusThe Status of the calculation process.

The documentation for this class was generated from the following file: