.. highlight:: xml

.. _cash-flow-modelbase-xml:

Cash flow model
===============

The cash flow modelbase defines cash flow models that affect different prices and costs over time.

An example of the document contents is given below, for a comprehensive description of all the possible content options see the `schema document <http://svn.simo-project.org/simo/trunk/simulator/xml/schemas/cash_flow_modelbase.xsd>`_. Data continuation and abbreviated content expressed as …:

The root level tag contains a reference to the schema document which is used to validate the content of the XML document::

   <cash_flow_modelbase xmlns="http://www.simo-project.org/simo"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.simo-project.org/simo 
      ../schemas/cash_flow_modelbase.xsd">

Each cash flow model has a unique name and an implementation. The implementation is defined by giving the cash flow model library module, where the actual programmatic implementation is, as well as the programming language for the implementation (at the moment only Python is supported):: 

   …
      <cash_flow_model>
         <name>Timber_prices</name>
         <implemented_at>cashflowmodels.py</implemented_at>
         <implemented_in>Python</implemented_in>

Each model gets it's reference cash flow values from a cash flow table (:ref:`cash-flow-table-xml`)::

   …
         <reference_values>
            <cash_flow_table>timber_prices</cash_flow_table>
         </reference_values>

Cash flow models can also have input variables, which are taken from current data variables::

   …
         <variables>
            <variable>
               <name>SP</name>
               <level>stratum</level>
            </variable>
         </variables>
         </cash_flow_model>
      </cash_flow_modelbase>

Optional content
****************

In addition to the cash flow table, a date can be specified for the reference values. In that case the cash flow table for the reference values must have the start and end dates specified for each of the value tables it contains (:ref: `cash-flow-table-xml`). The table that overlaps the date specified for the reference values is then used to get the reference values::

   <reference_values>
      <cash_flow_table>timber_prices</cash_flow_table>
      <date>2010-01-01</date>
   </reference_values>