Skip to content
Snippets Groups Projects
Commit 577a0f8e authored by Xavier ELATTAOUI's avatar Xavier ELATTAOUI
Browse files

Now can handle several devices with one Prologix controller

parent 09110dc9
No related branches found
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
Showing
with 1617 additions and 453 deletions
doc/doc_html/Attributes.html
+ 11
− 97
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<Title> Tango Device Server User's Guide </Title>
</HEAD>
<BODY TEXT="#000000" BGCOLOR="#FFFFFF" LINK="#0000FF" VLINK="#7F00FF" ALINK="#FF0000">
<P><!-------TITLE------></P>
<TABLE BORDER="0" WIDTH="100%">
<TR>
<TD ALIGN="left">
<A HREF="http://www.esrf.fr/" TARGET=new>
<IMG SRC="http://www.esrf.fr/gifs/logo/80.gif" BORDER=0 Height="60"></A>
</Td>
<TD ALIGN="center">
<A HREF="http://www.elettra.trieste.it/" TARGET=new>
<IMG SRC="http://www.esrf.fr/computing/cs/tango/elettra_logo.gif" BORDER=0 Height="60"></A>
</Td>
<TD ALIGN="center">
<A HREF="http://www.synchrotron-soleil.fr/" TARGET=new>
<IMG SRC="http://www.esrf.fr/computing/cs/tango/soleil_logo.gif" BORDER=0 Height="60"></A>
</Td>
<TD ALIGN="right">
<A HREF="http://www.cells.es/" TARGET=new>
<IMG SRC="http://www.esrf.fr/computing/cs/tango/alba.jpg" BORDER=0 Height="54"></A>
</Td>
<TD ALIGN="right">
<A HREF="http://www.desy.de/html/home/index_eng.html" TARGET=new>
<IMG SRC="http://www.esrf.fr/computing/cs/tango/desy.gif" BORDER=0 Height="60"></A>
</Td>
<Td>
<H2><FONT COLOR="#7F00FF">
<Center><A HREF="http://www.tango-controls.org/" TARGET="_top">
TANGO </a> <Br> Device Server
</Center></FONT>
</Td>
</TR>
</TABLE>
<HR WIDTH="100%"></H5>
<Br>
<center>
<h1>
GpibPrologix <Br>
Device Attributes Description <Br> <Br>
GpibPrologix Class <Br>
</h1>
<b>
Revision: - Author: olivierroux
</b>
</center>
<Br>
<!--- html Footer --->
<Center>
<Font size=-1>
<br>
<br>
<TABLE BORDER="1" WIDTH="100%">
<Tr>
<!--- Hosted by Sourceforge --->
<Td Align="Center">
<Font size=-1>
<b>TANGO</b> is an open source project hosted by :<br>
<A href="http://sourceforge.net" Target="new">
<IMG title="Sourceforge logo"
alt="Sourceforge logo small"
src="http://www.esrf.fr/computing/cs/tango/sourceforge.gif"
border=0> </a>
</Font>
</Td>
<!--- 2 Sourceforge Repositories --->
<Td Align="Center">
<Font size=-1>
Core and Tools :
<a href="http://tango-cs.cvs.sourceforge.net/tango-cs/" Target="new">
CVS repository</a> on
<a href="https://sourceforge.net/projects/tango-cs" Target=new>
tango-cs project</a>
<br>
Device Servers :
<a href="http://tango-ds.cvs.sourceforge.net/tango-ds/" Target="new">
CVS repository</a> on
<a href="https://sourceforge.net/projects/tango-ds" Target=new>
tango-ds project</a>
</Font>
</Td>
</Tr>
</Table>
</Font>
</Center>
<html>
<head>
<title> GpibPrologix Tango Class Attributes </title>
</head>
<body text="Black" bgcolor="White" link="Blue" vlink="Purple" alink="Red">
<br><br><br><br>
<font size="+1"><u><b> There is no attribute defined. </b></u></font>
<br><br>
<hr>
<br><br>
<font size="+1"><u><b> There is no dynamic attribute defined. </b></u></font>
</body>
</html>
doc/doc_html/ClassDescription.html 0 → 100644
+ 83
− 0
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title> GpibPrologix Tango Class Description </title>
</head>
<body text="Black" bgcolor="White" link="Blue" vlink="Purple" alink="Red">
<ul>
<br><br><br>
<table border="0" width="100%">
<Tr>
<td> <font size="+1"><u><b> GpibPrologix Class Identification : </b></u></font> </td>
<td> <font size="+1"><u><b> GpibPrologix Class Inheritance : </b></u></font> </td>
</tr>
<td><ul>
<table border="0">
<Tr>
<td> Contact </td><td> : at synchrotron-soleil.fr - coquet</td>
</tr>
<tr>
<td> Class Family </td><td> : Communication
</tr>
<tr>
<td> Platform </td><td> : All Platforms </td>
</tr>
<tr>
<td> Bus </td><td> : GPIB </td>
</tr>
<tr>
<td> Manufacturer </td><td> : none </td>
</tr>
<tr>
<td> Manufacturer ref.</td><td> : </td>
</tr>
</Table>
</ul></td>
<td>
<ul><li> <a href="http://www.esrf.fr/computing/cs/tango/tango_doc/kernel_doc/cpp_doc/" target="new"> Tango::DeviceImpl</a></li>
<ul> <li> GpibPrologix</li>
<br>
<br>
<br>
<br>
<br>
</td>
</Table>
<br><br><br>
<font size="+1"><u><b> GpibPrologix Class Description : </b></u></font>
<br><br>
<ul>
communication interface to gpib instruments through Prologix gpib-ethernet controller<Br>
Only 1 instrument can be connected to GpibPrologix device
<Br>
<center>
<h1>
GpibPrologix <Br>
Device Description <Br> <Br>
GpibPrologix Class <Br>
</h1>
<b>
Revision: - Author:
</b>
</center>
<Center>
communication interface to gpib instruments through Prologix gpib-ethernet controller
Only 1 instrument can be connected to GpibPrologix device
<Br>
<Br>
</Center>
<!--- /*PROTECTED REGION ID(index.html) ENABLED START*/ --->
<!--- Add your own documentation, pictures, links,.... --->
<!--- /*PROTECTED REGION END*/ --->
</ul>
</ul>
</body>
</html>
doc/doc_html/CmdClear.html 0 → 100644
+ 54
− 0
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title> GpibPrologix Tango Class Command Clear </title>
</head>
<body text="Black" bgcolor="White" link="Blue" vlink="Purple" alink="Red">
<br><br><br>
<font size="+1"><u><b> Command Clear : </b></u></font>
<ul>
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> Clear Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_VOID </td>
<td> no argin </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_VOID </td>
<td> no argout </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> OPERATOR </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command allowed for </td>
<td> All states </td>
<td> .. </td>
</tr>
</table>
</body>
</html>
doc/doc_html/CmdIsSRQLineUP.html 0 → 100644
+ 55
− 0
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title> GpibPrologix Tango Class Command IsSRQLineUP </title>
</head>
<body text="Black" bgcolor="White" link="Blue" vlink="Purple" alink="Red">
<br><br><br>
<font size="+1"><u><b> Command IsSRQLineUP : </b></u></font>
<ul>
returns true if SRQ line is UP, false otherwise
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> IsSRQLineUP Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_VOID </td>
<td> </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_BOOLEAN </td>
<td> </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> OPERATOR </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command allowed for </td>
<td> All states </td>
<td> .. </td>
</tr>
</table>
</body>
</html>
doc/doc_html/CmdRead.html 0 → 100644
+ 54
− 0
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title> GpibPrologix Tango Class Command Read </title>
</head>
<body text="Black" bgcolor="White" link="Blue" vlink="Purple" alink="Red">
<br><br><br>
<font size="+1"><u><b> Command Read : </b></u></font>
<ul>
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> Read Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_VOID </td>
<td> </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_STRING </td>
<td> Returned string. </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> OPERATOR </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command allowed for </td>
<td> All states </td>
<td> .. </td>
</tr>
</table>
</body>
</html>
doc/doc_html/CmdReadLongString.html 0 → 100644
+ 54
− 0
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title> GpibPrologix Tango Class Command ReadLongString </title>
</head>
<body text="Black" bgcolor="White" link="Blue" vlink="Purple" alink="Red">
<br><br><br>
<font size="+1"><u><b> Command ReadLongString : </b></u></font>
<ul>
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> ReadLongString Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_LONG </td>
<td> Max expected string length. </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_STRING </td>
<td> The readed string. </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> EXPERT </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command NOT allowed for </td>
<td> <font size="-1"> <li> MOVING </li> <li> FAULT </li> </font> </td>
<td> .. </td>
</tr>
</table>
</body>
</html>
doc/doc_html/CmdSetTimeOut.html 0 → 100644
+ 54
− 0
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title> GpibPrologix Tango Class Command SetTimeOut </title>
</head>
<body text="Black" bgcolor="White" link="Blue" vlink="Purple" alink="Red">
<br><br><br>
<font size="+1"><u><b> Command SetTimeOut : </b></u></font>
<ul>
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> SetTimeOut Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_SHORT </td>
<td> accepted value are [0-15] </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_VOID </td>
<td> no argout </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> EXPERT </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command NOT allowed for </td>
<td> <font size="-1"> <li> MOVING </li> <li> FAULT </li> </font> </td>
<td> .. </td>
</tr>
</table>
</body>
</html>
doc/doc_html/CmdState.html 0 → 100644
+ 55
− 0
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title> GpibPrologix Tango Class Command State </title>
</head>
<body text="Black" bgcolor="White" link="Blue" vlink="Purple" alink="Red">
<br><br><br>
<font size="+1"><u><b> Command State : </b></u></font>
<ul>
This command gets the device state (stored in its <i>device_state</i> data member) and returns it to the caller.
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> State Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_VOID </td>
<td> none. </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_STATE </td>
<td> State Code </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> OPERATOR </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> true </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command allowed for </td>
<td> All states </td>
<td> .. </td>
</tr>
</table>
</body>
</html>
doc/doc_html/CmdStatus.html 0 → 100644
+ 55
− 0
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title> GpibPrologix Tango Class Command Status </title>
</head>
<body text="Black" bgcolor="White" link="Blue" vlink="Purple" alink="Red">
<br><br><br>
<font size="+1"><u><b> Command Status : </b></u></font>
<ul>
This command gets the device status (stored in its <i>device_status</i> data member) and returns it to the caller.
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> Status Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_VOID </td>
<td> none. </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::CONST_DEV_STRING </td>
<td> Status description </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> OPERATOR </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> true </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command allowed for </td>
<td> All states </td>
<td> .. </td>
</tr>
</table>
</body>
</html>
doc/doc_html/CmdTrigger.html 0 → 100644
+ 54
− 0
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title> GpibPrologix Tango Class Command Trigger </title>
</head>
<body text="Black" bgcolor="White" link="Blue" vlink="Purple" alink="Red">
<br><br><br>
<font size="+1"><u><b> Command Trigger : </b></u></font>
<ul>
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> Trigger Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_VOID </td>
<td> no argin </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_VOID </td>
<td> no argout </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> EXPERT </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command NOT allowed for </td>
<td> <font size="-1"> <li> MOVING </li> <li> FAULT </li> </font> </td>
<td> .. </td>
</tr>
</table>
</body>
</html>
doc/doc_html/CmdWrite.html 0 → 100644
+ 54
− 0
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title> GpibPrologix Tango Class Command Write </title>
</head>
<body text="Black" bgcolor="White" link="Blue" vlink="Purple" alink="Red">
<br><br><br>
<font size="+1"><u><b> Command Write : </b></u></font>
<ul>
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> Write Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_STRING </td>
<td> String to send to the device </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_VOID </td>
<td> </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> OPERATOR </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command NOT allowed for </td>
<td> <font size="-1"> <li> MOVING </li> </font> </td>
<td> .. </td>
</tr>
</table>
</body>
</html>
doc/doc_html/CmdWriteRead.html 0 → 100644
+ 54
− 0
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title> GpibPrologix Tango Class Command WriteRead </title>
</head>
<body text="Black" bgcolor="White" link="Blue" vlink="Purple" alink="Red">
<br><br><br>
<font size="+1"><u><b> Command WriteRead : </b></u></font>
<ul>
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> WriteRead Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_STRING </td>
<td> String to send to the gpib device. </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_STRING </td>
<td> String returned by the gpib Device. </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> OPERATOR </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command allowed for </td>
<td> All states </td>
<td> .. </td>
</tr>
</table>
</body>
</html>
doc/doc_html/Commands.html 0 → 100644
+ 90
− 0
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title> GpibPrologix Tango Class Commands </title>
</head>
<body text="Black" bgcolor="White" link="Blue" vlink="Purple" alink="Red">
<br><br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=5> <font size=+1> <center><b> GpibPrologix Class Commands </b></font></center></td>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td> <center><b> Name </b></center> </td>
<td> <center><b> Input type </b></center> </td>
<td> <center><b> Output type </b></center> </td>
<td> <center><b> Level </b></center> </td>
<td> <center><b> Description </b></center> </td>
</tr>
<tr>
<td> <a href="CmdState.html"> State </a> </td>
<td> DEV_VOID </td>
<td> DEV_STATE </td>
<td> OPERATOR </td>
<td> This command gets the device state (stored in its <i>device_state</i> data member) and returns it to the caller. </td>
</tr>
<tr>
<td> <a href="CmdStatus.html"> Status </a> </td>
<td> DEV_VOID </td>
<td> CONST_DEV_STRING </td>
<td> OPERATOR </td>
<td> This command gets the device status (stored in its <i>device_status</i> data member) and returns it to the caller. </td>
</tr>
<tr>
<td> <a href="CmdWrite.html"> Write </a> </td>
<td> DEV_STRING </td>
<td> DEV_VOID </td>
<td> OPERATOR </td>
<td> None. </td>
</tr>
<tr>
<td> <a href="CmdRead.html"> Read </a> </td>
<td> DEV_VOID </td>
<td> DEV_STRING </td>
<td> OPERATOR </td>
<td> None. </td>
</tr>
<tr>
<td> <a href="CmdReadLongString.html"> ReadLongString </a> </td>
<td> DEV_LONG </td>
<td> DEV_STRING </td>
<td> EXPERT </td>
<td> None. </td>
</tr>
<tr>
<td> <a href="CmdWriteRead.html"> WriteRead </a> </td>
<td> DEV_STRING </td>
<td> DEV_STRING </td>
<td> OPERATOR </td>
<td> None. </td>
</tr>
<tr>
<td> <a href="CmdSetTimeOut.html"> SetTimeOut </a> </td>
<td> DEV_SHORT </td>
<td> DEV_VOID </td>
<td> EXPERT </td>
<td> None. </td>
</tr>
<tr>
<td> <a href="CmdTrigger.html"> Trigger </a> </td>
<td> DEV_VOID </td>
<td> DEV_VOID </td>
<td> EXPERT </td>
<td> None. </td>
</tr>
<tr>
<td> <a href="CmdClear.html"> Clear </a> </td>
<td> DEV_VOID </td>
<td> DEV_VOID </td>
<td> OPERATOR </td>
<td> None. </td>
</tr>
<tr>
<td> <a href="CmdIsSRQLineUP.html"> IsSRQLineUP </a> </td>
<td> DEV_VOID </td>
<td> DEV_BOOLEAN </td>
<td> OPERATOR </td>
<td> returns true if SRQ line is UP, false otherwise </td>
</tr>
</table>
</body>
</html>
doc/doc_html/FullDocument.html 0 → 100644
+ 770
− 0
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title> GpibPrologix Tango Class User&lsquo;s Guide </title>
</head>
<body text="Black" bgcolor="White" link="Blue" vlink="Purple" alink="Red">
<hr>
<br>
<center><h2><u><b> GpibPrologix Tango Cpp Class </b></u></h2></center> <br><br>
<ul>
<font size="+1"><u><b> Contents : </b></u></font>
<ul>
<li> <a href="FullDocument.html#description"> Description </a>
<li> <a href="FullDocument.html#properties"> Properties </a>
<li> <a href="FullDocument.html#commands"> Commands </a>
<ul>
<li> <a href="FullDocument.html#cmdState"> State </a>
<li> <a href="FullDocument.html#cmdStatus"> Status </a>
<li> <a href="FullDocument.html#cmdWrite"> Write </a>
<li> <a href="FullDocument.html#cmdRead"> Read </a>
<li> <a href="FullDocument.html#cmdReadLongString"> ReadLongString </a>
<li> <a href="FullDocument.html#cmdWriteRead"> WriteRead </a>
<li> <a href="FullDocument.html#cmdSetTimeOut"> SetTimeOut </a>
<li> <a href="FullDocument.html#cmdTrigger"> Trigger </a>
<li> <a href="FullDocument.html#cmdClear"> Clear </a>
<li> <a href="FullDocument.html#cmdIsSRQLineUP"> IsSRQLineUP </a>
</ul>
<li> <a href="FullDocument.html#attributes"> Attributes </a>
<ul>
</ul>
<li> <a href="FullDocument.html#states"> States </a>
</ul>
</ul>
<hr>
<br><br>
<a name="description"> </a>
<ul>
<br><br><br>
<table border="0" width="100%">
<Tr>
<td> <font size="+1"><u><b> GpibPrologix Class Identification : </b></u></font> </td>
<td> <font size="+1"><u><b> GpibPrologix Class Inheritance : </b></u></font> </td>
</tr>
<td><ul>
<table border="0">
<Tr>
<td> Contact </td><td> : at synchrotron-soleil.fr - coquet</td>
</tr>
<tr>
<td> Class Family </td><td> : Communication
</tr>
<tr>
<td> Platform </td><td> : All Platforms </td>
</tr>
<tr>
<td> Bus </td><td> : GPIB </td>
</tr>
<tr>
<td> Manufacturer </td><td> : none </td>
</tr>
<tr>
<td> Manufacturer ref.</td><td> : </td>
</tr>
</Table>
</ul></td>
<td>
<ul><li> <a href="http://www.esrf.fr/computing/cs/tango/tango_doc/kernel_doc/cpp_doc/" target="new"> Tango::DeviceImpl</a></li>
<ul> <li> GpibPrologix</li>
<br>
<br>
<br>
<br>
<br>
</td>
</Table>
<br><br><br>
<font size="+1"><u><b> GpibPrologix Class Description : </b></u></font>
<br><br>
<ul>
communication interface to gpib instruments through Prologix gpib-ethernet controller<Br>
Only 1 instrument can be connected to GpibPrologix device
<Br>
<center>
<h1>
GpibPrologix <Br>
Device Description <Br> <Br>
GpibPrologix Class <Br>
</h1>
<b>
Revision: - Author:
</b>
</center>
<Center>
communication interface to gpib instruments through Prologix gpib-ethernet controller
Only 1 instrument can be connected to GpibPrologix device
<Br>
<Br>
</Center>
<!--- /*PROTECTED REGION ID(FullDocument.html) ENABLED START*/ --->
<!--- Add your own documentation, pictures, links,.... --->
<!--- /*PROTECTED REGION END*/ --->
</ul>
</ul>
<br><br>
<hr>
<a name="properties"> </a>
<br><br><br>
<font size="+1"><u><b> GpibPrologix Properties : </b></u></font>
<br><br><br>
<font size="+1"><u><b> There is no class properties </b></u></font>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=4> <font size=+1> <center><b> Device Properties </b></font></center></td>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td> <center><b> Name </b></center> </td>
<td> <center><b> Description </b></center> </td>
<td> <center><b> Type </b></center> </td>
<td> <center><b> Default Value </b></center> </td>
</tr>
<tr>
<td> ClientSocketDevName </td>
<td> Name of the ClientSocketServer device which handles the communication </td>
<td> String </td>
<td> none </td>
</tr>
<tr>
<td> ReadTimeout </td>
<td> Read Timeout in milliseconds<Br>
from 1 to 4000<Br>
default value : 100 </td>
<td> short </td>
<td> none </td>
</tr>
<tr>
<td> ReadTermination </td>
<td> how read is finished :<Br>
[TIMEOUT|EOI|TERMINATOR]<Br>
TIMEOUT : read until timeout<Br>
EOI : read until instrument marks with EOI the end of message<Br>
TERMINATOR read until Terminator (the ReadTerminator property) is received<Br>
Default Value : EOI </td>
<td> String </td>
<td> EOI <br> </td>
</tr>
<tr>
<td> ReadTerminator </td>
<td> the Read Terminator<Br>
it marks the end of the response of the instrument<Br>
eg LF = 10, CR = 13 </td>
<td> short </td>
<td> none </td>
</tr>
<tr>
<td> WriteTerminator </td>
<td> terminators to be written at the end of a command<Br>
see command eos<Br>
Prologix removes all not escaped LF,CR, and ESC<Br>
so if LF or CR or CRLF are waited by the instrument at the end of the command specify it here<Br>
possible values :<Br>
0 (CRLF)<Br>
1 (CR)<Br>
2 (LF)<Br>
3 (NONE)<Br>
default value : 2 (LF) </td>
<td> short </td>
<td> none </td>
</tr>
<tr>
<td> GpibAddress </td>
<td> The gpib address (from 0 to 30)<Br>
default : no default -must be set </td>
<td> short </td>
<td> none </td>
</tr>
</table>
<br><br>
<hr>
<a name="commands"> </a>
<br><br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=5> <font size=+1> <center><b> GpibPrologix Class Commands </b></font></center></td>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td> <center><b> Name </b></center> </td>
<td> <center><b> Input type </b></center> </td>
<td> <center><b> Output type </b></center> </td>
<td> <center><b> Level </b></center> </td>
<td> <center><b> Description </b></center> </td>
</tr>
<tr>
<td> <a href="CmdState.html"> State </a> </td>
<td> DEV_VOID </td>
<td> DEV_STATE </td>
<td> OPERATOR </td>
<td> This command gets the device state (stored in its <i>device_state</i> data member) and returns it to the caller. </td>
</tr>
<tr>
<td> <a href="CmdStatus.html"> Status </a> </td>
<td> DEV_VOID </td>
<td> CONST_DEV_STRING </td>
<td> OPERATOR </td>
<td> This command gets the device status (stored in its <i>device_status</i> data member) and returns it to the caller. </td>
</tr>
<tr>
<td> <a href="CmdWrite.html"> Write </a> </td>
<td> DEV_STRING </td>
<td> DEV_VOID </td>
<td> OPERATOR </td>
<td> None. </td>
</tr>
<tr>
<td> <a href="CmdRead.html"> Read </a> </td>
<td> DEV_VOID </td>
<td> DEV_STRING </td>
<td> OPERATOR </td>
<td> None. </td>
</tr>
<tr>
<td> <a href="CmdReadLongString.html"> ReadLongString </a> </td>
<td> DEV_LONG </td>
<td> DEV_STRING </td>
<td> EXPERT </td>
<td> None. </td>
</tr>
<tr>
<td> <a href="CmdWriteRead.html"> WriteRead </a> </td>
<td> DEV_STRING </td>
<td> DEV_STRING </td>
<td> OPERATOR </td>
<td> None. </td>
</tr>
<tr>
<td> <a href="CmdSetTimeOut.html"> SetTimeOut </a> </td>
<td> DEV_SHORT </td>
<td> DEV_VOID </td>
<td> EXPERT </td>
<td> None. </td>
</tr>
<tr>
<td> <a href="CmdTrigger.html"> Trigger </a> </td>
<td> DEV_VOID </td>
<td> DEV_VOID </td>
<td> EXPERT </td>
<td> None. </td>
</tr>
<tr>
<td> <a href="CmdClear.html"> Clear </a> </td>
<td> DEV_VOID </td>
<td> DEV_VOID </td>
<td> OPERATOR </td>
<td> None. </td>
</tr>
<tr>
<td> <a href="CmdIsSRQLineUP.html"> IsSRQLineUP </a> </td>
<td> DEV_VOID </td>
<td> DEV_BOOLEAN </td>
<td> OPERATOR </td>
<td> returns true if SRQ line is UP, false otherwise </td>
</tr>
</table>
<br><br><hr>
<a name="cmdState"> </a>
<br><br><br>
<font size="+1"><u><b> Command State : </b></u></font>
<ul>
This command gets the device state (stored in its <i>device_state</i> data member) and returns it to the caller.
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> State Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_VOID </td>
<td> none. </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_STATE </td>
<td> State Code </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> OPERATOR </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> true </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command allowed for </td>
<td> All states </td>
<td> .. </td>
</tr>
</table>
<br><br><hr>
<a name="cmdStatus"> </a>
<br><br><br>
<font size="+1"><u><b> Command Status : </b></u></font>
<ul>
This command gets the device status (stored in its <i>device_status</i> data member) and returns it to the caller.
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> Status Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_VOID </td>
<td> none. </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::CONST_DEV_STRING </td>
<td> Status description </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> OPERATOR </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> true </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command allowed for </td>
<td> All states </td>
<td> .. </td>
</tr>
</table>
<br><br><hr>
<a name="cmdWrite"> </a>
<br><br><br>
<font size="+1"><u><b> Command Write : </b></u></font>
<ul>
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> Write Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_STRING </td>
<td> String to send to the device </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_VOID </td>
<td> </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> OPERATOR </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command NOT allowed for </td>
<td> <font size="-1"> <li> MOVING </li> </font> </td>
<td> .. </td>
</tr>
</table>
<br><br><hr>
<a name="cmdRead"> </a>
<br><br><br>
<font size="+1"><u><b> Command Read : </b></u></font>
<ul>
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> Read Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_VOID </td>
<td> </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_STRING </td>
<td> Returned string. </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> OPERATOR </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command allowed for </td>
<td> All states </td>
<td> .. </td>
</tr>
</table>
<br><br><hr>
<a name="cmdReadLongString"> </a>
<br><br><br>
<font size="+1"><u><b> Command ReadLongString : </b></u></font>
<ul>
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> ReadLongString Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_LONG </td>
<td> Max expected string length. </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_STRING </td>
<td> The readed string. </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> EXPERT </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command NOT allowed for </td>
<td> <font size="-1"> <li> MOVING </li> <li> FAULT </li> </font> </td>
<td> .. </td>
</tr>
</table>
<br><br><hr>
<a name="cmdWriteRead"> </a>
<br><br><br>
<font size="+1"><u><b> Command WriteRead : </b></u></font>
<ul>
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> WriteRead Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_STRING </td>
<td> String to send to the gpib device. </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_STRING </td>
<td> String returned by the gpib Device. </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> OPERATOR </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command allowed for </td>
<td> All states </td>
<td> .. </td>
</tr>
</table>
<br><br><hr>
<a name="cmdSetTimeOut"> </a>
<br><br><br>
<font size="+1"><u><b> Command SetTimeOut : </b></u></font>
<ul>
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> SetTimeOut Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_SHORT </td>
<td> accepted value are [0-15] </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_VOID </td>
<td> no argout </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> EXPERT </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command NOT allowed for </td>
<td> <font size="-1"> <li> MOVING </li> <li> FAULT </li> </font> </td>
<td> .. </td>
</tr>
</table>
<br><br><hr>
<a name="cmdTrigger"> </a>
<br><br><br>
<font size="+1"><u><b> Command Trigger : </b></u></font>
<ul>
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> Trigger Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_VOID </td>
<td> no argin </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_VOID </td>
<td> no argout </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> EXPERT </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command NOT allowed for </td>
<td> <font size="-1"> <li> MOVING </li> <li> FAULT </li> </font> </td>
<td> .. </td>
</tr>
</table>
<br><br><hr>
<a name="cmdClear"> </a>
<br><br><br>
<font size="+1"><u><b> Command Clear : </b></u></font>
<ul>
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> Clear Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_VOID </td>
<td> no argin </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_VOID </td>
<td> no argout </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> OPERATOR </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command allowed for </td>
<td> All states </td>
<td> .. </td>
</tr>
</table>
<br><br><hr>
<a name="cmdIsSRQLineUP"> </a>
<br><br><br>
<font size="+1"><u><b> Command IsSRQLineUP : </b></u></font>
<ul>
returns true if SRQ line is UP, false otherwise
</ul>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=0> <font size=+1> <center><b> IsSRQLineUP Definition </b></font></center></td>
</tr>
<tr>
<td> Input Argument </td>
<td> Tango::DEV_VOID </td>
<td> </td>
</tr>
<tr>
<td> Output Argument </td>
<td> Tango::DEV_BOOLEAN </td>
<td> </td>
</tr>
<tr>
<td> DisplayLevel </td>
<td> OPERATOR </td>
<td> .. </td>
</tr>
<tr>
<td> Inherited </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Abstract </td>
<td> false </td>
<td> .. </td>
</tr>
<tr>
<td> Polling Period </td>
<td> Not polled </td>
<td> .. </td>
</tr>
<Tr BGCOLOR="#CCCCFF"><Td><Hr></Td><Td><Hr></Td><Td><Hr></Td></Tr>
<tr>
<td> Command allowed for </td>
<td> All states </td>
<td> .. </td>
</tr>
</table>
<br><br>
<hr>
<a name="attributes"> </a>
<br><br><br><br>
<font size="+1"><u><b> There is no attribute defined. </b></u></font>
<br><br>
<hr>
<br><br>
<font size="+1"><u><b> There is no dynamic attribute defined. </b></u></font>
<br><br>
<hr>
<br><br>
<hr>
<a name="states"> </a>
<br><br><br><br>
<font size="+1"><u><b> There is no state defined </b></u></font>
</body>
</html>
doc/doc_html/Properties.html
+ 75
− 206
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<Title> Tango Device Server User's Guide </Title>
</HEAD>
<BODY TEXT="#000000" BGCOLOR="#FFFFFF" LINK="#0000FF" VLINK="#7F00FF" ALINK="#FF0000">
<P><!-------TITLE------></P>
<TABLE BORDER="0" WIDTH="100%">
<TR>
<TD ALIGN="left">
<A HREF="http://www.esrf.fr/" TARGET=new>
<IMG SRC="http://www.esrf.fr/gifs/logo/80.gif" BORDER=0 Height="60"></A>
</Td>
<TD ALIGN="center">
<A HREF="http://www.elettra.trieste.it/" TARGET=new>
<IMG SRC="http://www.esrf.fr/computing/cs/tango/elettra_logo.gif" BORDER=0 Height="60"></A>
</Td>
<TD ALIGN="center">
<A HREF="http://www.synchrotron-soleil.fr/" TARGET=new>
<IMG SRC="http://www.esrf.fr/computing/cs/tango/soleil_logo.gif" BORDER=0 Height="60"></A>
</Td>
<TD ALIGN="right">
<A HREF="http://www.cells.es/" TARGET=new>
<IMG SRC="http://www.esrf.fr/computing/cs/tango/alba.jpg" BORDER=0 Height="54"></A>
</Td>
<TD ALIGN="right">
<A HREF="http://www.desy.de/html/home/index_eng.html" TARGET=new>
<IMG SRC="http://www.esrf.fr/computing/cs/tango/desy.gif" BORDER=0 Height="60"></A>
</Td>
<Td>
<H2><FONT COLOR="#7F00FF">
<Center><A HREF="http://www.tango-controls.org/" TARGET="_top">
TANGO </a> <Br> Device Server
</Center></FONT>
</Td>
</TR>
</TABLE>
<HR WIDTH="100%"></H5>
<Br>
<center>
<h1>
GpibPrologix <Br>
Properties Description <Br> <Br>
GpibPrologix Class <Br>
</h1>
<b>
Revision: - Author: olivierroux
</b>
</center>
<Center>
<Br> <Br> <Br>
<Table Border=2 Cellpadding=3 CELLSPACING=0 WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<Td COLSPAN=3> <Font Size=+2><Center><b>Device Properties</b></td></Font></Center>
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<Td><Center><b>Property name</b></td></Center>
<Td><Center><b>Property type</b></td></Center>
<Td><Center><b>Description</b></td></Center>
<Tr><Td><b><a href=#Dev_DefaultValues>Url </a></b></Td>
<Td><Font Size=-1>Tango::DEV_STRING</Font></Td>
<Td><Font Size=-1>Name or IP address
e.g : gpib1, 172.16.123.123</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>Port </a></b></Td>
<Td><Font Size=-1>Tango::DEV_SHORT</Font></Td>
<Td><Font Size=-1>The IP port
default value : 1234</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>ReadTimeout </a></b></Td>
<Td><Font Size=-1>Tango::DEV_SHORT</Font></Td>
<Td><Font Size=-1>Read Timeout in milliseconds
from 1 to 4000
default value : 100
</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>ReadTermination </a></b></Td>
<Td><Font Size=-1>Tango::DEV_STRING</Font></Td>
<Td><Font Size=-1>how read is finished :
[TIMEOUT|EOI|TERMINATOR]
TIMEOUT : read until timeout
EOI : read until instrument marks with EOI the end of message
TERMINATOR read until Terminator (the ReadTerminator property) is received
Default Value : EOI</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>ReadTerminator </a></b></Td>
<Td><Font Size=-1>Tango::DEV_SHORT</Font></Td>
<Td><Font Size=-1>the Read Terminator
it marks the end of the response of the instrument
eg LF = 10, CR = 13</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>WriteTerminator </a></b></Td>
<Td><Font Size=-1>Tango::DEV_SHORT</Font></Td>
<Td><Font Size=-1>terminators to be written at the end of a command
see command eos
Prologix removes all not escaped LF,CR, and ESC
so if LF or CR or CRLF are waited by the instrument at the end of the command specify it here
possible values :
0 (CRLF)
1 (CR)
2 (LF)
3 (NONE)
default value : 2 (LF)
</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>GpibAddress </a></b></Td>
<Td><Font Size=-1>Tango::DEV_SHORT</Font></Td>
<Td><Font Size=-1>The gpib address (from 0 to 30)
default : no default -must be set</Font></Td></Tr>
</Table>
</Center>
<Br><Br><Br>
<Br><Br><Br>
<A name=Dev_DefaultValues><!--- ---></a>
<Font Size=+1>Device Properties Default Values:</Font><Br>
<Table Border=2 Cellpadding=2 CELLSPACING=2>
<tr BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<Td><b>Property Name</b></td>
<td><b>Default Values</b></td>
</Tr>
<Tr>
<Td>Url</Td>
<td>No default value</td>
</Tr>
<Tr>
<Td>Port</Td>
<td>No default value</td>
</Tr>
<Tr>
<Td>ReadTimeout</Td>
<td>No default value</td>
</Tr>
<Tr>
<Td>ReadTermination</Td>
<td>EOI</td>
</Tr>
<Tr>
<Td>ReadTerminator</Td>
<td>No default value</td>
</Tr>
<Tr>
<Td>WriteTerminator</Td>
<td>No default value</td>
</Tr>
<Tr>
<Td>GpibAddress</Td>
<td>No default value</td>
</Tr>
</Table>
<Br><Br><Br>
<Center><b>
There is no Class properties.<Br><Br>
</Center></b>
<Br> <Br> <Br>
<!--- html Footer --->
<Center>
<Font size=-1>
<br>
<br>
<TABLE BORDER="1" WIDTH="100%">
<Tr>
<!--- Hosted by Sourceforge --->
<Td Align="Center">
<Font size=-1>
<b>TANGO</b> is an open source project hosted by :<br>
<A href="http://sourceforge.net" Target="new">
<IMG title="Sourceforge logo"
alt="Sourceforge logo small"
src="http://www.esrf.fr/computing/cs/tango/sourceforge.gif"
border=0> </a>
</Font>
</Td>
<!--- 2 Sourceforge Repositories --->
<Td Align="Center">
<Font size=-1>
Core and Tools :
<a href="http://tango-cs.cvs.sourceforge.net/tango-cs/" Target="new">
CVS repository</a> on
<a href="https://sourceforge.net/projects/tango-cs" Target=new>
tango-cs project</a>
<br>
Device Servers :
<a href="http://tango-ds.cvs.sourceforge.net/tango-ds/" Target="new">
CVS repository</a> on
<a href="https://sourceforge.net/projects/tango-ds" Target=new>
tango-ds project</a>
</Font>
</Td>
</Tr>
</Table>
</Font>
</Center>
<html>
<head>
<title> GpibPrologix Tango Class Properties </title>
</head>
<body text="Black" bgcolor="White" link="Blue" vlink="Purple" alink="Red">
<br><br><br>
<font size="+1"><u><b> GpibPrologix Properties : </b></u></font>
<br><br><br>
<font size="+1"><u><b> There is no class properties </b></u></font>
<br><br><br>
<Table Border=2 Cellpadding=3 CELLSPACING=0>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan=4> <font size=+1> <center><b> Device Properties </b></font></center></td>
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td> <center><b> Name </b></center> </td>
<td> <center><b> Description </b></center> </td>
<td> <center><b> Type </b></center> </td>
<td> <center><b> Default Value </b></center> </td>
</tr>
<tr>
<td> ClientSocketDevName </td>
<td> Name of the ClientSocketServer device which handles the communication </td>
<td> String </td>
<td> none </td>
</tr>
<tr>
<td> ReadTimeout </td>
<td> Read Timeout in milliseconds<Br>
from 1 to 4000<Br>
default value : 100 </td>
<td> short </td>
<td> none </td>
</tr>
<tr>
<td> ReadTermination </td>
<td> how read is finished :<Br>
[TIMEOUT|EOI|TERMINATOR]<Br>
TIMEOUT : read until timeout<Br>
EOI : read until instrument marks with EOI the end of message<Br>
TERMINATOR read until Terminator (the ReadTerminator property) is received<Br>
Default Value : EOI </td>
<td> String </td>
<td> EOI <br> </td>
</tr>
<tr>
<td> ReadTerminator </td>
<td> the Read Terminator<Br>
it marks the end of the response of the instrument<Br>
eg LF = 10, CR = 13 </td>
<td> short </td>
<td> none </td>
</tr>
<tr>
<td> WriteTerminator </td>
<td> terminators to be written at the end of a command<Br>
see command eos<Br>
Prologix removes all not escaped LF,CR, and ESC<Br>
so if LF or CR or CRLF are waited by the instrument at the end of the command specify it here<Br>
possible values :<Br>
0 (CRLF)<Br>
1 (CR)<Br>
2 (LF)<Br>
3 (NONE)<Br>
default value : 2 (LF) </td>
<td> short </td>
<td> none </td>
</tr>
<tr>
<td> GpibAddress </td>
<td> The gpib address (from 0 to 30)<Br>
default : no default -must be set </td>
<td> short </td>
<td> none </td>
</tr>
</table>
</body>
</html>
doc/doc_html/States.html 0 → 100644
+ 10
− 0
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title> GpibPrologix Tango Class States </title>
</head>
<body text="Black" bgcolor="White" link="Blue" vlink="Purple" alink="Red">
<br><br><br><br>
<font size="+1"><u><b> There is no state defined </b></u></font>
</body>
</html>
doc/doc_html/TitleBanner.html 0 → 100644
+ 14
− 0
View file @ 577a0f8e
<!DOCTYPE html PUBLIC "-//W3C//Dtd XHTML 1.0 transitional//EN" "http://www.w3.org/TR/xhtml1/Dtd/xhtml1-transitional.dtd">
<html>
<center>
<font size="+1"><u><b> GpibPrologix Tango Cpp Class </b></u></font>
<table BORDER="1" WIDTH="100%" CELLSPACING=0>
<td ALIGN="center"> <a href="ClassDescription.html" target="document"> Description </a></td>
<td ALIGN="center"> <a href="Properties.html" target="document"> Properties </a></td>
<td ALIGN="center"> <a href="Commands.html" target="document"> Commands </a></td>
<td ALIGN="center"> <a href="Attributes.html" target="document"> Attributes </a></td>
<td ALIGN="center"> <a href="States.html" target="document"> States </a></td>
<td ALIGN="center"> <a href="FullDocument.html" target="new"> Printable </a></td>
</table>
</center>
</html>
doc/doc_html/index.html
+ 18
− 149
View file @ 577a0f8e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<HTML>
<HEAD>
<Title> Tango Device Server User's Guide </Title>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META name="GENERATOR" CONTENT="Mozilla/4.04 [en] (X11; I; SunOS 5.6 sun4d) [Netscape]">
<META name="Author" CONTENT="Pascal Verdier">
<META name="Description" CONTENT="GpibPrologix Pages">
<META name="Keywords" CONTENT="GpibPrologix Tango class User Guide">
<TITLE>GpibPrologix Tango class User Guide</TITLE>
</HEAD>
<BODY TEXT="#000000" BGCOLOR="#FFFFFF" LINK="#0000FF" VLINK="#7F00FF" ALINK="#FF0000">
<P><!-------TITLE------></P>
<TABLE BORDER="0" WIDTH="100%">
<TR>
<TD ALIGN="left">
<A HREF="http://www.esrf.fr/" TARGET=new>
<IMG SRC="http://www.esrf.fr/gifs/logo/80.gif" BORDER=0 Height="60"></A>
</Td>
<TD ALIGN="center">
<A HREF="http://www.elettra.trieste.it/" TARGET=new>
<IMG SRC="http://www.esrf.fr/computing/cs/tango/elettra_logo.gif" BORDER=0 Height="60"></A>
</Td>
<TD ALIGN="center">
<A HREF="http://www.synchrotron-soleil.fr/" TARGET=new>
<IMG SRC="http://www.esrf.fr/computing/cs/tango/soleil_logo.gif" BORDER=0 Height="60"></A>
</Td>
<TD ALIGN="right">
<A HREF="http://www.cells.es/" TARGET=new>
<IMG SRC="http://www.esrf.fr/computing/cs/tango/alba.jpg" BORDER=0 Height="54"></A>
</Td>
<TD ALIGN="right">
<A HREF="http://www.desy.de/html/home/index_eng.html" TARGET=new>
<IMG SRC="http://www.esrf.fr/computing/cs/tango/desy.gif" BORDER=0 Height="60"></A>
</Td>
<Td>
<H2><FONT COLOR="#7F00FF">
<Center><A HREF="http://www.tango-controls.org/" TARGET="_top">
TANGO </a> <Br> Device Server
</Center></FONT>
</Td>
</TR>
</TABLE>
<HR WIDTH="100%"></H5>
<center>
<h1>
GpibPrologix <Br>
User's Guide <Br><Br>
GpibPrologix Class<Br>
</h1>
<b>
Revision: - Author: olivierroux <Br>
Implemented in C++ - CVS repository: sourceforge(tango-ds)
</b>
</center>
<Br>
<Br>
<Br>
<Br>
<h2>Introduction:</h2>
<ul>
communication interface to gpib instruments through Prologix gpib-ethernet controller
Only 1 instrument can be connected to GpibPrologix device<Br>
</ul>
<Br><h2>Class Identification:</h2>
<ul>
<li><b>Contact :</b> at synchrotron-soleil.fr - coquet
<li><b>Class Family :</b> Communication
<li><b>Platform :</b> All Platforms
<li><b>Bus :</b> GPIB
</ul><Br>
<h2>Class Inheritance:</h2>
<ul>
<li> <a href="http://www.esrf.fr/computing/cs/tango/tango_doc/kernel_doc/cpp_doc/"> Tango::Device_4Impl</a></li>
<ul>
<li> GpibPrologix</li>
</ul>
</ul>
</ul>
</ul>
<Br>
<Br>
<h2>Description:</h2>
<ul>
<li> <a href=Description.html> Device description.</a>
<li> <a href=Properties.html> Properties description</a>
<li> <a href=TangoDevStates.html> States description</a>
<li> <a href=DevCommandsTable.html> Commands description</a>
<li> <a href=Attributes.html> Attributes description</a>
</ul>
<Br>
<Br>
<Br>
<!--------------h2>Programmer's guide:</h2>
<ul>
<li> <a href="html/index.html"> Software description.</a>
</ul>
<Br------>
<Br>
<Br>
<h2>Conclusion:</h2>
<ul>
The device server is ready for distribution application programmers.<Br>
The author will be interested in any feedback which arise from their
usage of this device server.
</ul>
<Br>
<!--- html Footer --->
<Center>
<Font size=-1>
<br>
<br>
<TABLE BORDER="1" WIDTH="100%">
<Tr>
<!--- Hosted by Sourceforge --->
<Td Align="Center">
<Font size=-1>
<b>TANGO</b> is an open source project hosted by :<br>
<A href="http://sourceforge.net" Target="new">
<IMG title="Sourceforge logo"
alt="Sourceforge logo small"
src="http://www.esrf.fr/computing/cs/tango/sourceforge.gif"
border=0> </a>
</Font>
</Td>
<!--- 2 Sourceforge Repositories --->
<Td Align="Center">
<Font size=-1>
Core and Tools :
<a href="http://tango-cs.cvs.sourceforge.net/tango-cs/" Target="new">
CVS repository</a> on
<a href="https://sourceforge.net/projects/tango-cs" Target=new>
tango-cs project</a>
<br>
Device Servers :
<a href="http://tango-ds.cvs.sourceforge.net/tango-ds/" Target="new">
CVS repository</a> on
<a href="https://sourceforge.net/projects/tango-ds" Target=new>
tango-ds project</a>
</Font>
</Td>
</Tr>
</Table>
</Font>
</Center>
</body>
<!--- Definition for the 4 frames window ----------->
<frameset rows="58,65,*,65">
<frame src="http://www.esrf.fr/computing/cs/tango/TangoBanner.html" name="header">
<frame src="TitleBanner.html" name="title">
<frame src="ClassDescription.html" name="document">
<frame src="http://www.esrf.fr/computing/cs/tango/SrcForgeBanner.html" name="footer" >
</frameset>
</html>
pom.xml
+ 1
− 1
View file @ 577a0f8e
......@@ -8,7 +8,7 @@
</parent>
<groupId>fr.soleil.device</groupId>
<artifactId>GpibPrologix-${aol}-${mode}</artifactId>
<version>1.1.17-SNAPSHOT</version>
<version>1.2.0</version>
<packaging>nar</packaging>
<name>GpibPrologix</name>
<description>GpibPrologix device</description>
......
src/ClassFactory.cpp
+ 2
− 0
View file @ 577a0f8e
/*----- PROTECTED REGION ID(GpibPrologix::ClassFactory.cpp) ENABLED START -----*/
static const char *RcsId = "$Id: ClassFactory.cpp,v 1.1 2011-03-01 14:09:17 olivierroux Exp $";
//+=============================================================================
//
......@@ -51,3 +52,4 @@ void Tango::DServer::class_factory()
add_class(GpibPrologix_ns::GpibPrologixClass::init("GpibPrologix"));
}
/*----- PROTECTED REGION END -----*/ // GpibPrologix::ClassFactory.cpp
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment

The place to be for your source code