*SetState() - for command sets

Sets the state of a force/forcepair, joint/jointpair or motion/motionpair.

Syntax

*SetState(force/forepair|joint/jointpair|motion/motionpair, ON/OFF)

Arguments

force/forcepair|joint/jointpair|motion/motionpair
An existing force/forcepair, joint/jointpair, or motion/motionpair for which the state is being specified.
Type: force|joint|motion
ON/OFF
ON turns on the specified force/forcepair, joint/jointpair, or motion/motionpair.
OFF turns off the specified force/forcepair, joint/jointpair, or motion/motionpair.
Type: boolean

Example

In the example below, the *SetState() statement inside the event definition deactivates the motion m_0:
*BeginMDL(the_model, "MBD Model")
     *Motion(m_0, "Motion 0", MODEL.j_0, ROT)
     *Analysis(analysis_0, "Analysis", def_analysis)
*EndMDL()

*Define Analysis(def_analysis)
     *Event(event_1, "Event", def_event)
*EndDefine()

*DefineEvent(def_event)
     *SetState(MODEL.m_0, OFF)
*EndDefine()

Context

*BeginMDL()

*DefineCommandSet()

Comments

Setting the state of a force, joint, or motion to ON causes that force, joint, or motion to be activated through the solver command file. Setting the state of a force, joint, or motion to OFF causes that force, joint, or motion, or force|joint|motion pair to be deactivated through the solver command file. These commands appear in the solver command file in the order that they appear in the corresponding *DefineCommandSet block and where the *CommandSet() statement occurs within the *DefineAnalysis block.