Open Core Interface - MLPI
MLPI-MotionLogicProgrammingInterface(mlpi4COM)  1.26.2
IWatchdog.idl
Go to the documentation of this file.
1 // -----------------------------------------------------------------------
2 // MLPI - <IWatchdog.idl>
3 // -----------------------------------------------------------------------
4 // Copyright (c) 2012 Bosch Rexroth. All rights reserved.
5 // Redistribution and use in source and binary forms of this MLPI software
6 // (SW) provided to you, with or without modification, are permitted
7 // without prior approval provided that the following conditions are met:
8 //
9 // 1. Redistributions of source code of SW must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // 2. Redistributions in binary form of SW must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // 3. User recognizes and acknowledges that it acquires no right,
17 // title or interest in or to any of the names or trademarks used in
18 // connection with the SW ("names") by virtue of this License and waives
19 // any right to or interest in the names. User recognizes and acknowledges
20 // that names of companies or names or products of companies displayed
21 // in the documentation of SW to indicate the interoperability of products
22 // with the SW are the names of their respective owners. The use of such
23 // names in the documentation of SW does not imply any sponsorship,
24 // approval, or endorsement by such companies of this product.
25 //
26 // 4. Modified code versions, i.e. any addition to or deletion from
27 // the substance or structure of the original code of the SW running
28 // the MLPI must be plainly marked as such and must not be misrepresented
29 // as being original SW.
30 //
31 // 5. The SW may only be used in connection with a Bosch Rexroth product.
32 //
33 // THIS INFORMATION IS PROVIDED BY BOSCH REXROTH CORPORATION "AS IS"
34 // AND WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING
35 // (BUT NOTLIMITED TO) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
36 // FITNESS FOR ANY PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WHILE THE
37 // INFORMATION PROVIDED IS BELIEVED TO BE ACCURATE, IT MAY INCLUDE
38 // ERRORS OR INACCURACIES.
39 // SUBJECT TO COMPULSORY STATUTORY PROVISIONS OF THE GERMAN LAW AS
40 // THE APPLICABLE LAW FOR THIS LICENSE BOSCH REXROTH CORPORATION WILL
41 // NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING FROM THE USE OF
42 // THE SOFTWARE DISTRIBUTED HEREUNDER, INCLUDING BUT NOT LIMITED TO
43 // DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, AND CONSEQUENTIAL DAMAGES.
44 // -----------------------------------------------------------------------
45 //
55 //
56 // -----------------------------------------------------------------------
57 
58 
59 
60 
118 [
119  object,
120  uuid(AEB52EB3-8C66-4866-9456-C2174B4AE25B),
121  dual,
122  nonextensible,
123  helpstring("IWatchdog Interface"),
124  pointer_default(unique)
125 ]
126 interface IWatchdog : IDispatch{
127 
130  typedef [v1_enum] enum WatchdogAction
131  {
134  WATCHDOG_ERROR = 0x02,
137 
140  typedef [v1_enum] enum WatchdogState
141  {
145  }WatchdogState;
146 
170  [id(1), helpstring("Method Setup")] HRESULT Setup([in]LONG timeout, [in]WatchdogAction action);
171 
192  [id(2), helpstring("Method Start")] HRESULT Start(void);
193 
214  [id(3), helpstring("Method Stop")] HRESULT Stop(void);
215 
237  [id(4), helpstring("Method Reset")] HRESULT Reset(void);
238 
261  [id(5), helpstring("Method GetState")] HRESULT GetState([out, retval]WatchdogState *state);
262 };
263 
264 
265 // -----------------------------------------------------------------------
266 // HISTORY
267 // -----------------------------------------------------------------------
268 // 01-Jan-2012
269 // - first release
270 //
271 
272 
273 
WatchdogState
This enumeration describes the state of a watchdog.
Definition: IWatchdog.idl:140
WatchdogAction
This enumeration must be used to define the action when a watchdog has expired.
Definition: IWatchdog.idl:130
HRESULT GetState([out, retval]WatchdogState *state)
This function will return the current state of the watchdog. The state will read that the watchdog is...
Control will be rebooted.
Definition: IWatchdog.idl:132
Watchdog has not started.
Definition: IWatchdog.idl:142
HRESULT Reset(void)
This function resets the watchdog. It has to be called in an interval which is shorter than the timeo...
Watchdog has started.
Definition: IWatchdog.idl:143
Definition of the IWatchdog interface.
Definition: IWatchdog.idl:126
HRESULT Setup([in]LONG timeout, [in]WatchdogAction action)
This function initializes or changes the watchdog functionality.
Watchdog has expired and has been disabled.
Definition: IWatchdog.idl:144
HRESULT Stop(void)
This function stops the watchdog supervision.
HRESULT Start(void)
This function starts the watchdog supervision.
PLC will be stopped.
Definition: IWatchdog.idl:133
Error with class F5 severity (all axes go to error stop) will be generated.
Definition: IWatchdog.idl:134
Error with class F0 severity (warning, no action) will be generated.
Definition: IWatchdog.idl:135