You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doxygen_cxx/classdrake_1_1systems_1_1_simulator-members.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -199,7 +199,7 @@
199
199
<tr><tdclass="entry"><aclass="el" href="classdrake_1_1systems_1_1_simulator.html#aa33b3ce4aeb5d29ac4a16de084bd307b">Simulator</a>(const Simulator &)=delete</td><tdclass="entry"><aclass="el" href="classdrake_1_1systems_1_1_simulator.html">Simulator< T ></a></td><tdclass="entry"></td></tr>
200
200
<trclass="even"><tdclass="entry"><aclass="el" href="classdrake_1_1systems_1_1_simulator.html#a12ea7987a4acd8c4f32226f33fe9dbe4">Simulator</a>(Simulator &&)=delete</td><tdclass="entry"><aclass="el" href="classdrake_1_1systems_1_1_simulator.html">Simulator< T ></a></td><tdclass="entry"></td></tr>
201
201
<tr><tdclass="entry"><aclass="el" href="classdrake_1_1systems_1_1_simulator.html#a4d06ba94298e2cf918910bcc9238f16b">Simulator</a>(const System< T > &system, std::unique_ptr< Context< T >> context=nullptr)</td><tdclass="entry"><aclass="el" href="classdrake_1_1systems_1_1_simulator.html">Simulator< T ></a></td><tdclass="entry"><spanclass="mlabel">explicit</span></td></tr>
202
-
<trclass="even"><tdclass="entry"><aclass="el" href="classdrake_1_1systems_1_1_simulator.html#a849ba63358ef13597faad1be04a999ec">Simulator</a>(std::unique_ptr< const System< T >> system, std::unique_ptr< Context< T >> context=nullptr)</td><tdclass="entry"><aclass="el" href="classdrake_1_1systems_1_1_simulator.html">Simulator< T ></a></td><tdclass="entry"></td></tr>
202
+
<trclass="even"><tdclass="entry"><aclass="el" href="classdrake_1_1systems_1_1_simulator.html#a849ba63358ef13597faad1be04a999ec">Simulator</a>(std::unique_ptr< const System< T >> system, std::unique_ptr< Context< T >> context=nullptr)</td><tdclass="entry"><aclass="el" href="classdrake_1_1systems_1_1_simulator.html">Simulator< T ></a></td><tdclass="entry"><spanclass="mlabel">explicit</span></td></tr>
Copy file name to clipboardExpand all lines: doxygen_cxx/classdrake_1_1systems_1_1_simulator.html
+14-4Lines changed: 14 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -159,6 +159,7 @@
159
159
160
160
<divclass="header">
161
161
<divclass="summary">
162
+
<ahref="#nested-classes">Classes</a> |
162
163
<ahref="#pub-methods">Public Member Functions</a> |
163
164
<ahref="#friends">Friends</a> |
164
165
<ahref="classdrake_1_1systems_1_1_simulator-members.html">List of all members</a></div>
@@ -270,7 +271,7 @@ <h3>How the simulation is stepped: simulation mechanics for authors of discrete
270
271
<trclass="memdesc:afa85ab3036e9c0c5f6c841a346d70d93"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Replace the internally-maintained <aclass="el" href="classdrake_1_1systems_1_1_context.html" title="Context is an abstract class template that represents all the typed values that are used in a System'...">Context</a> with a different one. <ahref="#afa85ab3036e9c0c5f6c841a346d70d93">More...</a><br/></td></tr>
<trclass="memdesc:af0ecc40cda7115ce6a66ba4737bd62a6"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Transfer ownership of this Simulator's internal <aclass="el" href="classdrake_1_1systems_1_1_context.html" title="Context is an abstract class template that represents all the typed values that are used in a System'...">Context</a> to the caller.<ahref="#af0ecc40cda7115ce6a66ba4737bd62a6">More...</a><br/></td></tr>
<p>Create a Simulator which additionally maintains ownership of the <aclass="el" href="classdrake_1_1systems_1_1_system.html" title="Base class for all System functionality that is dependent on the templatized scalar type T for input,...">System</a>. </p>
<p>Transfer ownership of this Simulator's internal <aclass="el" href="classdrake_1_1systems_1_1_context.html" title="Context is an abstract class template that represents all the typed values that are used in a System'...">Context</a> to the caller. </p>
985
-
<p>The Simulator will no longer contain a <aclass="el" href="classdrake_1_1systems_1_1_context.html" title="Context is an abstract class template that represents all the typed values that are used in a System'...">Context</a>. The caller must not attempt to advance the simulator in time after that point. </p><dlclass="section see"><dt>See also</dt><dd><aclass="el" href="classdrake_1_1systems_1_1_simulator.html#afa85ab3036e9c0c5f6c841a346d70d93" title="Replace the internally-maintained Context with a different one.">reset_context()</a></dd></dl>
993
+
<p>(Deprecated.) </p>
994
+
<dlclass="deprecated"><dt><b><aclass="el" href="deprecated.html#_deprecated000025">Deprecated:</a></b></dt><dd>Use get_context()->Clone() and reset_context(nullptr) instead. <br/>
995
+
This will be removed from Drake on or after 2025-06-01.</dd></dl>
<p>Replace the internally-maintained <aclass="el" href="classdrake_1_1systems_1_1_context.html" title="Context is an abstract class template that represents all the typed values that are used in a System'...">Context</a> with a different one. </p>
1006
-
<p>The current <aclass="el" href="classdrake_1_1systems_1_1_context.html" title="Context is an abstract class template that represents all the typed values that are used in a System'...">Context</a> is deleted. This is useful for supplying a new set of initial conditions. You should invoke <aclass="el" href="classdrake_1_1systems_1_1_simulator.html#aa1862c2aeab9862e391194d157a96c21" title="Prepares the Simulator for a simulation.">Initialize()</a> after replacing the <aclass="el" href="classdrake_1_1systems_1_1_context.html" title="Context is an abstract class template that represents all the typed values that are used in a System'...">Context</a>. </p><dlclass="params"><dt>Parameters</dt><dd>
1016
+
<p>This is useful for supplying a new set of initial conditions. You should invoke <aclass="el" href="classdrake_1_1systems_1_1_simulator.html#aa1862c2aeab9862e391194d157a96c21" title="Prepares the Simulator for a simulation.">Initialize()</a> after replacing the <aclass="el" href="classdrake_1_1systems_1_1_context.html" title="Context is an abstract class template that represents all the typed values that are used in a System'...">Context</a>. </p><dlclass="params"><dt>Parameters</dt><dd>
1007
1017
<tableclass="params">
1008
1018
<tr><tdclass="paramname">context</td><td>The new context, which may be null. If the context is null, a new context must be set before attempting to step the system forward. </td></tr>
<p>Returns the output port for the generalized forces implementing the control. </p>
1595
-
<p>(Deprecated.) </p><dlclass="deprecated"><dt><b><aclass="el" href="deprecated.html#_deprecated000025">Deprecated:</a></b></dt><dd>Use get_output_port_actuation() instead, which multiplies the generalized force by B⁻¹ to be consumed by MultibodyPlant's actuation input port. <br/>
1595
+
<p>(Deprecated.) </p><dlclass="deprecated"><dt><b><aclass="el" href="deprecated.html#_deprecated000026">Deprecated:</a></b></dt><dd>Use get_output_port_actuation() instead, which multiplies the generalized force by B⁻¹ to be consumed by MultibodyPlant's actuation input port. <br/>
1596
1596
This will be removed from Drake on or after 2025-04-01.</dd></dl>
0 commit comments