/usr/share/doc/libcpl-doc/html/struct__cpl__recipe__.html is in libcpl-doc 5.3.1-1.
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 | <!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="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Common Pipeline Library Reference Manual: _cpl_recipe_ Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Common Pipeline Library Reference Manual
 <span id="projectnumber">5.3.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> </div>
<div class="headertitle">
<div class="title">_cpl_recipe_ Struct Reference<div class="ingroups"><a class="el" href="group__cpl__recipe.html">Recipes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="_cpl_recipe_" -->
<p>The type representation of the recipe plugin interface.
<a href="struct__cpl__recipe__.html#details">More...</a></p>
<p><a href="struct__cpl__recipe__-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__cpl__recipe__.html#a0aa1af9cd0d279dee08ab991d6accf3e">frames</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to a frame set, or <code>NULL</code> if no frame set is available. <a href="#a0aa1af9cd0d279dee08ab991d6accf3e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__plugin.html#ga09a4c68c3a34da3b18b8b0236be15a6f">cpl_plugin</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__cpl__recipe__.html#a0501a784ca75a0a8af4dedcfc511fb5c">interface</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generic plugin interface. <a href="#a0501a784ca75a0a8af4dedcfc511fb5c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__parameterlist.html#gaa9c8a14c0aa89145ed8f6381d07e6c17">cpl_parameterlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__cpl__recipe__.html#a92cc72b42d99943bba4ca2ec5a2a20b2">parameters</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the recipes parameter list, or <code>NULL</code> if the recipe does not provide/accept any parameters. <a href="#a92cc72b42d99943bba4ca2ec5a2a20b2"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The type representation of the recipe plugin interface. </p>
</div><hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a0aa1af9cd0d279dee08ab991d6accf3e"></a><!-- doxytag: member="_cpl_recipe_::frames" ref="a0aa1af9cd0d279dee08ab991d6accf3e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a>* <a class="el" href="struct__cpl__recipe__.html#a0aa1af9cd0d279dee08ab991d6accf3e">_cpl_recipe_::frames</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pointer to a frame set, or <code>NULL</code> if no frame set is available. </p>
<p>This member points to the frame set (see <a class="el" href="group__cpl__frameset.html">Frame Sets</a>) the recipe should process. The frame set to process has to be provided by the application which is going to execute this recipe, i.e. this member has to be set by the application.</p>
<p>The recipe can rely on the availability of the frame set at the time the application executes the recipe by calling <a class="el" href="struct__cpl__plugin__.html#a609f914f455c448fcee26938696df624" title="Executes a plugin instance.">_cpl_plugin_::execute</a>. The recipe is free to ignore a provided frame set if it does not need any input frames. </p>
</div>
</div>
<a class="anchor" id="a0501a784ca75a0a8af4dedcfc511fb5c"></a><!-- doxytag: member="_cpl_recipe_::interface" ref="a0501a784ca75a0a8af4dedcfc511fb5c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__plugin.html#ga09a4c68c3a34da3b18b8b0236be15a6f">cpl_plugin</a> <a class="el" href="struct__cpl__recipe__.html#a0501a784ca75a0a8af4dedcfc511fb5c">_cpl_recipe_::interface</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Generic plugin interface. </p>
<p>See the <a class="el" href="group__cpl__plugin.html">Plugin Interface</a> documentation for a detailed description. </p>
</div>
</div>
<a class="anchor" id="a92cc72b42d99943bba4ca2ec5a2a20b2"></a><!-- doxytag: member="_cpl_recipe_::parameters" ref="a92cc72b42d99943bba4ca2ec5a2a20b2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__parameterlist.html#gaa9c8a14c0aa89145ed8f6381d07e6c17">cpl_parameterlist</a>* <a class="el" href="struct__cpl__recipe__.html#a92cc72b42d99943bba4ca2ec5a2a20b2">_cpl_recipe_::parameters</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pointer to the recipes parameter list, or <code>NULL</code> if the recipe does not provide/accept any parameters. </p>
<p>This member points to a <code>cpl_parameterlist</code>, containing all parameters the recipe accepts, or <code>NULL</code> if the recipe does not need any parameters for execution.</p>
<p>An application which wants to execute the recipe may update this list with new parameter values, obtained from the command line for instance. </p>
</div>
</div>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Dec 29 2011 09:56:20 for Common Pipeline Library Reference Manual by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>
|