Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 54cac1c2268db633d66eeff1b4faa585 > files > 39

frepple-doc-0.8.1-3.fc15.noarch.rpm

<!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>Frepple / Global parameters</title>
  <link rel='stylesheet' href='../styles.css' type='text/css' />
  <!--PageHeaderFmt-->  
</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='Main.html'>Reference Manual</a></h3>
<h3><a href='../Main/FAQ.html'>FAQ</a></h3>
<h3><a href='../reference/index.html'>C++ API</a></h3>
<br/><div>
</div>  
</div>
</div>

<div id="content">
<br/>
<!--PageText-->
<div id='wikitext'>
<p><a class='wikilink' href='../Main/HomePage.html'>Main</a> &gt; <span class='wikitrail'><a class='wikilink' href='Main.html'>Reference Manual</a> > <a class='wikilink' href='Modeling.html'>Modeling</a> > <a class='selflink' href='ModelingGlobal.html'>Global parameters</a></span>
</p>
<p class='vspace'>A number of global settings and parameters are described here. 
</p>
<div class='vspace'></div><h2>Fields</h2>
<table border='1' ><tr><td width='20%'  valign='top'><strong>Field</strong>
</td><td width='20%'  valign='top'><strong>Type</strong>
</td><td width='60%'  valign='top'><strong>Description</strong>
</td></tr><tr><td  valign='top'>name
</td><td  valign='top'>normalizedString
</td><td  valign='top'>
<p>Model name.<br />Default is null.
</p></td></tr><tr><td  valign='top'>description
</td><td  valign='top'>string
</td><td  valign='top'>
<p>Free format description.
</p></td></tr><tr><td  valign='top'>current
</td><td  valign='top'>dateTime
</td><td  valign='top'>
<p>The 'now' date for the plan.<br />It distinguishes the past from the future.
</p></td></tr><tr><td  valign='top'>logfile
</td><td  valign='top'>normalizedString
</td><td  valign='top'>
<p>File name where all output will be sent to.<br />If left unspecified, the output appears on the standard output.<br />If the filename starts with '+' an existing logfile with the same name is being appended to, instead of being overwritten.
</p></td></tr></table>
<div class='vspace'></div><h2>Example XML structures</h2>
<ul><li>Global initialization section
</li></ul><pre> &lt;plan&gt;
    &lt;name&gt;Demo model&lt;/name&gt;
    &lt;description&gt;A demo model demonstrating frePPLe&lt;/description&gt;
    &lt;current&gt;2007-01-01T00:00:00&lt;/current&gt;
    &lt;logfile&gt;frepple.log&lt;/logfile&gt;
 &lt;/plan&gt;
</pre><div class='vspace'></div><h2>Example Python code</h2>
<ul><li>Global initialization section
</li></ul><pre>    frepple.settings.name = &quot;Plan name&quot;
    frepple.settings.description = &quot;Plan description&quot; 
    frepple.settings.current = datetime.datetime(2007,1,1)
    frepple.settings.logfile = &quot;frepple.log&quot; 
</pre>
</div>

<!--PageFooterFmt-->
<!--HTMLFooter-->
</div></div>
</body>
</html>