/usr/share/gtk-doc/html/libplanner/libplanner-mrp-relation.html is in planner-doc 0.14.6-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MrpRelation</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Libplanner Reference Manual">
<link rel="up" href="ch01.html" title="Libplanner API">
<link rel="prev" href="libplanner-mrp-project.html" title="MrpProject">
<link rel="next" href="libplanner-mrp-resource.html" title="MrpResource">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libplanner-mrp-project.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libplanner Reference Manual</th>
<td><a accesskey="n" href="libplanner-mrp-resource.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libplanner-mrp-relation.synopsis" class="shortcut">Top</a>
|
<a href="#libplanner-mrp-relation.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libplanner-mrp-relation"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libplanner-mrp-relation.top_of_page"></a>MrpRelation</span></h2>
<p>MrpRelation — represents a task predecessor relation in the project.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libplanner-mrp-relation.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libplanner/planner.h>
<a class="link" href="libplanner-mrp-relation.html#MrpRelationPriv" title="MrpRelationPriv">MrpRelationPriv</a>;
struct <a class="link" href="libplanner-mrp-relation.html#MrpRelation" title="struct MrpRelation">MrpRelation</a>;
enum <a class="link" href="libplanner-mrp-relation.html#MrpRelationType" title="enum MrpRelationType">MrpRelationType</a>;
<a class="link" href="libplanner-mrp-task.html#MrpTask"><span class="returnvalue">MrpTask</span></a> * <a class="link" href="libplanner-mrp-relation.html#mrp-relation-get-predecessor" title="mrp_relation_get_predecessor ()">mrp_relation_get_predecessor</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-relation.html#MrpRelation" title="struct MrpRelation"><span class="type">MrpRelation</span></a> *relation</code></em>);
<a class="link" href="libplanner-mrp-task.html#MrpTask"><span class="returnvalue">MrpTask</span></a> * <a class="link" href="libplanner-mrp-relation.html#mrp-relation-get-successor" title="mrp_relation_get_successor ()">mrp_relation_get_successor</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-relation.html#MrpRelation" title="struct MrpRelation"><span class="type">MrpRelation</span></a> *relation</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="libplanner-mrp-relation.html#mrp-relation-get-lag" title="mrp_relation_get_lag ()">mrp_relation_get_lag</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-relation.html#MrpRelation" title="struct MrpRelation"><span class="type">MrpRelation</span></a> *relation</code></em>);
<a class="link" href="libplanner-mrp-relation.html#MrpRelationType" title="enum MrpRelationType"><span class="returnvalue">MrpRelationType</span></a> <a class="link" href="libplanner-mrp-relation.html#mrp-relation-get-relation-type" title="mrp_relation_get_relation_type ()">mrp_relation_get_relation_type</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-relation.html#MrpRelation" title="struct MrpRelation"><span class="type">MrpRelation</span></a> *relation</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libplanner-mrp-relation.description"></a><h2>Description</h2>
<p>
A predecessor relation is used to affect the scheduling of a task
relative another task. A relation may have a lag time associated to it,
so that a task can be scheduled to start after another task has
finished, plus a lag time.
</p>
</div>
<div class="refsect1">
<a name="libplanner-mrp-relation.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="MrpRelationPriv"></a><h3>MrpRelationPriv</h3>
<pre class="programlisting">typedef struct _MrpRelationPriv MrpRelationPriv;</pre>
<p>
A private struct for internal use only. The definition of this
structure is not publically available.
</p>
</div>
<hr>
<div class="refsect2">
<a name="MrpRelation"></a><h3>struct MrpRelation</h3>
<pre class="programlisting">struct MrpRelation {
MrpObject parent;
MrpRelationPriv *priv;
};
</pre>
<p>
Object representing a predecessor relation between two tasks.
</p>
</div>
<hr>
<div class="refsect2">
<a name="MrpRelationType"></a><h3>enum MrpRelationType</h3>
<pre class="programlisting">typedef enum {
MRP_RELATION_NONE = 0, /* unset */
MRP_RELATION_FS, /* finish-to-start */
MRP_RELATION_FF, /* finish-to-finish */
MRP_RELATION_SS, /* start-to-start */
MRP_RELATION_SF /* start-to-finish */
} MrpRelationType;
</pre>
<p>
The type of relation.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="MRP-RELATION-NONE:CAPS"></a><span class="term"><code class="literal">MRP_RELATION_NONE</code></span></p></td>
<td>invalid relation type (unset)
</td>
</tr>
<tr>
<td><p><a name="MRP-RELATION-FS:CAPS"></a><span class="term"><code class="literal">MRP_RELATION_FS</code></span></p></td>
<td>finish to start
</td>
</tr>
<tr>
<td><p><a name="MRP-RELATION-FF:CAPS"></a><span class="term"><code class="literal">MRP_RELATION_FF</code></span></p></td>
<td>finish to finish (unimplemented)
</td>
</tr>
<tr>
<td><p><a name="MRP-RELATION-SS:CAPS"></a><span class="term"><code class="literal">MRP_RELATION_SS</code></span></p></td>
<td>start to start (unimplemented)
</td>
</tr>
<tr>
<td><p><a name="MRP-RELATION-SF:CAPS"></a><span class="term"><code class="literal">MRP_RELATION_SF</code></span></p></td>
<td>start to finish (unimplemented)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-relation-get-predecessor"></a><h3>mrp_relation_get_predecessor ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-task.html#MrpTask"><span class="returnvalue">MrpTask</span></a> * mrp_relation_get_predecessor (<em class="parameter"><code><a class="link" href="libplanner-mrp-relation.html#MrpRelation" title="struct MrpRelation"><span class="type">MrpRelation</span></a> *relation</code></em>);</pre>
<p>
Retrieves the predecessor of <em class="parameter"><code>relation</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>relation</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-relation.html#MrpRelation" title="struct MrpRelation"><span class="type">MrpRelation</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the predecessor task.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-relation-get-successor"></a><h3>mrp_relation_get_successor ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-task.html#MrpTask"><span class="returnvalue">MrpTask</span></a> * mrp_relation_get_successor (<em class="parameter"><code><a class="link" href="libplanner-mrp-relation.html#MrpRelation" title="struct MrpRelation"><span class="type">MrpRelation</span></a> *relation</code></em>);</pre>
<p>
Retrieves the successor of <em class="parameter"><code>relation</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>relation</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-relation.html#MrpRelation" title="struct MrpRelation"><span class="type">MrpRelation</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the successor task.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-relation-get-lag"></a><h3>mrp_relation_get_lag ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> mrp_relation_get_lag (<em class="parameter"><code><a class="link" href="libplanner-mrp-relation.html#MrpRelation" title="struct MrpRelation"><span class="type">MrpRelation</span></a> *relation</code></em>);</pre>
<p>
Retrieves the lag between the predecessor and successor in <em class="parameter"><code>relation</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>relation</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-relation.html#MrpRelation" title="struct MrpRelation"><span class="type">MrpRelation</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Lag time in seconds.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-relation-get-relation-type"></a><h3>mrp_relation_get_relation_type ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-relation.html#MrpRelationType" title="enum MrpRelationType"><span class="returnvalue">MrpRelationType</span></a> mrp_relation_get_relation_type (<em class="parameter"><code><a class="link" href="libplanner-mrp-relation.html#MrpRelation" title="struct MrpRelation"><span class="type">MrpRelation</span></a> *relation</code></em>);</pre>
<p>
Retrieves the relation type of <em class="parameter"><code>relation</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>relation</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-relation.html#MrpRelation" title="struct MrpRelation"><span class="type">MrpRelation</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="libplanner-mrp-relation.html#MrpRelationType" title="enum MrpRelationType"><span class="type">MrpRelationType</span></a> of the relation.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|