root/tags/version-3.00/RWTHMindstormsNXT/doc/functions/help/Stop.html @ 725

Revision 725, 4.5 KB (checked in by atorf, 4 years ago)

Tag 3.00:
Line 
1
2<!DOCTYPE html
3  PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4<html>
5   <head>
6      <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
7   
8      <!--
9This HTML is auto-generated from an M-file.
10To make changes, update the M-file and republish this document.
11      -->
12      <title>Stop</title>
13      <meta name="generator" content="MATLAB 7.8">
14      <meta name="date" content="2009-07-20">
15      <meta name="m-file" content="script_Stop">
16<link type="text/css" rel="stylesheet" href="../../style.css">
17  </head>
18   <body>
19<p class="header">RWTH - Mindstorms NXT Toolbox</p>
20      <div class="content">
21         <h1>Stop</h1>
22         <!--introduction-->
23         <p>Stops the motor(s)</p>
24         <!--/introduction-->
25         <h2>Contents</h2>
26         <div>
27            <ul>
28               <li><a href="#1">Syntax</a></li>
29               <li><a href="#2">Description</a></li>
30               <li><a href="#15">See also</a></li>
31               <li><a href="#18">Signature</a></li>
32            </ul>
33         </div>
34         <h2>Syntax<a name="1"></a></h2><pre>Stop( obj , brakemode, handle)</pre><h2>Description<a name="2"></a></h2>
35         <p><tt>Stop(OBJ)</tt> or <tt>OBJ.Stop</tt> Stops the motor specified in <tt>OBJ</tt> by setting Power to zero an turning off the motor.
36         </p>
37         <p><tt>Stop(OBJ, BRAKEMODE)</tt> Stops the motor specified in <tt>OBJ</tt> with the brakemode specified in <tt>BRAKEMODE</tt>:
38         </p>
39         <p><tt>BRAKEMODE</tt> can take the following values:
40         </p>
41         <p><tt>'nobrake'</tt>, <tt>'off'</tt>, 0, <tt>false</tt>: The electrical power to the specified motor is simply disconnected, the so-called "FLOAT" mode.
42         </p>
43         <p><tt>'brake'</tt>,   <tt>'on'</tt>,  1, <tt>true</tt>: This will actively halt the motor at the current position (until the next movement command).
44         </p>
45         <p><tt>Stop(OBJ, BRAKEMODE, HANDLE)</tt> or <tt>OBJ.Stop(BRAKEMODE, HANDLE)</tt> Use <tt>HANDLE</tt> to identify the connection to use for this command.
46         </p>
47         <p><b>Note:</b></p>
48         <p>To stop all motors at precisely the same time, please see the command <tt>StopMotor</tt>. It can be called with the syntax <tt>StopMotor('all', 'off')</tt> or <tt>StopMotor('all', 'brake')</tt>. When comparing to this <tt>obj.Stop</tt> method, it acts more precise when wanting to stop multiple motors at the same time...
49         </p>
50         <h2>See also<a name="15"></a></h2>
51         <p><a href="NXTMotor.html">NXTMotor</a>, <a href="WaitFor.html">WaitFor</a>, <a href="StopMotor.html">StopMotor</a>, </p>
52         <h2>Signature<a name="18"></a></h2>
53         <div>
54            <ul>
55               <li><b>Author:</b> Aulis Telle, Linus Atorf (see AUTHORS)
56               </li>
57               <li><b>Date:</b> 2009/01/23
58               </li>
59               <li><b>Copyright:</b> 2007-2008, RWTH Aachen University
60               </li>
61            </ul>
62         </div>
63         <p class="footer"><br>
64            Published with wg_publish; V1.0<br></p>
65      </div>
66      <!--
67##### SOURCE BEGIN #####
68%% Stop
69% Stops the motor(s)
70%% Syntax
71%  Stop( obj , brakemode, handle)
72%% Description
73%%
74% |Stop(OBJ)| or |OBJ.Stop| Stops the motor specified in |OBJ| by setting Power to zero
75% an turning off the motor.
76%%
77% |Stop(OBJ, BRAKEMODE)| Stops the motor specified in |OBJ| with the
78% brakemode specified in |BRAKEMODE|:
79%%
80% |BRAKEMODE| can take the following values:
81%%
82% |'nobrake'|, |'off'|, 0, |false|: The electrical power to the specified
83% motor is simply disconnected, the
84% so-called "FLOAT" mode.
85%%
86% |'brake'|,   |'on'|,  1, |true|: This will actively halt the motor at the
87% current position (until the next movement
88% command).
89%%
90% |Stop(OBJ, BRAKEMODE, HANDLE)| or |OBJ.Stop(BRAKEMODE, HANDLE)| Use
91% |HANDLE| to identify the connection to use for this command.
92%%
93%%
94%%
95% *Note:*
96%%
97%%
98% To stop all motors at precisely the same time, please see the command
99% |StopMotor|. It can be called with the syntax |StopMotor('all', 'off')|
100% or |StopMotor('all', 'brake')|. When comparing to this |obj.Stop| method,
101% it acts more precise when wanting to stop multiple motors at the same
102% time...
103%%
104%% See also
105% NXTMotor, WaitFor, StopMotor
106%%
107%%
108%% Signature
109%%
110% * *Author:* Aulis Telle, Linus Atorf (see AUTHORS)
111% * *Date:* 2009/01/23
112% * *Copyright:* 2007-2008, RWTH Aachen University
113%%
114%
115
116##### SOURCE END #####
117-->
118   </body>
119</html>
Note: See TracBrowser for help on using the browser.