/usr/share/gtk-doc/html/libplanner/libplanner-mrp-assignment.html is in planner-doc 0.14.6-4.
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 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Libplanner Reference Manual: MrpAssignment</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-application.html" title="MrpApplication">
<link rel="next" href="libplanner-mrp-calendar.html" title="MrpCalendar">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libplanner-mrp-assignment.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#libplanner-mrp-assignment.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#libplanner-mrp-assignment.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libplanner-mrp-application.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libplanner-mrp-calendar.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libplanner-mrp-assignment"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libplanner-mrp-assignment.top_of_page"></a>MrpAssignment</span></h2>
<p>MrpAssignment</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libplanner-mrp-assignment.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="libplanner-mrp-assignment.html#MrpAssignment"><span class="returnvalue">MrpAssignment</span></a> *
</td>
<td class="function_name">
<a class="link" href="libplanner-mrp-assignment.html#mrp-assignment-new" title="mrp_assignment_new ()">mrp_assignment_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libplanner-mrp-task.html#MrpTask"><span class="returnvalue">MrpTask</span></a> *
</td>
<td class="function_name">
<a class="link" href="libplanner-mrp-assignment.html#mrp-assignment-get-task" title="mrp_assignment_get_task ()">mrp_assignment_get_task</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libplanner-mrp-resource.html#MrpResource"><span class="returnvalue">MrpResource</span></a> *
</td>
<td class="function_name">
<a class="link" href="libplanner-mrp-assignment.html#mrp-assignment-get-resource" title="mrp_assignment_get_resource ()">mrp_assignment_get_resource</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="libplanner-mrp-assignment.html#mrp-assignment-get-units" title="mrp_assignment_get_units ()">mrp_assignment_get_units</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libplanner-mrp-assignment.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="libplanner-mrp-resource.html#MrpResource"><span class="type">MrpResource</span></a> *</td>
<td class="property_name"><a class="link" href="libplanner-mrp-assignment.html#MrpAssignment--resource" title="The “resource” property">resource</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="libplanner-mrp-task.html#MrpTask"><span class="type">MrpTask</span></a> *</td>
<td class="property_name"><a class="link" href="libplanner-mrp-assignment.html#MrpAssignment--task" title="The “task” property">task</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="libplanner-mrp-assignment.html#MrpAssignment--units" title="The “units” property">units</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<a name="MrpAssignment"></a><div class="refsect1">
<a name="libplanner-mrp-assignment.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libplanner-mrp-assignment.html#MrpAssignmentPriv" title="MrpAssignmentPriv">MrpAssignmentPriv</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libplanner-mrp-assignment.html#MrpAssignment-struct" title="MrpAssignment">MrpAssignment</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libplanner-mrp-assignment.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> <a class="link" href="libplanner-mrp-object.html#MrpObject">MrpObject</a>
<span class="lineart">╰──</span> MrpAssignment
</pre>
</div>
<div class="refsect1">
<a name="libplanner-mrp-assignment.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libplanner/planner.h>
</pre>
</div>
<div class="refsect1">
<a name="libplanner-mrp-assignment.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libplanner-mrp-assignment.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="mrp-assignment-new"></a><h3>mrp_assignment_new ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-assignment.html#MrpAssignment"><span class="returnvalue">MrpAssignment</span></a> *
mrp_assignment_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new, empty, assignment. You most often don't want to create an
assignment explicitly like this, but using <a class="link" href="libplanner-mrp-resource.html#mrp-resource-assign" title="mrp_resource_assign ()"><code class="function">mrp_resource_assign()</code></a> instead.</p>
<div class="refsect3">
<a name="id-1.2.3.10.2.5"></a><h4>Returns</h4>
<p> Newly created assignment.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-assignment-get-task"></a><h3>mrp_assignment_get_task ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-task.html#MrpTask"><span class="returnvalue">MrpTask</span></a> *
mrp_assignment_get_task (<em class="parameter"><code><a class="link" href="libplanner-mrp-assignment.html#MrpAssignment"><span class="type">MrpAssignment</span></a> *assignment</code></em>);</pre>
<p>Retrieves the <a class="link" href="libplanner-mrp-task.html#MrpTask"><span class="type">MrpTask</span></a> associated with <em class="parameter"><code>assignment</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.3.10.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>assignment</p></td>
<td class="parameter_description"><p>an <a class="link" href="libplanner-mrp-assignment.html#MrpAssignment"><span class="type">MrpAssignment</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.10.3.6"></a><h4>Returns</h4>
<p> the task associated with the assignment object. The reference
count of the task is not increased.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-assignment-get-resource"></a><h3>mrp_assignment_get_resource ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-resource.html#MrpResource"><span class="returnvalue">MrpResource</span></a> *
mrp_assignment_get_resource (<em class="parameter"><code><a class="link" href="libplanner-mrp-assignment.html#MrpAssignment"><span class="type">MrpAssignment</span></a> *assignment</code></em>);</pre>
<p>Retrieves the <a class="link" href="libplanner-mrp-resource.html#MrpResource"><span class="type">MrpResource</span></a> associated with <em class="parameter"><code>assignment</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.3.10.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>assignment</p></td>
<td class="parameter_description"><p>an <a class="link" href="libplanner-mrp-assignment.html#MrpAssignment"><span class="type">MrpAssignment</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.10.4.6"></a><h4>Returns</h4>
<p> the resource associated with the assignment object. The reference
count of the resource is not increased.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-assignment-get-units"></a><h3>mrp_assignment_get_units ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
mrp_assignment_get_units (<em class="parameter"><code><a class="link" href="libplanner-mrp-assignment.html#MrpAssignment"><span class="type">MrpAssignment</span></a> *assignment</code></em>);</pre>
<p>Retrieves the number of units that the resource is assigned with to the
task. 100 means 100%, etc.</p>
<div class="refsect3">
<a name="id-1.2.3.10.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>assignment</p></td>
<td class="parameter_description"><p>an <a class="link" href="libplanner-mrp-assignment.html#MrpAssignment"><span class="type">MrpAssignment</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.10.5.6"></a><h4>Returns</h4>
<p> number of units of the assignment.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libplanner-mrp-assignment.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MrpAssignmentPriv"></a><h3>MrpAssignmentPriv</h3>
<pre class="programlisting">typedef struct _MrpAssignmentPriv MrpAssignmentPriv;</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="MrpAssignment-struct"></a><h3>MrpAssignment</h3>
<pre class="programlisting">typedef struct _MrpAssignment MrpAssignment;</pre>
<p>
Represents an assignment, i.e. the assignment of a task to a resource.
</p>
</div>
</div>
<div class="refsect1">
<a name="libplanner-mrp-assignment.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="MrpAssignment--resource"></a><h3>The <code class="literal">“resource”</code> property</h3>
<pre class="programlisting"> “resource” <a class="link" href="libplanner-mrp-resource.html#MrpResource"><span class="type">MrpResource</span></a> *</pre>
<p>The resource that is assigned to the task.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="MrpAssignment--task"></a><h3>The <code class="literal">“task”</code> property</h3>
<pre class="programlisting"> “task” <a class="link" href="libplanner-mrp-task.html#MrpTask"><span class="type">MrpTask</span></a> *</pre>
<p>The task.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="MrpAssignment--units"></a><h3>The <code class="literal">“units”</code> property</h3>
<pre class="programlisting"> “units” <span class="type">gint</span></pre>
<p>Number of units assignment.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= -1</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|