Skip to content
Snippets Groups Projects
Commit 22b74489 authored by Arafat Nourredine's avatar Arafat Nourredine
Browse files

Enhance documentation

parent dd358667
No related branches found
No related tags found
No related merge requests found
...@@ -79,7 +79,7 @@ Revision: - Author: anoureddine ...@@ -79,7 +79,7 @@ Revision: - Author: anoureddine
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ_WRITE</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr> <Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ_WRITE</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Font Size=-1> <Font Size=-1>
<Tr><Td><b>accuracy</b>: <Font Size=-1>Define the precision of position attribute value.<BR> Position is considered OK, when (reached position - requested position) < precision.<BR></Font></Td> <Tr><Td><b>accuracy</b>: <Font Size=-1>Define the precision of position attribute value.<BR> Position is considered OK, when (reached position - requested position) < precision.<BR> NB:<BR> Always use accuracy > stepSize. </Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ_WRITE</Font></Center></Td><Td><Center><Font Size=-1>Yes</Font></Center></Td></Tr> <Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ_WRITE</Font></Center></Td><Td><Center><Font Size=-1>Yes</Font></Center></Td></Tr>
</Table> </Table>
......
...@@ -45,13 +45,13 @@ Device Description <Br> <Br> ...@@ -45,13 +45,13 @@ Device Description <Br> <Br>
SimulatedMotor Class <Br> SimulatedMotor Class <Br>
</h1> </h1>
<b> <b>
Revision: - Author: syldup Revision: - Author: anoureddine
</b> </b>
</center> </center>
<Center> <Center>
Pure virtual Class for Axis family Simulating an Axis motor. Implemented with Tango C++ & YAT4Tango task
<Br> <Br>
<Br> <Br>
</Center> </Center>
......
...@@ -160,7 +160,7 @@ Each increment is equal to StepSize.<Br>&nbsp ...@@ -160,7 +160,7 @@ Each increment is equal to StepSize.<Br>&nbsp
<A NAME="MotorON"><!-- --></A> <A NAME="MotorON"><!-- --></A>
<h2>8 - MotorON</h2> <h2>8 - MotorON</h2>
<ul> <ul>
<Li><Strong>Description: </Strong> <Br>&nbsp <Li><Strong>Description: </Strong> Switch the power of the motor to On. State is switched to Standby.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_VOID</Strong> <Li><Strong>Argin:<Br>DEV_VOID</Strong>
: <Br>&nbsp : <Br>&nbsp
<Li><Strong>Argout:<Br>DEV_VOID</Strong> <Li><Strong>Argout:<Br>DEV_VOID</Strong>
...@@ -174,7 +174,7 @@ Each increment is equal to StepSize.<Br>&nbsp ...@@ -174,7 +174,7 @@ Each increment is equal to StepSize.<Br>&nbsp
<A NAME="MotorOFF"><!-- --></A> <A NAME="MotorOFF"><!-- --></A>
<h2>9 - MotorOFF</h2> <h2>9 - MotorOFF</h2>
<ul> <ul>
<Li><Strong>Description: </Strong> <Br>&nbsp <Li><Strong>Description: </Strong> Switch the power of the motor to Off. State is switched to Off.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_VOID</Strong> <Li><Strong>Argin:<Br>DEV_VOID</Strong>
: <Br>&nbsp : <Br>&nbsp
<Li><Strong>Argout:<Br>DEV_VOID</Strong> <Li><Strong>Argout:<Br>DEV_VOID</Strong>
......
...@@ -62,11 +62,35 @@ Revision: - Author: anoureddine ...@@ -62,11 +62,35 @@ Revision: - Author: anoureddine
<Tr><Td><b><a href=#Dev_DefaultValues>PositionConversionRatio </a></b></Td> <Tr><Td><b><a href=#Dev_DefaultValues>PositionConversionRatio </a></b></Td>
<Td><Font Size=-1>Tango::DEV_DOUBLE</Font></Td> <Td><Font Size=-1>Tango::DEV_DOUBLE</Font></Td>
<Td><Font Size=-1>Conversion factor between user units and hardware units.<br> <Td><Font Size=-1>Conversion factor between user units and hardware units.<br>
User unit = hardware position * PositionConversionRatio. [default : 1.0]</Font></Td></Tr> User unit = hardware position * PositionConversionRatio. <br>
[default : 1.0]<br>
NB:<br>
Not implemented. [has no effect on the device]</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>StepSize </a></b></Td> <Tr><Td><b><a href=#Dev_DefaultValues>StepSize </a></b></Td>
<Td><Font Size=-1>Tango::DEV_DOUBLE</Font></Td> <Td><Font Size=-1>Tango::DEV_DOUBLE</Font></Td>
<Td><Font Size=-1>Step size of the device. [default : 0.1]</Font></Td></Tr> <Td><Font Size=-1>Step size of the motor. <br>
[default = 0.01]</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>MemorizedAccuracy </a></b></Td>
<Td><Font Size=-1>Tango::DEV_DOUBLE</Font></Td>
<Td><Font Size=-1>Memorize the last accuracy attribute value.<br>
[default = 0.02]</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>MemorizedOffset </a></b></Td>
<Td><Font Size=-1>Tango::DEV_DOUBLE</Font></Td>
<Td><Font Size=-1>Memorize the last offset attribute value.<br>
[default = 0]</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>MemorizedPower </a></b></Td>
<Td><Font Size=-1>Tango::DEV_BOOLEAN</Font></Td>
<Td><Font Size=-1>Memorize tbhe last power off motor state attribute value.<br>
[default = false => Motor on by default]</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>MemorizedVelocity </a></b></Td>
<Td><Font Size=-1>Tango::DEV_DOUBLE</Font></Td>
<Td><Font Size=-1>Memorize the last velocity attribute value.<br>
[default = 1]</Font></Td></Tr>
</Table> </Table>
...@@ -89,6 +113,22 @@ User unit = hardware position * PositionConversionRatio. [default : 1.0]</Font>< ...@@ -89,6 +113,22 @@ User unit = hardware position * PositionConversionRatio. [default : 1.0]</Font><
<Td>StepSize</Td> <Td>StepSize</Td>
<td>0.01</td> <td>0.01</td>
</Tr> </Tr>
<Tr>
<Td>MemorizedAccuracy</Td>
<td>0.02</td>
</Tr>
<Tr>
<Td>MemorizedOffset</Td>
<td>0</td>
</Tr>
<Tr>
<Td>MemorizedPower</Td>
<td>false</td>
</Tr>
<Tr>
<Td>MemorizedVelocity</Td>
<td>1</td>
</Tr>
</Table> </Table>
<Br><Br><Br> <Br><Br><Br>
......
...@@ -54,7 +54,7 @@ Revision: - Author: anoureddine <Br> ...@@ -54,7 +54,7 @@ Revision: - Author: anoureddine <Br>
<Br> <Br>
<h2>Introduction:</h2> <h2>Introduction:</h2>
<ul> <ul>
Simulating a motor.<Br> Simulating an axis motor.<Br>
</ul> </ul>
<Br> <Br>
<h2>Class Inheritance:</h2> <h2>Class Inheritance:</h2>
......
No preview for this file type
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment