atria-tools/lutin
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
lutin/classlutin_1_1system_1_1_system.html

660 lines
29 KiB
HTML
Raw Permalink Normal View History

[DOC] update doc for 2.0.0 lutin
2016-09-09 23:00:43 +02:00
<!-- HTML header for doxygen 1.8.8-->
<!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="X-UA-Compatible" content="IE=edge">
<!-- For Mobile Devices -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<title>lutin: build system and packager: lutin.system.System Class Reference</title>
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
<script type="text/javascript" src="doxy-boot.js"></script>
</head>
<body>
[DOC] update doc to 2.2.0
2016-10-23 14:12:30 +02:00
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
[DOC] update doc for 2.0.0 lutin
2016-09-09 23:00:43 +02:00
<div class="container">
<div class="navbar-header">
[DOC] update doc to 2.2.0
2016-10-23 14:12:30 +02:00
<a class="navbar-brand">lutin: build system and packager 2.2.0</a>
[DOC] update doc for 2.0.0 lutin
2016-09-09 23:00:43 +02:00
</div>
[DOC] update doc to 2.2.0
2016-10-23 14:12:30 +02:00
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="index.html">Main&nbsp;Page</a></li>
<li><a href="pages.html">Related&nbsp;Pages</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="annotated.html">Classes</a></li>
<li><a href="files.html">Files</a></li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
Link-libs<span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="http://HeeroYui.github.io/lutin">lutin</a></li>
<li><a href="http://atria-soft.github.io/ewol">ewol</a></li>
<li><a href="http://atria-soft.github.io/etk">etk</a></li>
<li><a href="http://atria-soft.github.io/ejson">ejson</a></li>
<li><a href="http://atria-soft.github.io/exml">exml</a></li>
<li><a href="http://atria-soft.github.io/esvg">esvg</a></li>
<li><a href="http://atria-soft.github.io/egami">egami</a></li>
<li><a href="http://atria-soft.github.io/gale">gale</a></li>
<li><a href="http://atria-soft.github.io/ege">ege</a></li>
<li><a href="http://atria-soft.github.io/elog">elog</a></li>
<li><a href="http://atria-soft.github.io/ememory">ememory</a></li>
<li><a href="http://atria-soft.github.io/enet">enet</a></li>
<li><a href="http://atria-soft.github.io/eproperty">eproperty</a></li>
<li><a href="http://atria-soft.github.io/esignal">esignal</a></li>
<li><a href="http://atria-soft.github.io/zeus">zeus</a></li>
<li><a href="http://atria-soft.github.io/audio-ess">audio-ess</a></li>
<li><a href="http://musicdsp.github.io/audio">audio</a></li>
<li><a href="http://musicdsp.github.io/audio-drain">audio-drain</a></li>
<li><a href="http://musicdsp.github.io/audio-orchestra">audio-orchestra</a></li>
<li><a href="http://musicdsp.github.io/audio-river">audio-river</a></li>
</ul>
</li>
</ul>
<div id="search-box" class="input-group">
<div class="input-group-btn">
<button aria-expanded="false" type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
<span class="glyphicon glyphicon-search"></span>
<span class="caret"></span>
</button>
<ul class="dropdown-menu">
<li><a href="#">All</a></li>
<li><a href="#">Classes</a></li>
<li><a href="#">Namespaces</a></li>
<li><a href="#">Files</a></li>
<li><a href="#">Functions</a></li>
<li><a href="#">Variables</a></li>
<li><a href="#">Typedefs</a></li>
<li><a href="#">Enumerations</a></li>
<li><a href="#">Enumerator</a></li>
<li><a href="#">Friends</a></li>
<li><a href="#">Macros</a></li>
<li><a href="#">Pages</a></li>
</ul>
</div>
<button id="search-close" type="button" class="close" aria-label="Close">
<span aria-hidden="true"></span>
</button>
<input id="search-field" class="form-control" accesskey="S" onkeydown="searchBox.OnSearchFieldChange(event);" placeholder="Search ..." type="text">
</div>
</div><!--/.nav-collapse -->
[DOC] update doc for 2.0.0 lutin
2016-09-09 23:00:43 +02:00
</div>
</nav>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="content" id="content">
<div class="container">
<div class="row">
<div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;">
<div style="margin-bottom: 15px;">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>lutin</b></li><li class="navelem"><b>system</b></li><li class="navelem"><a class="el" href="classlutin_1_1system_1_1_system.html">System</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classlutin_1_1system_1_1_system-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">lutin.system.System Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a26a93f3f40e8d50a1784f2a92ca7d470"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1system_1_1_system.html#a26a93f3f40e8d50a1784f2a92ca7d470">set_help</a> (self, help)</td></tr>
<tr class="separator:a26a93f3f40e8d50a1784f2a92ca7d470"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a426ea23194eb044b734e0f2bb0cfe826"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1system_1_1_system.html#a426ea23194eb044b734e0f2bb0cfe826">get_help</a> (self)</td></tr>
<tr class="separator:a426ea23194eb044b734e0f2bb0cfe826"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c0b751b0cea0e48dd08c87ca5b6c945"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1system_1_1_system.html#a3c0b751b0cea0e48dd08c87ca5b6c945">set_valid</a> (self, state)</td></tr>
<tr class="separator:a3c0b751b0cea0e48dd08c87ca5b6c945"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3107995d8cc7ce9f3b1e333412d6b1d"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1system_1_1_system.html#af3107995d8cc7ce9f3b1e333412d6b1d">get_valid</a> (self)</td></tr>
<tr class="separator:af3107995d8cc7ce9f3b1e333412d6b1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac45876099397ad836da323b53a2978e7"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1system_1_1_system.html#ac45876099397ad836da323b53a2978e7">add_sources</a> (self, list)</td></tr>
<tr class="separator:ac45876099397ad836da323b53a2978e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8273f51c134a5e65e98584adca6cde31"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1system_1_1_system.html#a8273f51c134a5e65e98584adca6cde31">add_path</a> (self, list)</td></tr>
<tr class="separator:a8273f51c134a5e65e98584adca6cde31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0340bf88c6e379594a8c8e3538781ae6"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1system_1_1_system.html#a0340bf88c6e379594a8c8e3538781ae6">add_depend</a> (self, list)</td></tr>
<tr class="separator:a0340bf88c6e379594a8c8e3538781ae6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c3db2b80fbffce2b90c8420610340d5"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1system_1_1_system.html#a6c3db2b80fbffce2b90c8420610340d5">add_flag</a> (self, type, list)</td></tr>
<tr class="separator:a6c3db2b80fbffce2b90c8420610340d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ab9d305b56a610223e030f134a6cbaa"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1system_1_1_system.html#a7ab9d305b56a610223e030f134a6cbaa">set_version</a> (self, version_list)</td></tr>
<tr class="separator:a7ab9d305b56a610223e030f134a6cbaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d8eec2c8427654f86530198e5c47c8d"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1system_1_1_system.html#a3d8eec2c8427654f86530198e5c47c8d">add_action</a> (self, name_of_state=&quot;PACKAGE&quot;, level=5, name=&quot;no-name&quot;, action=None)</td></tr>
<tr class="separator:a3d8eec2c8427654f86530198e5c47c8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2527e12feaa3fd34acd8f96aa39bf057"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1system_1_1_system.html#a2527e12feaa3fd34acd8f96aa39bf057">add_header_file</a> (self, list, destination_path=None, clip_path=None, recursive=False)</td></tr>
<tr class="separator:a2527e12feaa3fd34acd8f96aa39bf057"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d69133ba8701a2b95ab6de41779bc96"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlutin_1_1system_1_1_system.html#a2d69133ba8701a2b95ab6de41779bc96">configure_module</a> (self, target, module)</td></tr>
<tr class="separator:a2d69133ba8701a2b95ab6de41779bc96"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classlutin_1_1system_1_1_system.html" title="System class represent the pre-build Module that are already install and accessible in the system env...">System</a> class represent the pre-build Module that are already install and accessible in the system environment. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a3d8eec2c8427654f86530198e5c47c8d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lutin.system.System.add_action </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>name_of_state</em> = <code>&quot;PACKAGE&quot;</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>level</em> = <code>5</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>name</em> = <code>&quot;no-name&quot;</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>action</em> = <code>None</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p></p>
</div>
</div>
<a class="anchor" id="a0340bf88c6e379594a8c8e3538781ae6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lutin.system.System.add_depend </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>list</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a dependency on this module. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">self</td><td>(handle) Class handle </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">list</td><td>([string,...] or string) Name(s) of the modules dependency </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="a6c3db2b80fbffce2b90c8420610340d5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lutin.system.System.add_flag </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>list</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add compilation flags. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">self</td><td>(handle) Class handle </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>(string) inclusion group name 'c', 'c++', 'java' ... </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">list</td><td>([string,...] or string) List of path to include </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="a2527e12feaa3fd34acd8f96aa39bf057"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lutin.system.System.add_header_file </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>destination_path</em> = <code>None</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>clip_path</em> = <code>None</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>recursive</em> = <code>False</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p></p>
</div>
</div>
<a class="anchor" id="a8273f51c134a5e65e98584adca6cde31"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lutin.system.System.add_path </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>list</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add include path of the sources. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">self</td><td>(handle) Class handle </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">list</td><td>([string,...]) List of all path to add in the -I include element </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<p>todo : add other than C ... </p>
</div>
</div>
<a class="anchor" id="ac45876099397ad836da323b53a2978e7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lutin.system.System.add_sources </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>list</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add source element. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">self</td><td>(handle) Class handle </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">list</td><td>([string,...]) List of all Files to add. ex: *.a, *.so ... </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="a2d69133ba8701a2b95ab6de41779bc96"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lutin.system.System.configure_module </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>module</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure a module with internal datas. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">self</td><td>(handle) Class handle </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">target</td><td>(handle) lutin.module.Target handle </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">module</td><td>(handle) <a class="el" href="classlutin_1_1module_1_1_module.html">lutin.module.Module</a> handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="a426ea23194eb044b734e0f2bb0cfe826"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lutin.system.System.get_help </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the help of this system Module. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">self</td><td>(handle) Class handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>(string) Help for the user </dd></dl>
</div>
</div>
<a class="anchor" id="af3107995d8cc7ce9f3b1e333412d6b1d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lutin.system.System.get_valid </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get validity state of the system Module. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">self</td><td>(handle) Class handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>(bool) New valididty state of the system module </dd></dl>
</div>
</div>
<a class="anchor" id="a26a93f3f40e8d50a1784f2a92ca7d470"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lutin.system.System.set_help </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>help</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the help of this system Module. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">self</td><td>(handle) Class handle </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">help</td><td>(string) Help for the user </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="a3c0b751b0cea0e48dd08c87ca5b6c945"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lutin.system.System.set_valid </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>state</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set validity state of the system Module. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">self</td><td>(handle) Class handle </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>(bool) New valididty state of the system module </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="a7ab9d305b56a610223e030f134a6cbaa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lutin.system.System.set_version </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>version_list</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set version of the module. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">self</td><td>(handle) Class handle </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">version_list</td><td>([int,...]) Ids of the version. ex: [1,2,5] or [0,8,"dev"] </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>lutin/lutin/system.py</li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
[DOC] update doc to 2.2.0
2016-10-23 14:12:30 +02:00
Generated on Sun Oct 23 2016 14:08:32 for lutin: build system and packager by &#160;<a href="http://www.doxygen.org/index.html">
[DOC] update doc for 2.0.0 lutin
2016-09-09 23:00:43 +02:00
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
Reference in New Issue Copy Permalink