<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>C++ API frePPLe: freppleinterface.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="../styles.css" rel="stylesheet" type="text/css">
</head>
<body>
<div id="container">
<div id="menubar">
<div id="logo" align="center">
<br/><img src='../frepple.bmp' alt="frepple" /><br/>
<a href='http://www.frepple.com/'>
<strong>a Free<br/>Production Planning<br/>Library</strong>
</a>
</div>
<div id="menu">
<br/>
<h3><a href='../Main/HomePage.html'>Main</a></h3>
<h3><a href='../UI/Main.html'>User Manual</a></h3>
<h3><a href='../Tutorial/Main.html'>Tutorial</a></h3>
<h3><a href='../Frepple/Main.html'>Reference Manual</a></h3>
<h3><a href='../Main/FAQ.html'>FAQ</a></h3>
<h3><a href='index.html'>C++ API</a></h3>
<br/>
</div>
</div>
<div id="content">
<br/>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="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 List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_18992602582d7248789456d5a25e14d1.html">include</a>
</div>
</div>
<div class="contents">
<h1>freppleinterface.h</h1><a href="a00207.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"> file : $URL: https://frepple.svn.sourceforge.net/svnroot/frepple/trunk/include/freppleinterface.h $</span>
<a name="l00003"></a>00003 <span class="comment"> version : $LastChangedRevision: 1011 $ $LastChangedBy: jdetaeye $</span>
<a name="l00004"></a>00004 <span class="comment"> date : $LastChangedDate: 2009-08-05 12:59:02 +0200 (Wed, 05 Aug 2009) $</span>
<a name="l00005"></a>00005 <span class="comment"> ***************************************************************************/</span>
<a name="l00006"></a>00006
<a name="l00007"></a>00007 <span class="comment">/***************************************************************************</span>
<a name="l00008"></a>00008 <span class="comment"> * *</span>
<a name="l00009"></a>00009 <span class="comment"> * Copyright (C) 2007 by Johan De Taeye *</span>
<a name="l00010"></a>00010 <span class="comment"> * *</span>
<a name="l00011"></a>00011 <span class="comment"> * This library is free software; you can redistribute it and/or modify it *</span>
<a name="l00012"></a>00012 <span class="comment"> * under the terms of the GNU Lesser General Public License as published *</span>
<a name="l00013"></a>00013 <span class="comment"> * by the Free Software Foundation; either version 2.1 of the License, or *</span>
<a name="l00014"></a>00014 <span class="comment"> * (at your option) any later version. *</span>
<a name="l00015"></a>00015 <span class="comment"> * *</span>
<a name="l00016"></a>00016 <span class="comment"> * This library is distributed in the hope that it will be useful, *</span>
<a name="l00017"></a>00017 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of *</span>
<a name="l00018"></a>00018 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser *</span>
<a name="l00019"></a>00019 <span class="comment"> * General Public License for more details. *</span>
<a name="l00020"></a>00020 <span class="comment"> * *</span>
<a name="l00021"></a>00021 <span class="comment"> * You should have received a copy of the GNU Lesser General Public *</span>
<a name="l00022"></a>00022 <span class="comment"> * License along with this library; if not, write to the Free Software *</span>
<a name="l00023"></a>00023 <span class="comment"> * Foundation Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 *</span>
<a name="l00024"></a>00024 <span class="comment"> * USA *</span>
<a name="l00025"></a>00025 <span class="comment"> * *</span>
<a name="l00026"></a>00026 <span class="comment"> ***************************************************************************/</span>
<a name="l00027"></a>00027 <span class="comment"></span>
<a name="l00028"></a>00028 <span class="comment">/** @file freppleinterface.h</span>
<a name="l00029"></a>00029 <span class="comment"> * @brief Public header file for C and C++.</span>
<a name="l00030"></a>00030 <span class="comment"> *</span>
<a name="l00031"></a>00031 <span class="comment"> * This is the public header file for high-level access to the library</span>
<a name="l00032"></a>00032 <span class="comment"> * functionality.<br></span>
<a name="l00033"></a>00033 <span class="comment"> * The methods listed provide also a safe interface API for accessing the</span>
<a name="l00034"></a>00034 <span class="comment"> * library functionality from C, C++, Visual Basic and other programming</span>
<a name="l00035"></a>00035 <span class="comment"> * languages.</span>
<a name="l00036"></a>00036 <span class="comment"> *</span>
<a name="l00037"></a>00037 <span class="comment"> * When extending the library, use the header file frepple.h instead.<br></span>
<a name="l00038"></a>00038 <span class="comment"> * It provides a more detailed API to interface with frePPLe.</span>
<a name="l00039"></a>00039 <span class="comment"> */</span>
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="preprocessor">#ifndef FREPPLE_INTERFACE_H</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#define FREPPLE_INTERFACE_H</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span>
<a name="l00044"></a>00044 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#include <string></span>
<a name="l00046"></a>00046 <span class="preprocessor">#endif</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span>
<a name="l00048"></a>00048 <span class="comment">// For a windows shared library we use the C calling convention: __stdcall.</span>
<a name="l00049"></a>00049 <span class="comment">// Only such functions can be called from VBA...</span>
<a name="l00050"></a>00050 <span class="comment">// For cygwin we don't use the __stdcall, but still need the export/import.</span>
<a name="l00051"></a>00051 <span class="preprocessor">#undef DECLARE_EXPORT</span>
<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="preprocessor">#if defined(WIN32) && !defined(DOXYGEN)</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor"> #ifdef __CYGWIN__</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span><span class="preprocessor"> #ifdef FREPPLE_CORE</span>
<a name="l00055"></a>00055 <span class="preprocessor"></span><span class="preprocessor"> #define DECLARE_EXPORT(type) __declspec (dllexport) type</span>
<a name="l00056"></a>00056 <span class="preprocessor"></span><span class="preprocessor"> #else</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span><span class="preprocessor"> #define DECLARE_EXPORT(type) __declspec (dllimport) type</span>
<a name="l00058"></a>00058 <span class="preprocessor"></span><span class="preprocessor"> #endif</span>
<a name="l00059"></a>00059 <span class="preprocessor"></span><span class="preprocessor"> #else</span>
<a name="l00060"></a>00060 <span class="preprocessor"></span><span class="preprocessor"> #ifdef FREPPLE_CORE</span>
<a name="l00061"></a>00061 <span class="preprocessor"></span><span class="preprocessor"> #define DECLARE_EXPORT(type) __declspec (dllexport) type __stdcall</span>
<a name="l00062"></a>00062 <span class="preprocessor"></span><span class="preprocessor"> #else</span>
<a name="l00063"></a>00063 <span class="preprocessor"></span><span class="preprocessor"> #define DECLARE_EXPORT(type) __declspec (dllimport) type __stdcall</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span><span class="preprocessor"> #endif</span>
<a name="l00065"></a>00065 <span class="preprocessor"></span><span class="preprocessor"> #endif</span>
<a name="l00066"></a>00066 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00067"></a><a class="code" href="a00207.html#ac41fc23b6047e1aec0a8626104711eb0">00067</a> <span class="preprocessor"></span><span class="preprocessor"> #define DECLARE_EXPORT(type) type</span>
<a name="l00068"></a>00068 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00069"></a>00069 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment">/** This method returns a version string. */</span>
<a name="l00071"></a>00071 <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>*) <a class="code" href="a00200.html#a597067b13c71006d886fb8c124a1d003">FreppleVersion</a>();
<a name="l00072"></a>00072 <span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment">/** This function should be called once when the client application starts,</span>
<a name="l00074"></a>00074 <span class="comment"> * and before calling any other function in the API.</span>
<a name="l00075"></a>00075 <span class="comment"> *</span>
<a name="l00076"></a>00076 <span class="comment"> * This method is synchroneous, i.e. it returns only when the complete</span>
<a name="l00077"></a>00077 <span class="comment"> * processing is finished. The method can throw exceptions, and the client</span>
<a name="l00078"></a>00078 <span class="comment"> * is responsible for defining the correct handlers for these.</span>
<a name="l00079"></a>00079 <span class="comment"> */</span>
<a name="l00080"></a>00080 <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a>(<span class="keywordtype">void</span>) <a class="code" href="a00200.html#a13335a18ae6783b5c2aa79a73c0947f9">FreppleInitialize</a>();
<a name="l00081"></a>00081 <span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment">/** The character buffer pointed to by the first parameter contains data in</span>
<a name="l00083"></a>00083 <span class="comment"> * XML format that is passed on to frePPLe for processing.<br></span>
<a name="l00084"></a>00084 <span class="comment"> * The second argument specifies whether frePPLe should validate the data</span>
<a name="l00085"></a>00085 <span class="comment"> * against the XSD schema.<br></span>
<a name="l00086"></a>00086 <span class="comment"> * The last argument specifies whether frePPLe needs to perform only the</span>
<a name="l00087"></a>00087 <span class="comment"> * validation and skip the actual processing.</span>
<a name="l00088"></a>00088 <span class="comment"> *</span>
<a name="l00089"></a>00089 <span class="comment"> * The client is responsible for the memory management in the data buffer.</span>
<a name="l00090"></a>00090 <span class="comment"> *</span>
<a name="l00091"></a>00091 <span class="comment"> * This method is synchroneous, i.e. it returns only when the complete</span>
<a name="l00092"></a>00092 <span class="comment"> * processing is finished. The method can throw exceptions, and the client</span>
<a name="l00093"></a>00093 <span class="comment"> * is responsible for defining the correct handlers for these.</span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a>00095 <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a>(<span class="keywordtype">void</span>) <a class="code" href="a00200.html#a9e1390a1382e0138ffd22c9056d26242">FreppleReadXMLData</a>(const <span class="keywordtype">char</span>*, <span class="keywordtype">bool</span>, <span class="keywordtype">bool</span>);
<a name="l00096"></a>00096 <span class="comment"></span>
<a name="l00097"></a>00097 <span class="comment">/** The first parameter is the name of a file that contains data in XML</span>
<a name="l00098"></a>00098 <span class="comment"> * format for frePPLe processing. If a NULL pointer is passed, frepple</span>
<a name="l00099"></a>00099 <span class="comment"> * will read from the standard input.<br></span>
<a name="l00100"></a>00100 <span class="comment"> * The second argument specifies whether frePPLe should validate the data</span>
<a name="l00101"></a>00101 <span class="comment"> * against the XSD schema.<br></span>
<a name="l00102"></a>00102 <span class="comment"> * The last argument specifies whether frePPLe needs to perform only the</span>
<a name="l00103"></a>00103 <span class="comment"> * validation and skip the actual processing.</span>
<a name="l00104"></a>00104 <span class="comment"> *</span>
<a name="l00105"></a>00105 <span class="comment"> * This method is synchroneous, i.e. it returns only when the complete</span>
<a name="l00106"></a>00106 <span class="comment"> * processing is finished. The method can throw exceptions, and the client</span>
<a name="l00107"></a>00107 <span class="comment"> * is responsible for defining the correct handlers for these.</span>
<a name="l00108"></a>00108 <span class="comment"> */</span>
<a name="l00109"></a>00109 <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a>(<span class="keywordtype">void</span>) <a class="code" href="a00200.html#aa13cb0cd869ffbb251070cbfd8710e00">FreppleReadXMLFile</a>(const <span class="keywordtype">char</span>*, <span class="keywordtype">bool</span>, <span class="keywordtype">bool</span>);
<a name="l00110"></a>00110 <span class="comment"></span>
<a name="l00111"></a>00111 <span class="comment">/** Calling this function will save the frePPLe data in the file that</span>
<a name="l00112"></a>00112 <span class="comment"> * is passed as the argument.</span>
<a name="l00113"></a>00113 <span class="comment"> *</span>
<a name="l00114"></a>00114 <span class="comment"> * This method is synchroneous, i.e. it returns only when the complete</span>
<a name="l00115"></a>00115 <span class="comment"> * processing is finished. The method can throw exceptions, and the client</span>
<a name="l00116"></a>00116 <span class="comment"> * is responsible for defining the correct handlers for these.</span>
<a name="l00117"></a>00117 <span class="comment"> */</span>
<a name="l00118"></a>00118 <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a>(<span class="keywordtype">void</span>) <a class="code" href="a00200.html#a99fada28bea93e9dbb8bbb4ebce40a35">FreppleSaveFile</a>(const <span class="keywordtype">char</span>*);
<a name="l00119"></a>00119 <span class="comment"></span>
<a name="l00120"></a>00120 <span class="comment">/** This function causes the frepple executable to shut down in an orderly</span>
<a name="l00121"></a>00121 <span class="comment"> * way.</span>
<a name="l00122"></a>00122 <span class="comment"> *</span>
<a name="l00123"></a>00123 <span class="comment"> * This method is synchroneous, i.e. it returns only when the complete</span>
<a name="l00124"></a>00124 <span class="comment"> * processing is finished. The method can throw exceptions, and the client</span>
<a name="l00125"></a>00125 <span class="comment"> * is responsible for defining the correct handlers for these.</span>
<a name="l00126"></a>00126 <span class="comment"> */</span>
<a name="l00127"></a>00127 <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a>(<span class="keywordtype">void</span>) <a class="code" href="a00200.html#a343ef9b72a0d751e081c33e680cf53ac">FreppleExit</a>();
<a name="l00128"></a>00128
<a name="l00129"></a>00129 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00130"></a>00130 <span class="preprocessor"></span><span class="comment">/** Echo a message in the frePPLe log stream (which is either a file or</span>
<a name="l00131"></a>00131 <span class="comment"> * the standard output stream).</span>
<a name="l00132"></a>00132 <span class="comment"> *</span>
<a name="l00133"></a>00133 <span class="comment"> * This function is only available when using C++. The same functionality</span>
<a name="l00134"></a>00134 <span class="comment"> * is available to C with the function FreppleLog(const char*).</span>
<a name="l00135"></a>00135 <span class="comment"> */</span>
<a name="l00136"></a>00136 <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a>(<span class="keywordtype">void</span>) <a class="code" href="a00200.html#a3e027e800aff06e2e732bb7c2b38e92c">FreppleLog</a>(const std::<span class="keywordtype">string</span>&);
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="comment">/* The functions listed below can be called from C. */</span>
<a name="l00139"></a>00139 extern "C"
<a name="l00140"></a>00140 {
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="preprocessor">#endif</span>
<a name="l00143"></a>00143 <span class="preprocessor"></span><span class="comment"> /** Echo a message in the frePPLe log stream (which is either a file or</span>
<a name="l00144"></a>00144 <span class="comment"> * the standard output stream).</span>
<a name="l00145"></a>00145 <span class="comment"> */</span>
<a name="l00146"></a>00146 <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a>(<span class="keywordtype">void</span>) <a class="code" href="a00200.html#a3e027e800aff06e2e732bb7c2b38e92c">FreppleLog</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>*);
<a name="l00147"></a>00147 <span class="comment"></span>
<a name="l00148"></a>00148 <span class="comment"> /** Same as FreppleInitialize, but catches all exceptions and returns a</span>
<a name="l00149"></a>00149 <span class="comment"> * status instead.</span>
<a name="l00150"></a>00150 <span class="comment"> *</span>
<a name="l00151"></a>00151 <span class="comment"> * Use this function when calling the library from C or VB applications.</span>
<a name="l00152"></a>00152 <span class="comment"> * @see FreppleInitialize</span>
<a name="l00153"></a>00153 <span class="comment"> */</span>
<a name="l00154"></a>00154 <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a>(<span class="keywordtype">int</span>) <a class="code" href="a00200.html#aa09bdb80ef8c0b142611cfa6f480e5e2">FreppleWrapperInitialize</a>();
<a name="l00155"></a>00155 <span class="comment"></span>
<a name="l00156"></a>00156 <span class="comment"> /** Same as FreppleReadXMLData, but catches all exceptions and returns a</span>
<a name="l00157"></a>00157 <span class="comment"> * status instead.</span>
<a name="l00158"></a>00158 <span class="comment"> *</span>
<a name="l00159"></a>00159 <span class="comment"> * Use this function when calling the library from C or VB applications.</span>
<a name="l00160"></a>00160 <span class="comment"> * @see FreppleReadXMLData</span>
<a name="l00161"></a>00161 <span class="comment"> */</span>
<a name="l00162"></a>00162 <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a>(<span class="keywordtype">int</span>) <a class="code" href="a00200.html#aac06c22403aeeb727b35a504aacb62e2">FreppleWrapperReadXMLData</a>(<span class="keywordtype">char</span>*, <span class="keywordtype">bool</span>, <span class="keywordtype">bool</span>);
<a name="l00163"></a>00163 <span class="comment"></span>
<a name="l00164"></a>00164 <span class="comment"> /** Same as FreppleReadXMLFile, but catches all exceptions and returns a</span>
<a name="l00165"></a>00165 <span class="comment"> * status instead.</span>
<a name="l00166"></a>00166 <span class="comment"> *</span>
<a name="l00167"></a>00167 <span class="comment"> * Use this function when calling the library from C or VB applications.</span>
<a name="l00168"></a>00168 <span class="comment"> * @see FreppleReadXMLFile</span>
<a name="l00169"></a>00169 <span class="comment"> */</span>
<a name="l00170"></a>00170 <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a>(<span class="keywordtype">int</span>) <a class="code" href="a00200.html#a4474c6f0eb3bde669fb851a49ea9b14b">FreppleWrapperReadXMLFile</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>*, <span class="keywordtype">bool</span>, <span class="keywordtype">bool</span>);
<a name="l00171"></a>00171 <span class="comment"></span>
<a name="l00172"></a>00172 <span class="comment"> /** Same as FreppleSaveFile, but catches all exceptions and returns a</span>
<a name="l00173"></a>00173 <span class="comment"> * status instead.</span>
<a name="l00174"></a>00174 <span class="comment"> *</span>
<a name="l00175"></a>00175 <span class="comment"> * Use this function when calling the library from C or VB applications.</span>
<a name="l00176"></a>00176 <span class="comment"> * @see FreppleSaveFile</span>
<a name="l00177"></a>00177 <span class="comment"> */</span>
<a name="l00178"></a>00178 <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a>(<span class="keywordtype">int</span>) <a class="code" href="a00200.html#ae66d8a62a506de031731142c6b7ebe7a">FreppleWrapperSaveFile</a>(<span class="keywordtype">char</span>*);
<a name="l00179"></a>00179 <span class="comment"></span>
<a name="l00180"></a>00180 <span class="comment"> /** Same as FreppleExit, but catches all exceptions and returns a</span>
<a name="l00181"></a>00181 <span class="comment"> * status instead.</span>
<a name="l00182"></a>00182 <span class="comment"> *</span>
<a name="l00183"></a>00183 <span class="comment"> * Use this function when calling the library from C or VB applications.</span>
<a name="l00184"></a>00184 <span class="comment"> * @see FreppleExit</span>
<a name="l00185"></a>00185 <span class="comment"> */</span>
<a name="l00186"></a>00186 <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a>(<span class="keywordtype">int</span>) <a class="code" href="a00200.html#abfef211e8bc738a30a69e5584573182e">FreppleWrapperExit</a>();
<a name="l00187"></a>00187
<a name="l00188"></a>00188 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00189"></a>00189 <span class="preprocessor"></span>} <span class="comment">// End of "extern C"</span>
<a name="l00190"></a>00190 <span class="preprocessor">#endif</span>
<a name="l00191"></a>00191 <span class="preprocessor"></span>
<a name="l00192"></a>00192 <span class="preprocessor">#endif // End of FREPPLE_INTERFACE_H</span>
</pre></div></div>
<hr size="1"/><address style="align: right;"><small>Documentation generated for frePPLe by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"/></a></small></address>
</div>
</div>
</body>
</html>
