mirror of
https://github.com/0ldsk00l/nestopia.git
synced 2025-04-02 10:31:51 -04:00
301 lines
8.9 KiB
HTML
301 lines
8.9 KiB
HTML
<HTML>
|
|
|
|
<HEAD>
|
|
<!-- Generated by CppDoc v2.4.1 on June 07, 2008 at 22:48-->
|
|
|
|
<META NAME="GENERATOR" Content="CppDoc">
|
|
<TITLE>Nestopia Core API: Nes::Api::BarcodeReader</TITLE>
|
|
|
|
</HEAD>
|
|
|
|
<BODY>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#eeeeff">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-overview-summary.html"><B>Overview</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="project-summary.html"><B>Project</B></a> </TD>
|
|
<TD BGCOLOR="navy"> <FONT COLOR="white"> <B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="project-tree.html"><B>Tree</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-deprecated-list.html"><B>Deprecated</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-all.html"><B>Index</B></a> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
<B>Nestopia Core API</B></EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><FONT SIZE="-2">
|
|
<a href="../../index.html" target="_top"><B>FRAMES</B></a>
|
|
<a href="../api/Nes..Api..BarcodeReader.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top"><FONT SIZE="-2">
|
|
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
api</FONT>
|
|
<BR>
|
|
Class Nes::Api::BarcodeReader</H2>
|
|
<PRE>
|
|
<code>Base</code>
|
|
|
|
|
+--<B>Nes::Api::BarcodeReader</B>
|
|
|
|
</PRE>
|
|
<HR>
|
|
<DL>
|
|
<DT>class <B><a href="../api/Nes..Api.html">Nes::Api</a>::BarcodeReader</B></DT><dt> extends Base
|
|
</DL>
|
|
|
|
<p>Bar code reader interface.
|
|
<p>
|
|
|
|
|
|
<HR>
|
|
|
|
|
|
<!-- =========== CONSTRUCTOR SUMMARY =========== -->
|
|
|
|
<A NAME="constructor_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Constructor Summary</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#BarcodeReader(T&)">BarcodeReader</a></B>( T& instance )</CODE>
|
|
|
|
<BR>
|
|
Interface constructor.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
<!-- =========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> bool</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#CanTransfer()">CanTransfer</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Checks if the reader is ready to scan.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> bool</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#IsConnected()">IsConnected</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Checks if a reader is connected.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> bool</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#IsDigitsSupported(uint)">IsDigitsSupported</a></B>( uint length ) const</CODE>
|
|
|
|
<BR>
|
|
Checks if the number of bar code digits is supported.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> uint</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#Randomize(char(&[MAX_DIGITS+1])">Randomize</a></B>( char(& string )[ MAX_DIGITS+ 1] ) const</CODE>
|
|
|
|
<BR>
|
|
Generates a randomized bar code.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> Result</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#Transfer(constchar*,uint)">Transfer</a></B>( const char* string, uint length )</CODE>
|
|
|
|
<BR>
|
|
Transfers a bar code to the reader.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
<BR>
|
|
<BR>
|
|
<!-- ============ Constructor Detail ========== -->
|
|
|
|
<A NAME="constructor_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
<B>Constructor Detail</B></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="BarcodeReader(T&)"><!-- --></A>
|
|
<A NAME="BarcodeReader"><!-- --></A>
|
|
<H3>BarcodeReader</H3>
|
|
<PRE>
|
|
public <B>BarcodeReader</B>( T& instance );
|
|
</PRE>
|
|
<DL>
|
|
<DD>Interface constructor.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>instance</code> - emulator instance</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<BR>
|
|
<!-- ============ Method Detail ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="CanTransfer()"><!-- --></A>
|
|
<A NAME="CanTransfer"><!-- --></A>
|
|
<H3>CanTransfer</H3>
|
|
<PRE>
|
|
public bool <B>CanTransfer</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Checks if the reader is ready to scan.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>true if ready</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="IsConnected()"><!-- --></A>
|
|
<A NAME="IsConnected"><!-- --></A>
|
|
<H3>IsConnected</H3>
|
|
<PRE>
|
|
public bool <B>IsConnected</B>() const;
|
|
</PRE>
|
|
<DL>
|
|
<DD>Checks if a reader is connected.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>true if connected</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="IsDigitsSupported(uint)"><!-- --></A>
|
|
<A NAME="IsDigitsSupported"><!-- --></A>
|
|
<H3>IsDigitsSupported</H3>
|
|
<PRE>
|
|
public bool <B>IsDigitsSupported</B>( uint length ) const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Checks if the number of bar code digits is supported.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>length</code> - number of digits in the range 8 to 13</DD>
|
|
|
|
<DT><B>Returns: </B><DD>true if supported</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Randomize(char(&[MAX_DIGITS+1])"><!-- --></A>
|
|
<A NAME="Randomize"><!-- --></A>
|
|
<H3>Randomize</H3>
|
|
<PRE>
|
|
public uint <B>Randomize</B>( char(& string )[ MAX_DIGITS+ 1] ) const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Generates a randomized bar code.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>string</code> - string to be filled</DD>
|
|
|
|
<DT><B>Returns: </B><DD>length of randomized bar code, 0 if reader is disconnected</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Transfer(constchar*,uint)"><!-- --></A>
|
|
<A NAME="Transfer"><!-- --></A>
|
|
<H3>Transfer</H3>
|
|
<PRE>
|
|
public Result <B>Transfer</B>( const char* string, uint length ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Transfers a bar code to the reader.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>string</code> - bar code string
|
|
|
|
<DD><code>length</code> - string length</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#eeeeff">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-overview-summary.html"><B>Overview</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="project-summary.html"><B>Project</B></a> </TD>
|
|
<TD BGCOLOR="navy"> <FONT COLOR="white"> <B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="project-tree.html"><B>Tree</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-deprecated-list.html"><B>Deprecated</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-all.html"><B>Index</B></a> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
<B>Nestopia Core API</B></EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><FONT SIZE="-2">
|
|
<a href="../../index.html" target="_top"><B>FRAMES</B></a>
|
|
<a href="../api/Nes..Api..BarcodeReader.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top"><FONT SIZE="-2">
|
|
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
|
|
<HR>
|
|
|
|
|
|
</BODY>
|
|
|
|
</HTML>
|
|
|