1+ <!DOCTYPE html>
2+ < html lang ="en ">
3+ < head >
4+ < meta charset ="utf-8 ">
5+ < title > JSDoc: Class: GuardCondition</ title >
6+
7+ < script src ="scripts/prettify/prettify.js "> </ script >
8+ < script src ="scripts/prettify/lang-css.js "> </ script >
9+ <!--[if lt IE 9]>
10+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11+ <![endif]-->
12+ < link type ="text/css " rel ="stylesheet " href ="styles/prettify-tomorrow.css ">
13+ < link type ="text/css " rel ="stylesheet " href ="styles/jsdoc-default.css ">
14+ </ head >
15+
16+ < body >
17+
18+ < div id ="main ">
19+
20+ < h1 class ="page-title "> Class: GuardCondition</ h1 >
21+
22+
23+
24+
25+
26+
27+ < section >
28+
29+ < header >
30+
31+ < h2 > < span class ="attribs "> < span class ="type-signature "> </ span > </ span > GuardCondition< span class ="signature "> ()</ span > < span class ="type-signature "> </ span > </ h2 >
32+
33+ < div class ="class-description "> - Class representing a guard condition in ROS</ div >
34+
35+
36+ </ header >
37+
38+ < article >
39+ < div class ="container-overview ">
40+
41+
42+
43+
44+
45+
46+
47+
48+
49+
50+
51+
52+
53+
54+
55+
56+
57+ < dl class ="details ">
58+
59+
60+
61+
62+
63+
64+
65+
66+
67+
68+
69+
70+
71+
72+
73+
74+
75+
76+
77+
78+
79+
80+
81+
82+
83+
84+ < dt class ="tag-source "> Source:</ dt >
85+ < dd class ="tag-source "> < ul class ="dummy "> < li >
86+ < a href ="lib_guard_condition.js.html "> lib/guard_condition.js</ a > , < a href ="lib_guard_condition.js.html#line24 "> line 24</ a >
87+ </ li > </ ul > </ dd >
88+
89+
90+
91+
92+
93+
94+
95+ </ dl >
96+
97+
98+
99+
100+
101+
102+
103+
104+
105+
106+
107+
108+
109+
110+
111+
112+
113+
114+
115+ </ div >
116+
117+
118+
119+
120+
121+
122+
123+
124+
125+
126+
127+
128+
129+
130+ < h3 class ="subsection-title "> Methods</ h3 >
131+
132+
133+
134+
135+
136+
137+
138+ < h4 class ="name " id ="trigger "> < span class ="type-signature "> </ span > trigger< span class ="signature "> ()</ span > < span class ="type-signature "> → {undefined}</ span > </ h4 >
139+
140+
141+
142+
143+
144+
145+ < div class ="description ">
146+ Triggers the guard condition.
147+ </ div >
148+
149+
150+
151+
152+
153+
154+
155+
156+
157+
158+
159+
160+
161+ < dl class ="details ">
162+
163+
164+
165+
166+
167+
168+
169+
170+
171+
172+
173+
174+
175+
176+
177+
178+
179+
180+
181+
182+
183+
184+
185+
186+
187+
188+ < dt class ="tag-source "> Source:</ dt >
189+ < dd class ="tag-source "> < ul class ="dummy "> < li >
190+ < a href ="lib_guard_condition.js.html "> lib/guard_condition.js</ a > , < a href ="lib_guard_condition.js.html#line44 "> line 44</ a >
191+ </ li > </ ul > </ dd >
192+
193+
194+
195+
196+
197+
198+
199+ </ dl >
200+
201+
202+
203+
204+
205+
206+
207+
208+
209+
210+
211+
212+
213+ < h5 > Returns:</ h5 >
214+
215+
216+
217+
218+ < dl >
219+ < dt >
220+ Type
221+ </ dt >
222+ < dd >
223+
224+ < span class ="param-type "> undefined</ span >
225+
226+
227+ </ dd >
228+ </ dl >
229+
230+
231+
232+
233+
234+
235+
236+
237+
238+
239+
240+
241+
242+ </ article >
243+
244+ </ section >
245+
246+
247+
248+
249+ </ div >
250+
251+ < nav >
252+ < h2 > < a href ="index.html "> Home</ a > </ h2 > < h3 > Modules</ h3 > < ul > < li > < a href ="module-rclnodejs.html "> rclnodejs</ a > </ li > < li > < a href ="module-validator.html "> validator</ a > </ li > </ ul > < h3 > Classes</ h3 > < ul > < li > < a href ="ActionClient.html "> ActionClient</ a > </ li > < li > < a href ="ActionServer.html "> ActionServer</ a > </ li > < li > < a href ="CallbackReturnValue.html "> CallbackReturnValue</ a > </ li > < li > < a href ="Client.html "> Client</ a > </ li > < li > < a href ="ClientGoalHandle.html "> ClientGoalHandle</ a > </ li > < li > < a href ="Clock.html "> Clock</ a > </ li > < li > < a href ="Context.html "> Context</ a > </ li > < li > < a href ="Duration.html "> Duration</ a > </ li > < li > < a href ="FloatingPointRange.html "> FloatingPointRange</ a > </ li > < li > < a href ="GuardCondition.html "> GuardCondition</ a > </ li > < li > < a href ="IntegerRange.html "> IntegerRange</ a > </ li > < li > < a href ="LifecycleNode.html "> LifecycleNode</ a > </ li > < li > < a href ="LifecyclePublisher.html "> LifecyclePublisher</ a > </ li > < li > < a href ="Logging.html "> Logging</ a > </ li > < li > < a href ="Node.html "> Node</ a > </ li > < li > < a href ="NodeOptions.html "> NodeOptions</ a > </ li > < li > < a href ="Parameter.html "> Parameter</ a > </ li > < li > < a href ="ParameterDescriptor.html "> ParameterDescriptor</ a > </ li > < li > < a href ="ParameterService.html "> ParameterService</ a > </ li > < li > < a href ="Publisher.html "> Publisher</ a > </ li > < li > < a href ="QoS.html "> QoS</ a > </ li > < li > < a href ="ROSClock.html "> ROSClock</ a > </ li > < li > < a href ="Range.html "> Range</ a > </ li > < li > < a href ="Rate.html "> Rate</ a > </ li > < li > < a href ="RateTimerServer.html "> RateTimerServer</ a > </ li > < li > < a href ="Response.html "> Response</ a > </ li > < li > < a href ="ServerGoalHandle.html "> ServerGoalHandle</ a > </ li > < li > < a href ="Service.html "> Service</ a > </ li > < li > < a href ="State.html "> State</ a > </ li > < li > < a href ="Subscription.html "> Subscription</ a > </ li > < li > < a href ="Time.html "> Time</ a > </ li > < li > < a href ="TimeSource.html "> TimeSource</ a > </ li > < li > < a href ="Timer.html "> Timer</ a > </ li > < li > < a href ="Transition.html "> Transition</ a > </ li > < li > < a href ="TransitionDescription.html "> TransitionDescription</ a > </ li > </ ul > < h3 > Global</ h3 > < ul > < li > < a href ="global.html#CallbackReturnCode "> CallbackReturnCode</ a > </ li > < li > < a href ="global.html#CancelResponse "> CancelResponse</ a > </ li > < li > < a href ="global.html#ClockType "> ClockType</ a > </ li > < li > < a href ="global.html#DEFAULT_NUMERIC_RANGE_TOLERANCE "> DEFAULT_NUMERIC_RANGE_TOLERANCE</ a > </ li > < li > < a href ="global.html#DistroId "> DistroId</ a > </ li > < li > < a href ="global.html#DurabilityPolicy "> DurabilityPolicy</ a > </ li > < li > < a href ="global.html#GoalResponse "> GoalResponse</ a > </ li > < li > < a href ="global.html#HistoryPolicy "> HistoryPolicy</ a > </ li > < li > < a href ="global.html#LoggingSeverity "> LoggingSeverity</ a > </ li > < li > < a href ="global.html#ParameterType "> ParameterType</ a > </ li > < li > < a href ="global.html#ReliabilityPolicy "> ReliabilityPolicy</ a > </ li > < li > < a href ="global.html#ServiceIntrospectionStates "> ServiceIntrospectionStates</ a > </ li > < li > < a href ="global.html#defaultCancelCallback "> defaultCancelCallback</ a > </ li > < li > < a href ="global.html#defaultGoalCallback "> defaultGoalCallback</ a > </ li > < li > < a href ="global.html#defaultHandleAcceptedCallback "> defaultHandleAcceptedCallback</ a > </ li > < li > < a href ="global.html#getActionClientNamesAndTypesByNode "> getActionClientNamesAndTypesByNode</ a > </ li > < li > < a href ="global.html#getActionNamesAndTypes "> getActionNamesAndTypes</ a > </ li > < li > < a href ="global.html#getActionServerNamesAndTypesByNode "> getActionServerNamesAndTypesByNode</ a > </ li > < li > < a href ="global.html#getCurrentGeneratorVersion "> getCurrentGeneratorVersion</ a > </ li > < li > < a href ="global.html#parameterTypeFromValue "> parameterTypeFromValue</ a > </ li > < li > < a href ="global.html#validType "> validType</ a > </ li > < li > < a href ="global.html#validValue "> validValue</ a > </ li > </ ul >
253+ </ nav >
254+
255+ < br class ="clear ">
256+
257+ < footer >
258+ Documentation generated by < a href ="https://github.com/jsdoc3/jsdoc "> JSDoc 4.0.4</ a > on Tue Feb 18 2025 18:02:07 GMT+0800 (China Standard Time)
259+ </ footer >
260+
261+ < script > prettyPrint ( ) ; </ script >
262+ < script src ="scripts/linenumber.js "> </ script >
263+ </ body >
264+ </ html >
0 commit comments