<html> <head><title>ClanLib Reference: CL_InputSourceProvider</title></head> <body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0> <table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr> <tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table> <table align=center border=0 cellspacing=10> <tr> <td><a href="entire_class_index.html">Entire Class Index</a></td> <td><a href="class_index.html">Main Class Index</a></td> <td><a href="cross_index.html">Cross Index</a></td> <td><a href="global_index.html">Global Index</a></td> </table><h1 align=center>Class CL_InputSourceProvider</h1><p> <b> Class that provides input sources.</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <i>none</i> <br> Derived by: <a href="CL_InputSourceProvider_File.html">CL_InputSourceProvider_File</a> <br>Group: Core (I/O Data) <p> #include <ClanLib/core.h> <p> <hr noshade> <table border=0> <tr><td colspan=3><h3>public function member index:</h3></td> <tr valign=top><td align=left><h3>Construction:</h3></td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_InputSourceProvider.html#548"><tt><font color=blue><b>~CL_InputSourceProvider</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>static</tt> <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>*</tt> </td><td align=right><a href="CL_InputSourceProvider.html#549"><tt><font color=blue><b>create_file_provider</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>path</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>static</tt> <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>*</tt> </td><td align=right><a href="CL_InputSourceProvider.html#550"><tt><font color=blue><b>create_datafile_provider</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filename</font></tt>)</tt>;</td> <tr valign=top><td align=left><h3>Overrideables:</h3></td> <tr valign=top><td align=right><tt><tt>virtual</tt> <a href="CL_InputSource.html"><tt><font color=navy><b>CL_InputSource</b></font></tt></a>*</tt> </td><td align=right><a href="CL_InputSourceProvider.html#551"><tt><font color=blue><b>open_source</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>handle</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>*</tt> </td><td align=right><a href="CL_InputSourceProvider.html#552"><tt><font color=blue><b>clone</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>std::string</font></tt></tt> </td><td align=right><a href="CL_InputSourceProvider.html#553"><tt><font color=blue><b>get_path</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filename</font></tt>)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> CL_InputSourceProvider is used to open inputsources. This can be from a datafile where the inputsource is an index - or it a directory where the files are the inputsources.<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="552"><font size=+1><b>CL_InputSourceProvider::clone</b></font></a> - Returns a copy of the current provider.<br><tt><tt>virtual</tt> <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>*</tt> <a href="CL_InputSourceProvider.html#552"><tt><font color=blue><b>clone</b></font></tt></a><tt>()</tt>;<br><blockquote> Returns - The copy of the inputsource provider.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="550"><font size=+1><b>CL_InputSourceProvider::create_datafile_provider</b></font></a> - Creates a datafile provider.<br> Input sources are opened as indexes in the specified datafile.<br><tt><tt>static</tt> <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>*</tt> <a href="CL_InputSourceProvider.html#550"><tt><font color=blue><b>create_datafile_provider</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filename</font></tt>)</tt>;<br><blockquote> filename - Name of the datafile to be used.<br> Returns - The datafile input provider created.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="549"><font size=+1><b>CL_InputSourceProvider::create_file_provider</b></font></a> - Creates a file provider.<br> Input sources opened are considered as files.<br><tt><tt>static</tt> <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>*</tt> <a href="CL_InputSourceProvider.html#549"><tt><font color=blue><b>create_file_provider</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>path</font></tt>)</tt>;<br><blockquote> path - Path where the files are located.<br> Returns - The file input provider created.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="553"><font size=+1><b>CL_InputSourceProvider::get_path</b></font></a> - Get full path to source:<br><tt><tt>virtual</tt> <tt><font color=navy>std::string</font></tt></tt> <a href="CL_InputSourceProvider.html#553"><tt><font color=blue><b>get_path</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filename</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="551"><font size=+1><b>CL_InputSourceProvider::open_source</b></font></a> - Opens an inputsource using the passed handle.<br><tt><tt>virtual</tt> <a href="CL_InputSource.html"><tt><font color=navy><b>CL_InputSource</b></font></tt></a>*</tt> <a href="CL_InputSourceProvider.html#551"><tt><font color=blue><b>open_source</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>handle</font></tt>)</tt>;<br><blockquote> handle - handle/index/filename/identier to the input source requested.<br> Returns - The opened input source.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="548"><font size=+1><b>CL_InputSourceProvider::~CL_InputSourceProvider</b></font></a> - Input Source Provider destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_InputSourceProvider.html#548"><tt><font color=blue><b>~CL_InputSourceProvider</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> </body> </html>
