doc/doxygen/html/states_8h-source.html
author lbessard
Thu, 06 Dec 2007 17:55:46 +0100
changeset 323 4df7e6d2d1db
parent 240 34654679f262
permissions -rw-r--r--
Adding "ParameterValue" as optional parameter for "VAR" entries
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CanFestival: include/states.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
  <ul>
    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    <li id="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="dirs.html"><span>Directories</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
    <li><a href="globals.html"><span>Globals</span></a></li>
  </ul></div>
<div class="nav">
<a class="el" href="dir_bb27f6e70a4a8ab6966321815f15a33d.html">include</a></div>
<h1>states.h</h1><a href="states_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">This file is part of CanFestival, a library implementing CanOpen Stack. </span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">Copyright (C): Edouard TISSERANT and Francis DUPIN</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">See COPYING file for copyrights details.</span>
<a name="l00007"></a>00007 <span class="comment"></span>
<a name="l00008"></a>00008 <span class="comment">This library is free software; you can redistribute it and/or</span>
<a name="l00009"></a>00009 <span class="comment">modify it under the terms of the GNU Lesser General Public</span>
<a name="l00010"></a>00010 <span class="comment">License as published by the Free Software Foundation; either</span>
<a name="l00011"></a>00011 <span class="comment">version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00012"></a>00012 <span class="comment"></span>
<a name="l00013"></a>00013 <span class="comment">This library is distributed in the hope that it will be useful,</span>
<a name="l00014"></a>00014 <span class="comment">but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00015"></a>00015 <span class="comment">MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00016"></a>00016 <span class="comment">Lesser General Public License for more details.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment">You should have received a copy of the GNU Lesser General Public</span>
<a name="l00019"></a>00019 <span class="comment">License along with this library; if not, write to the Free Software</span>
<a name="l00020"></a>00020 <span class="comment">Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA</span>
<a name="l00021"></a>00021 <span class="comment">*/</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef __states_h__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define __states_h__</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;<a class="code" href="win32_2applicfg_8h.html">applicfg.h</a>&gt;</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="comment">/* The nodes states </span>
<a name="l00029"></a>00029 <span class="comment"> * -----------------</span>
<a name="l00030"></a>00030 <span class="comment"> * values are choosen so, that they can be sent directly</span>
<a name="l00031"></a>00031 <span class="comment"> * for heartbeat messages...</span>
<a name="l00032"></a>00032 <span class="comment"> * Must be coded on 7 bits only</span>
<a name="l00033"></a>00033 <span class="comment"> * */</span>
<a name="l00034"></a>00034 <span class="comment">/* Should not be modified */</span>
<a name="l00035"></a><a class="code" href="states_8h.html#80401a8f6d29787e07427b2baf630538">00035</a> <span class="keyword">enum</span> <a class="code" href="states_8h.html#80401a8f6d29787e07427b2baf630538">enum_nodeState</a> {
<a name="l00036"></a>00036   <a class="code" href="states_8h.html#80401a8f6d29787e07427b2baf630538de69e6bdd47a9d7dae023237acdaad5e">Initialisation</a>  = 0x00, 
<a name="l00037"></a>00037   <a class="code" href="states_8h.html#80401a8f6d29787e07427b2baf63053813dd3ce528104ecfb76f40ca3106186a">Disconnected</a>    = 0x01,
<a name="l00038"></a>00038   <a class="code" href="states_8h.html#80401a8f6d29787e07427b2baf6305387327f29693eff1568e953bc08d57bf3f">Connecting</a>      = 0x02,
<a name="l00039"></a>00039   <a class="code" href="states_8h.html#80401a8f6d29787e07427b2baf630538b2016b309d180eb20095d95eb33058d8">Preparing</a>       = 0x02,
<a name="l00040"></a>00040   <a class="code" href="states_8h.html#80401a8f6d29787e07427b2baf63053853c74ac440bbf6af2cb67759d3cd8f0a">Stopped</a>         = 0x04,
<a name="l00041"></a>00041   <a class="code" href="states_8h.html#80401a8f6d29787e07427b2baf63053824952153680b2c826995af50d0b16aea">Operational</a>     = 0x05,
<a name="l00042"></a>00042   <a class="code" href="states_8h.html#80401a8f6d29787e07427b2baf630538aa3d4da3fd99f3a79599fa514561754a">Pre_operational</a> = 0x7F,
<a name="l00043"></a>00043   <a class="code" href="states_8h.html#80401a8f6d29787e07427b2baf630538c10f9d2ed7c3268d46023240e3bef9b9">Unknown_state</a>   = 0x0F
<a name="l00044"></a>00044 };
<a name="l00045"></a>00045 
<a name="l00046"></a><a class="code" href="states_8h.html#424131de4b91e21fa281d2c8913d9282">00046</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="states_8h.html#80401a8f6d29787e07427b2baf630538">enum_nodeState</a> <a class="code" href="states_8h.html#424131de4b91e21fa281d2c8913d9282">e_nodeState</a>;
<a name="l00047"></a>00047 
<a name="l00048"></a><a class="code" href="structs__state__communication.html">00048</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>
<a name="l00049"></a>00049 <span class="keyword"></span>{
<a name="l00050"></a><a class="code" href="structs__state__communication.html#71376b0908de48603291370c0247ffac">00050</a>         <a class="code" href="hcs12_2applicfg_8h.html#c2e754635928189b98cf3f5b7e6dbffb">UNS8</a> csBoot_Up;
<a name="l00051"></a><a class="code" href="structs__state__communication.html#0365a4727f31f78619a0ff2fe04587e9">00051</a>         <a class="code" href="hcs12_2applicfg_8h.html#c2e754635928189b98cf3f5b7e6dbffb">UNS8</a> csSDO;
<a name="l00052"></a><a class="code" href="structs__state__communication.html#389be6bcb4dbe137457ed2e4422b2a61">00052</a>         <a class="code" href="hcs12_2applicfg_8h.html#c2e754635928189b98cf3f5b7e6dbffb">UNS8</a> csEmergency;
<a name="l00053"></a><a class="code" href="structs__state__communication.html#d935553977a2182812610adf6be081db">00053</a>         <a class="code" href="hcs12_2applicfg_8h.html#c2e754635928189b98cf3f5b7e6dbffb">UNS8</a> csSYNC;
<a name="l00054"></a><a class="code" href="structs__state__communication.html#97fc63b0f645aef222ebb4c355e63c45">00054</a>         <a class="code" href="hcs12_2applicfg_8h.html#c2e754635928189b98cf3f5b7e6dbffb">UNS8</a> csHeartbeat;
<a name="l00055"></a><a class="code" href="structs__state__communication.html#9e525c64ecaa9ffd9f2f9e6dea031fed">00055</a>         <a class="code" href="hcs12_2applicfg_8h.html#c2e754635928189b98cf3f5b7e6dbffb">UNS8</a> csPDO;
<a name="l00056"></a>00056 } <a class="code" href="structs__state__communication.html">s_state_communication</a>;
<a name="l00057"></a>00057 
<a name="l00061"></a><a class="code" href="states_8h.html#efba19e5dc10d03a17287af29c71567f">00061</a> <span class="keyword">typedef</span> void (*<a class="code" href="states_8h.html#efba19e5dc10d03a17287af29c71567f">initialisation_t</a>)(void);
<a name="l00062"></a><a class="code" href="states_8h.html#779b4753c62da1e5441c3787a823938a">00062</a> <span class="keyword">typedef</span> void (*<a class="code" href="states_8h.html#779b4753c62da1e5441c3787a823938a">preOperational_t</a>)(void);
<a name="l00063"></a><a class="code" href="states_8h.html#c7a996649d7ce811f510e86586b863fd">00063</a> <span class="keyword">typedef</span> void (*<a class="code" href="states_8h.html#c7a996649d7ce811f510e86586b863fd">operational_t</a>)(void);
<a name="l00064"></a><a class="code" href="states_8h.html#b557e6fbf097b1c7fd5c22f867069aa1">00064</a> <span class="keyword">typedef</span> void (*<a class="code" href="states_8h.html#b557e6fbf097b1c7fd5c22f867069aa1">stopped_t</a>)(void);
<a name="l00065"></a>00065 
<a name="l00066"></a>00066 <span class="keywordtype">void</span> <a class="code" href="states_8c.html#bbf7c4f549d7ffacaab5f35602e97bd6">_initialisation</a>(<span class="keywordtype">void</span>);
<a name="l00067"></a>00067 <span class="keywordtype">void</span> <a class="code" href="states_8c.html#2264bc985c7eacf7d48d16b2b9109e39">_preOperational</a>(<span class="keywordtype">void</span>);
<a name="l00068"></a>00068 <span class="keywordtype">void</span> <a class="code" href="states_8c.html#6bc47cbd7a2bdf37d998a8e4743d4260">_operational</a>(<span class="keywordtype">void</span>);
<a name="l00069"></a>00069 <span class="keywordtype">void</span> <a class="code" href="states_8c.html#fe6f57bd1c97e8a3d23c288e5920c245">_stopped</a>(<span class="keywordtype">void</span>);
<a name="l00070"></a>00070 
<a name="l00071"></a>00071 <span class="preprocessor">#include "<a class="code" href="data_8h.html">data.h</a>"</span>
<a name="l00072"></a>00072 
<a name="l00073"></a>00073 <span class="comment">/************************* prototypes ******************************/</span>
<a name="l00074"></a>00074 
<a name="l00077"></a>00077 <span class="keywordtype">void</span> <a class="code" href="states_8c.html#5903338b79e219eeb27f61974419fc12">canDispatch</a>(<a class="code" href="structstruct__CO__Data.html">CO_Data</a>* d, <a class="code" href="structMessage.html">Message</a> *m);
<a name="l00078"></a>00078 
<a name="l00081"></a>00081 <a class="code" href="states_8h.html#424131de4b91e21fa281d2c8913d9282">e_nodeState</a> <a class="code" href="states_8c.html#9e583d34635164324fbd55e310d8e99b">getState</a> (<a class="code" href="structstruct__CO__Data.html">CO_Data</a>* d);
<a name="l00082"></a>00082 
<a name="l00085"></a>00085 <a class="code" href="hcs12_2applicfg_8h.html#c2e754635928189b98cf3f5b7e6dbffb">UNS8</a> <a class="code" href="states_8c.html#cfb53d66c2360cd55b1d968f0e5c270f">setState</a> (<a class="code" href="structstruct__CO__Data.html">CO_Data</a>* d, <a class="code" href="states_8h.html#424131de4b91e21fa281d2c8913d9282">e_nodeState</a> newState);
<a name="l00086"></a>00086 
<a name="l00089"></a>00089 <a class="code" href="hcs12_2applicfg_8h.html#c2e754635928189b98cf3f5b7e6dbffb">UNS8</a> <a class="code" href="states_8c.html#458a686646e4500b1f9e6cf67898250e">getNodeId</a> (<a class="code" href="structstruct__CO__Data.html">CO_Data</a>* d);
<a name="l00090"></a>00090 
<a name="l00093"></a>00093 <span class="keywordtype">void</span> <a class="code" href="states_8c.html#191c0cad67e093ea44285c9acd187513">setNodeId</a> (<a class="code" href="structstruct__CO__Data.html">CO_Data</a>* d, <a class="code" href="hcs12_2applicfg_8h.html#c2e754635928189b98cf3f5b7e6dbffb">UNS8</a> nodeId);
<a name="l00094"></a>00094 
<a name="l00098"></a>00098 <span class="comment">/* void initResetMode (CO_Data* d); */</span>
<a name="l00099"></a>00099 
<a name="l00100"></a>00100 
<a name="l00104"></a>00104 <span class="keywordtype">void</span> <a class="code" href="states_8h.html#18541dfe4c0a04c60fae4f836bb8d97b">initPreOperationalMode</a> (<a class="code" href="structstruct__CO__Data.html">CO_Data</a>* d);
<a name="l00105"></a>00105 
<a name="l00106"></a>00106 <span class="preprocessor">#endif</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Jul 2 19:10:16 2007 for CanFestival by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>