sysmodellibs/sysmodelgen/doc/sysmodel/SMG-Input-Files/Dependencies-sysinfo.html
changeset 7 3c36c452f013
equal deleted inserted replaced
6:5b32dc297d05 7:3c36c452f013
       
     1 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
       
     2     <!-- Generated by Xbuild version: 5.0.20 -->
       
     3     <head>
       
     4         <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
       
     5 	<meta name="show-comments" content="" />
       
     6 	<title>Dependencies System Info File in System Model Generator Input Files</title>    
       
     7 	<link href="../../_stock/css/reset.css" rel="stylesheet" type="text/css" />
       
     8 	<link href="../../_stock/css/portal.css" rel="stylesheet" type="text/css" />
       
     9 	<link href="../../_stock/css/iefix.css" rel="stylesheet" type="text/css" />
       
    10 	<link href="../../_stock/css/ui.tabs.css" rel="stylesheet" type="text/css" />
       
    11 	<link href="../../_stock/css/developer.css" rel="stylesheet" type="text/css" />
       
    12 	<link rel="stylesheet" type="text/css" href="../../_stock/css/ui.css" media="screen" />
       
    13 	<link rel="stylesheet" type="text/css" href="../../_stock/css/sysdoc.css" media="screen" />
       
    14 	<link rel="stylesheet" type="text/css" href="../../_stock/css/sdlplugin.css" media="screen" />
       
    15     </head>
       
    16     <body>
       
    17 	<div id="main_content">
       
    18 	    <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    19 		<tr>
       
    20 		    <td valign="top" width="100%">
       
    21 			<div id="main_content_txt">
       
    22 			    <div class="main_content_padding">		
       
    23                                 <div id="main">
       
    24                                     <div id="authoredContent">
       
    25                                         <div class="section">
       
    26 <a name="DependenciesXMLFile"></a><h1>Dependencies System Info File</h1><div class="section">
       
    27 <h2>Purpose</h2><p>
       
    28 		Dependencies of various types can be provided via a <a href="System-Info-XMLFile.html">system info file</a>. 
       
    29 		This will allow the System Model to show mouse-over dependencies
       
    30 		between components of a system model. Dependencies should only go between items of the same rank.
       
    31 	  </p>
       
    32 	  
       
    33 	  <p>
       
    34 	  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>.
       
    35 	  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.
       
    36 	  </p>
       
    37 	  </div>
       
    38 
       
    39 
       
    40 <div class="<var>section</var>">
       
    41 <h2>Syntax</h2><div class="Example"><code class="xml">&lt;?xml version="1.0"?&gt;  
       
    42 <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;
       
    43 <div class="indent">&lt;item ref="<var>id</var>"&gt;
       
    44 <div class="indent">&lt;dep ref="<var>id</var>" <span class="opt">type="<var>type</var>"</span>/&gt;
       
    45 </br>&lt;dep ref="<var>id</var>" <span class="opt">type="<var>type</var>"</span>/&gt;
       
    46 <br/>&#133; </div>
       
    47 &lt;/item&gt;
       
    48 <br>&#133;
       
    49 </div>&lt;/item&gt;</code></div>
       
    50 
       
    51 <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>
       
    52 is dependent on the system model item mentioned in  <code>&lt;dep&gt;</code>.
       
    53 </p>
       
    54 <ul>
       
    55 <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:
       
    56 <ul>
       
    57 <li><code class="default">bin</code> &mdash; Static dependencies coming from binary linkage. Shown as a solid line on the system model.</li>
       
    58 <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>
       
    59 <li><code>ecom</code> &mdash; ECOM plugin load (dynamic). Shown as a dotten line on the system model. </li>
       
    60 <li><code>cs</code> &mdash; Client Server dependency between client and server binaries</li>
       
    61 <li><code>cr</code> &mdash; Central Repository key usage</li>
       
    62 <li><code>ps</code> &mdash; Publish and Subscribe key usage</li>
       
    63 <li><code>imp</code> &mdash; implements an API</li>
       
    64 <li><code>rlib</code> &mdash; RLibrary usage: binary loads another binary using RLibrary interface </li></ul>
       
    65 <p>Custom values are also legal.</p>
       
    66 </li></ul>
       
    67 
       
    68 <p>
       
    69 On the system model, forward dependencies are show in black, and reverse dependencies in blue.
       
    70 The arrowhead always points to the item it's dependent on, ie the one in <code>&lt;dep&gt;</code>.
       
    71 
       
    72 
       
    73 Only <code>api</code>  and <code>ecom</code> have special line types. All other dependencies show up as solid lines.
       
    74 	  </p><div class="Figure">
       
    75 		<p class="Image"><img src="arrows.png" alt=""  border="0"/></p><br clear="all"/>
       
    76 	  </div>
       
    77 
       
    78 <p>
       
    79 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. 
       
    80 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:
       
    81 </p><div class="Example">
       
    82 <code class="css">
       
    83 	path.cr {<div class="indent">stroke-dasharray: 9, 3, 5, 3;</div>}
       
    84 <code></div>
       
    85 
       
    86 
       
    87 
       
    88 <div class="section">
       
    89 <h2> See also</h2><p>
       
    90 		<a href="Model-XMLFile.html#ModelXMLFile">Model XML File</a> 
       
    91 	  </p><p>
       
    92 		<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> 
       
    93 	  </p><p>
       
    94 		<a href="Levels-XMLFile.html#LevelsXMLFile">Levels XML File</a> 
       
    95 	  </p><p>
       
    96 		<a href="Localisation-XMLFile.html#Localisation">Localization XML File</a> 
       
    97 	  </p><p>
       
    98 		<a href="System-Info-XMLFile.html#SystemInfoXML">SystemInfo XML File</a> 
       
    99 	  </p><p>
       
   100 		<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> 
       
   101 	  </p></div>
       
   102 </div>
       
   103 
       
   104                                     </div>
       
   105                                     <div id="printer_copyright">
       
   106                                         <div id="printer_copyright_padding">
       
   107                                             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>
       
   108                                         </div>
       
   109                                     </div>
       
   110                                 </div>
       
   111 			    </div>
       
   112 			</div>
       
   113 		    </td>
       
   114 		</tr>
       
   115 	    </table>
       
   116 	    <div style="clear: both"></div>
       
   117 	</div>
       
   118 	<div id="includedFooter">
       
   119 	    <div id="devnet_footer">
       
   120             <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>
       
   121             <div id='BUILD_VERSION'></div>
       
   122 	    </div>
       
   123 	</div>
       
   124 </body>
       
   125 </html>