sysmodellibs/sysmodelgen/doc/sysmodel/SMG-Input-Files/Dependencies-sysinfo.html
author Bob Rosenberg <bob.rosenberg@nokia.com>
Wed, 13 Oct 2010 16:21:25 +0100
changeset 7 3c36c452f013
permissions -rw-r--r--
Version 2.0 release of System Model Generator, which draws 3.x syntax system definition files

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    <!-- Generated by Xbuild version: 5.0.20 -->
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<meta name="show-comments" content="" />
	<title>Dependencies System Info File in System Model Generator Input Files</title>    
	<link href="../../_stock/css/reset.css" rel="stylesheet" type="text/css" />
	<link href="../../_stock/css/portal.css" rel="stylesheet" type="text/css" />
	<link href="../../_stock/css/iefix.css" rel="stylesheet" type="text/css" />
	<link href="../../_stock/css/ui.tabs.css" rel="stylesheet" type="text/css" />
	<link href="../../_stock/css/developer.css" rel="stylesheet" type="text/css" />
	<link rel="stylesheet" type="text/css" href="../../_stock/css/ui.css" media="screen" />
	<link rel="stylesheet" type="text/css" href="../../_stock/css/sysdoc.css" media="screen" />
	<link rel="stylesheet" type="text/css" href="../../_stock/css/sdlplugin.css" media="screen" />
    </head>
    <body>
	<div id="main_content">
	    <table width="100%" cellpadding="0" cellspacing="0" border="0">
		<tr>
		    <td valign="top" width="100%">
			<div id="main_content_txt">
			    <div class="main_content_padding">		
                                <div id="main">
                                    <div id="authoredContent">
                                        <div class="section">
<a name="DependenciesXMLFile"></a><h1>Dependencies System Info File</h1><div class="section">
<h2>Purpose</h2><p>
		Dependencies of various types can be provided via a <a href="System-Info-XMLFile.html">system info file</a>. 
		This will allow the System Model to show mouse-over dependencies
		between components of a system model. Dependencies should only go between items of the same rank.
	  </p>
	  
	  <p>
	  Dependencies are encoded in the <a href="System-Info-XMLFile.html">System Info XML format</a> using the <code>data-type="Dependencies"</code> <small>(note the captial "D")</small>.
	  These files will usually be generated rather than hand-crafted. The syntax is provided here for tools developers and for those doing small, manual dependency models.
	  </p>
	  </div>


<div class="<var>section</var>">
<h2>Syntax</h2><div class="Example"><code class="xml">&lt;?xml version="1.0"?&gt;  
<br>&lt;info data-type="Dependencies" <span class="opt">id-namespace="<var>uri</var>"</span> <span class="opt"><var>&#133;namespaces&#133;</var></span> &gt;
<div class="indent">&lt;item ref="<var>id</var>"&gt;
<div class="indent">&lt;dep ref="<var>id</var>" <span class="opt">type="<var>type</var>"</span>/&gt;
</br>&lt;dep ref="<var>id</var>" <span class="opt">type="<var>type</var>"</span>/&gt;
<br/>&#133; </div>
&lt;/item&gt;
<br>&#133;
</div>&lt;/item&gt;</code></div>

<p>Each <code>item</code> contains any number of <code>dep</code> elements. These indicate the system model item referenced in  <code>&lt;item&gt;</code>
is dependent on the system model item mentioned in  <code>&lt;dep&gt;</code>.
</p>
<ul>
<li><code>type="<var>type</var>"</code> : The type of dependendency between the two system model items. Defaults to <code>bin</code>. Standard values are:
<ul>
<li><code class="default">bin</code> &mdash; Static dependencies coming from binary linkage. Shown as a solid line on the system model.</li>
<li><code>api</code> &mdash; Static dependencies like "bin" but can be explained by a controlled API. Shown as a dashed line on the system model.</li>
<li><code>ecom</code> &mdash; ECOM plugin load (dynamic). Shown as a dotten line on the system model. </li>
<li><code>cs</code> &mdash; Client Server dependency between client and server binaries</li>
<li><code>cr</code> &mdash; Central Repository key usage</li>
<li><code>ps</code> &mdash; Publish and Subscribe key usage</li>
<li><code>imp</code> &mdash; implements an API</li>
<li><code>rlib</code> &mdash; RLibrary usage: binary loads another binary using RLibrary interface </li></ul>
<p>Custom values are also legal.</p>
</li></ul>

<p>
On the system model, forward dependencies are show in black, and reverse dependencies in blue.
The arrowhead always points to the item it's dependent on, ie the one in <code>&lt;dep&gt;</code>.


Only <code>api</code>  and <code>ecom</code> have special line types. All other dependencies show up as solid lines.
	  </p><div class="Figure">
		<p class="Image"><img src="arrows.png" alt=""  border="0"/></p><br clear="all"/>
	  </div>

<p>
Dependency arrows, colours and line styles can all be set using CSS in the <a href="../CustomSysmodel/cust.css.html"><code>&lt;deps&gt;</code> section</a> of the Shapes XML File. 
The dependency type is used as the class on a <code>path</code> element. For example, to set the <code>cr</code> dependencies as alternating wide and narrow dashes use:
</p><div class="Example">
<code class="css">
	path.cr {<div class="indent">stroke-dasharray: 9, 3, 5, 3;</div>}
<code></div>



<div class="section">
<h2> See also</h2><p>
		<a href="Model-XMLFile.html#ModelXMLFile">Model XML File</a> 
	  </p><p>
		<a href="Shapes-XMLFile.html#ShapesXMLFile" title="You can use the shapes XML file to specify the styling of the components and its generated legend items. This includes the following UI customization:">Shapes XML File</a> 
	  </p><p>
		<a href="Levels-XMLFile.html#LevelsXMLFile">Levels XML File</a> 
	  </p><p>
		<a href="Localisation-XMLFile.html#Localisation">Localization XML File</a> 
	  </p><p>
		<a href="System-Info-XMLFile.html#SystemInfoXML">SystemInfo XML File</a> 
	  </p><p>
		<a href="Values-XML-index.html#valuesxml" title="The Values XML files are used to define default and per-component display properties. You can use a values XML file to define colors, patterns, border shapes, or border styles of the components.">Values XML File</a> 
	  </p></div>
</div>

                                    </div>
                                    <div id="printer_copyright">
                                        <div id="printer_copyright_padding">
                                            Copyright &copy;2009  Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: <a href="http://www.symbianfoundation.org/legal/sfl-v10.html">SFL</a>
                                        </div>
                                    </div>
                                </div>
			    </div>
			</div>
		    </td>
		</tr>
	    </table>
	    <div style="clear: both"></div>
	</div>
	<div id="includedFooter">
	    <div id="devnet_footer">
            <div style="float: left;">Copyright &copy;2009  Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: <a href="http://www.symbianfoundation.org/legal/sfl-v10.html">SFL</a>. </div>
            <div id='BUILD_VERSION'></div>
	    </div>
	</div>
</body>
</html>