/usr/share/doc/libcpl-doc/html/group__cpl__recipeconfig.html is in libcpl-doc 6.5-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 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 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 | <!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"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Common Pipeline Library Reference Manual: Recipe Configurations</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="cpl.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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">6.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Recipe Configurations</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga764b696f0fcd396164ccf19a3e0a6a19"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipeconfig.html#ga764b696f0fcd396164ccf19a3e0a6a19">cpl_recipeconfig_clear</a> (cpl_recipeconfig *self)</td></tr>
<tr class="memdesc:ga764b696f0fcd396164ccf19a3e0a6a19"><td class="mdescLeft"> </td><td class="mdescRight">Clear a recipe configuration object. <a href="#ga764b696f0fcd396164ccf19a3e0a6a19">More...</a><br/></td></tr>
<tr class="separator:ga764b696f0fcd396164ccf19a3e0a6a19"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6d8b0a683aa40b57d1b0861eaf7d9b8d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipeconfig.html#ga6d8b0a683aa40b57d1b0861eaf7d9b8d">cpl_recipeconfig_delete</a> (cpl_recipeconfig *self)</td></tr>
<tr class="memdesc:ga6d8b0a683aa40b57d1b0861eaf7d9b8d"><td class="mdescLeft"> </td><td class="mdescRight">Delete a recipe configuration object. <a href="#ga6d8b0a683aa40b57d1b0861eaf7d9b8d">More...</a><br/></td></tr>
<tr class="separator:ga6d8b0a683aa40b57d1b0861eaf7d9b8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6e89a511f8290dfe819519e2f3d0c494"><td class="memItemLeft" align="right" valign="top">char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipeconfig.html#ga6e89a511f8290dfe819519e2f3d0c494">cpl_recipeconfig_get_inputs</a> (const cpl_recipeconfig *self, const char *tag)</td></tr>
<tr class="memdesc:ga6e89a511f8290dfe819519e2f3d0c494"><td class="mdescLeft"> </td><td class="mdescRight">Get the input configuration for a given tag. <a href="#ga6e89a511f8290dfe819519e2f3d0c494">More...</a><br/></td></tr>
<tr class="separator:ga6e89a511f8290dfe819519e2f3d0c494"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga80676040497ed9b1d7a0241a924be207"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__type.html#gacc431432a4fedf19ec6f7668dda3fbf0">cpl_size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipeconfig.html#ga80676040497ed9b1d7a0241a924be207">cpl_recipeconfig_get_max_count</a> (const cpl_recipeconfig *self, const char *tag, const char *input)</td></tr>
<tr class="memdesc:ga80676040497ed9b1d7a0241a924be207"><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum number of frames for the given configuration and tag. <a href="#ga80676040497ed9b1d7a0241a924be207">More...</a><br/></td></tr>
<tr class="separator:ga80676040497ed9b1d7a0241a924be207"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae6e249f0c278a7162dc963130f34f25c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__type.html#gacc431432a4fedf19ec6f7668dda3fbf0">cpl_size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipeconfig.html#gae6e249f0c278a7162dc963130f34f25c">cpl_recipeconfig_get_min_count</a> (const cpl_recipeconfig *self, const char *tag, const char *input)</td></tr>
<tr class="memdesc:gae6e249f0c278a7162dc963130f34f25c"><td class="mdescLeft"> </td><td class="mdescRight">Get the minimum number of frames for the given configuration and tag. <a href="#gae6e249f0c278a7162dc963130f34f25c">More...</a><br/></td></tr>
<tr class="separator:gae6e249f0c278a7162dc963130f34f25c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac704e6c64c889bef16e1621c375ece3b"><td class="memItemLeft" align="right" valign="top">char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipeconfig.html#gac704e6c64c889bef16e1621c375ece3b">cpl_recipeconfig_get_outputs</a> (const cpl_recipeconfig *self, const char *tag)</td></tr>
<tr class="memdesc:gac704e6c64c889bef16e1621c375ece3b"><td class="mdescLeft"> </td><td class="mdescRight">Get the output configuration for a given tag. <a href="#gac704e6c64c889bef16e1621c375ece3b">More...</a><br/></td></tr>
<tr class="separator:gac704e6c64c889bef16e1621c375ece3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3528069bf6a4247b37befbc790cb927b"><td class="memItemLeft" align="right" valign="top">char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipeconfig.html#ga3528069bf6a4247b37befbc790cb927b">cpl_recipeconfig_get_tags</a> (const cpl_recipeconfig *self)</td></tr>
<tr class="memdesc:ga3528069bf6a4247b37befbc790cb927b"><td class="mdescLeft"> </td><td class="mdescRight">Get the list of supported configuration tags. <a href="#ga3528069bf6a4247b37befbc790cb927b">More...</a><br/></td></tr>
<tr class="separator:ga3528069bf6a4247b37befbc790cb927b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac5ff7c89ca32d3202b2d33489de13702"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipeconfig.html#gac5ff7c89ca32d3202b2d33489de13702">cpl_recipeconfig_is_required</a> (const cpl_recipeconfig *self, const char *tag, const char *input)</td></tr>
<tr class="memdesc:gac5ff7c89ca32d3202b2d33489de13702"><td class="mdescLeft"> </td><td class="mdescRight">Check whether a frame with the given tag is required. <a href="#gac5ff7c89ca32d3202b2d33489de13702">More...</a><br/></td></tr>
<tr class="separator:gac5ff7c89ca32d3202b2d33489de13702"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1089070f3b66bf6b73e49135008de8ac"><td class="memItemLeft" align="right" valign="top">cpl_recipeconfig * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipeconfig.html#ga1089070f3b66bf6b73e49135008de8ac">cpl_recipeconfig_new</a> (void)</td></tr>
<tr class="memdesc:ga1089070f3b66bf6b73e49135008de8ac"><td class="mdescLeft"> </td><td class="mdescRight">Create a new recipe configuration object. <a href="#ga1089070f3b66bf6b73e49135008de8ac">More...</a><br/></td></tr>
<tr class="separator:ga1089070f3b66bf6b73e49135008de8ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad9af0de58c8cb24eca0de642ddd6e4b4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipeconfig.html#gad9af0de58c8cb24eca0de642ddd6e4b4">cpl_recipeconfig_set_input</a> (cpl_recipeconfig *self, const char *tag, const char *input, <a class="el" href="group__cpl__type.html#gacc431432a4fedf19ec6f7668dda3fbf0">cpl_size</a> min_count, <a class="el" href="group__cpl__type.html#gacc431432a4fedf19ec6f7668dda3fbf0">cpl_size</a> max_count)</td></tr>
<tr class="memdesc:gad9af0de58c8cb24eca0de642ddd6e4b4"><td class="mdescLeft"> </td><td class="mdescRight">Add the configuration for the given input and configuration tag. <a href="#gad9af0de58c8cb24eca0de642ddd6e4b4">More...</a><br/></td></tr>
<tr class="separator:gad9af0de58c8cb24eca0de642ddd6e4b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga09c64691443eb83d3dc232dd3fc5db71"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipeconfig.html#ga09c64691443eb83d3dc232dd3fc5db71">cpl_recipeconfig_set_inputs</a> (cpl_recipeconfig *self, const char *tag, const <a class="el" href="group__cpl__framedata.html#gac3d2cda81a762b2f50d4a52ea456f5ec">cpl_framedata</a> *data)</td></tr>
<tr class="memdesc:ga09c64691443eb83d3dc232dd3fc5db71"><td class="mdescLeft"> </td><td class="mdescRight">Set the input configuration for a given tag. <a href="#ga09c64691443eb83d3dc232dd3fc5db71">More...</a><br/></td></tr>
<tr class="separator:ga09c64691443eb83d3dc232dd3fc5db71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf8882d5fdc846fa4c1f469e7bc5eb492"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipeconfig.html#gaf8882d5fdc846fa4c1f469e7bc5eb492">cpl_recipeconfig_set_output</a> (cpl_recipeconfig *self, const char *tag, const char *output)</td></tr>
<tr class="memdesc:gaf8882d5fdc846fa4c1f469e7bc5eb492"><td class="mdescLeft"> </td><td class="mdescRight">Add an output frame tag for the given configuration tag. <a href="#gaf8882d5fdc846fa4c1f469e7bc5eb492">More...</a><br/></td></tr>
<tr class="separator:gaf8882d5fdc846fa4c1f469e7bc5eb492"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7203cc61855953d50e1cfeeb840165ed"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipeconfig.html#ga7203cc61855953d50e1cfeeb840165ed">cpl_recipeconfig_set_outputs</a> (cpl_recipeconfig *self, const char *tag, const char **data)</td></tr>
<tr class="memdesc:ga7203cc61855953d50e1cfeeb840165ed"><td class="mdescLeft"> </td><td class="mdescRight">Set the output configuration for a given tag. <a href="#ga7203cc61855953d50e1cfeeb840165ed">More...</a><br/></td></tr>
<tr class="separator:ga7203cc61855953d50e1cfeeb840165ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae266be82676cbebd2ed7220d4a2d0365"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipeconfig.html#gae266be82676cbebd2ed7220d4a2d0365">cpl_recipeconfig_set_tag</a> (cpl_recipeconfig *self, const char *tag, <a class="el" href="group__cpl__type.html#gacc431432a4fedf19ec6f7668dda3fbf0">cpl_size</a> min_count, <a class="el" href="group__cpl__type.html#gacc431432a4fedf19ec6f7668dda3fbf0">cpl_size</a> max_count)</td></tr>
<tr class="memdesc:gae266be82676cbebd2ed7220d4a2d0365"><td class="mdescLeft"> </td><td class="mdescRight">Set a configuration tag. <a href="#gae266be82676cbebd2ed7220d4a2d0365">More...</a><br/></td></tr>
<tr class="separator:gae266be82676cbebd2ed7220d4a2d0365"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga378e88a23e65e7fb018f761862ae6bcb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__recipeconfig.html#ga378e88a23e65e7fb018f761862ae6bcb">cpl_recipeconfig_set_tags</a> (cpl_recipeconfig *self, const <a class="el" href="group__cpl__framedata.html#gac3d2cda81a762b2f50d4a52ea456f5ec">cpl_framedata</a> *data)</td></tr>
<tr class="memdesc:ga378e88a23e65e7fb018f761862ae6bcb"><td class="mdescLeft"> </td><td class="mdescRight">Set the list of configuration tags. <a href="#ga378e88a23e65e7fb018f761862ae6bcb">More...</a><br/></td></tr>
<tr class="separator:ga378e88a23e65e7fb018f761862ae6bcb"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>This module implements the support for recipe configurations. A recipe configuration stores information about the input data frames a recipe can process, which other input frame are needed in addition, and which output frames may be created by the recipe.</p>
<p>For each input frame extra information, for instance, whether a particular frame type is a required or optional recipe input, or how many frames of a certain type are at least needed, can also be stored.</p>
<p>The information for the individual recipe configurations and also for the individual frames can be accessed by means of a unique string identifier for the configuration and the frame respectively. This string identifier is called configuration tag in the former, and frame tag in the latter case. In particular, the configuration tag is a frame tag too, namely the frame tag of the recipe's "primary" input, or trigger frame.</p>
<p>The recipe configuration object stores a separate configuration for each of the different frame types, indicated by its tag, it is able to process. Each of these configurations can be retrieved, using the appropriate configuration tag as a key.</p>
<p>In the same way the information about individual frames can be retrieved from the selected configuration.</p>
<dl class="section user"><dt>Synopsis:</dt><dd><div class="fragment"><div class="line"><span class="preprocessor">#include <cpl_recipeconfig.h></span></div>
</div><!-- fragment --> </dd></dl>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga764b696f0fcd396164ccf19a3e0a6a19"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cpl_recipeconfig_clear </td>
<td>(</td>
<td class="paramtype">cpl_recipeconfig * </td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear a recipe configuration object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The recipe configuration object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p>The function clears the contents of the recipe configuration <em>self</em>. After the return from this call, <em>self</em> is empty.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__cpl__recipeconfig.html#ga1089070f3b66bf6b73e49135008de8ac" title="Create a new recipe configuration object. ">cpl_recipeconfig_new()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga6d8b0a683aa40b57d1b0861eaf7d9b8d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cpl_recipeconfig_delete </td>
<td>(</td>
<td class="paramtype">cpl_recipeconfig * </td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete a recipe configuration object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The recipe configuration object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p>The function destroys the recipe configuration object <em>self</em>. Any resources used by <em>self</em> are released. If <em>self</em> is <code>NULL</code>, nothing is done and no error is set. </p>
</div>
</div>
<a class="anchor" id="ga6e89a511f8290dfe819519e2f3d0c494"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char** cpl_recipeconfig_get_inputs </td>
<td>(</td>
<td class="paramtype">const cpl_recipeconfig * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>tag</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the input configuration for a given tag. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The recipe configuration object. </td></tr>
<tr><td class="paramname">tag</td><td>The tag for which the input configuration is requested.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>On success, the function returns a <code>NULL</code> terminated array of strings, and <code>NULL</code> if an error occurred. In the latter case an appropriate error code is also set.</dd></dl>
<dl class="exception">
<dt><b>Errors</b></dt>
<dd></dd>
<dt></dt>
<dd><table class="ec" align="center">
<tr>
<td class="ecl">CPL_ERROR_NULL_INPUT </td><td class="ecr">The parameter <em>self</em> or <em>tag</em> is a <code>NULL</code> pointer. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_DATA_NOT_FOUND </td><td class="ecr">The configuration tag <em>tag</em> was not found. </td></tr>
</table>
</dd>
</dl>
<p>The function retrieves the list of input frame tags stored in the recipe configuration for the configuration tag <em>tag</em> from the configuration object <em>self</em>.</p>
<p>In case the input configuration for the tag <em>tag</em> is empty, i.e. no input frame tag has been added the function still returns a C string array. In this case the first element is set to <code>NULL</code>.</p>
<p>The returned array and each of its elements must be deallocated using <a class="el" href="group__cpl__memory.html#ga9cd2b64cbbe05ec9f34fda048184b4d1" title="Memory block deallocation. ">cpl_free()</a> if they are no longer used. The array is <code>NULL</code> terminated, i.e. the last element of the array is set to <code>NULL</code>. </p>
<p>References <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a5b82c7780a2a8a79dfafcac70717b830">CPL_ERROR_DATA_NOT_FOUND</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a7b054cf7927d1bd0a9b3693a6715be84">CPL_ERROR_NULL_INPUT</a>, and <a class="el" href="group__cpl__error.html#gad7cf962bbe59df1b5991b17b1a2361a3">cpl_error_set</a>.</p>
</div>
</div>
<a class="anchor" id="ga80676040497ed9b1d7a0241a924be207"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__type.html#gacc431432a4fedf19ec6f7668dda3fbf0">cpl_size</a> cpl_recipeconfig_get_max_count </td>
<td>(</td>
<td class="paramtype">const cpl_recipeconfig * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>input</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the maximum number of frames for the given configuration and tag. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The recipe configuration object. </td></tr>
<tr><td class="paramname">tag</td><td>The configuration tag to look up. </td></tr>
<tr><td class="paramname">input</td><td>The frame tag to search for.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function returns the maximum number of frames with the tag <em>input</em>, or <code>-1</code>, if an error occurred. In the latter case an appropriate error code is set.</dd></dl>
<dl class="exception">
<dt><b>Errors</b></dt>
<dd></dd>
<dt></dt>
<dd><table class="ec" align="center">
<tr>
<td class="ecl">CPL_ERROR_NULL_INPUT </td><td class="ecr">The parameter <em>self</em>, <em>tag</em> or <em>input</em> is a <code>NULL</code> pointer. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_ILLEGAL_INPUT </td><td class="ecr">The configuration tag <em>tag</em> is <code>NULL</code>, or an invalid string, the empty string for instance. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_DATA_NOT_FOUND </td><td class="ecr">No frame tag <em>tag</em> or <em>input</em> was found, or <em>self</em> was not properly initialized. </td></tr>
</table>
</dd>
</dl>
<p>The function queries the recipe configuration <em>self</em> for the configuration tag <em>tag</em>, searches this configuration for the frame tag <em>input</em> and returns the maximum number of frames required for this frame type.</p>
<p>If the same string is passed as <em>tag</em> and <em>input</em>, the settings for the frame with tag <em>tag</em> are returned. </p>
<p>References <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a5b82c7780a2a8a79dfafcac70717b830">CPL_ERROR_DATA_NOT_FOUND</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a7b054cf7927d1bd0a9b3693a6715be84">CPL_ERROR_NULL_INPUT</a>, <a class="el" href="group__cpl__error.html#gad7cf962bbe59df1b5991b17b1a2361a3">cpl_error_set</a>, and <a class="el" href="struct__cpl__framedata__.html#a5be3540e2e15ddb07f662947ee2f3e4a">_cpl_framedata_::max_count</a>.</p>
</div>
</div>
<a class="anchor" id="gae6e249f0c278a7162dc963130f34f25c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__type.html#gacc431432a4fedf19ec6f7668dda3fbf0">cpl_size</a> cpl_recipeconfig_get_min_count </td>
<td>(</td>
<td class="paramtype">const cpl_recipeconfig * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>input</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the minimum number of frames for the given configuration and tag. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The recipe configuration object. </td></tr>
<tr><td class="paramname">tag</td><td>The configuration tag to look up. </td></tr>
<tr><td class="paramname">input</td><td>The frame tag to search for.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function returns the minimum number of frames with the tag <em>input</em>, or <code>-1</code>, if an error occurred. In the latter case an appropriate error code is set.</dd></dl>
<dl class="exception">
<dt><b>Errors</b></dt>
<dd></dd>
<dt></dt>
<dd><table class="ec" align="center">
<tr>
<td class="ecl">CPL_ERROR_NULL_INPUT </td><td class="ecr">The parameter <em>self</em>, <em>tag</em> or <em>input</em> is a <code>NULL</code> pointer. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_ILLEGAL_INPUT </td><td class="ecr">The configuration tag <em>tag</em> is <code>NULL</code>, or an invalid string, the empty string for instance. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_DATA_NOT_FOUND </td><td class="ecr">No frame tag <em>tag</em> or <em>input</em> was found, or <em>self</em> was not properly initialized. </td></tr>
</table>
</dd>
</dl>
<p>The function queries the recipe configuration <em>self</em> for the configuration tag <em>tag</em>, searches this configuration for the frame tag <em>input</em> and returns the minimum number of frames required for this frame type.</p>
<p>If the same string is passed as <em>tag</em> and <em>input</em>, the settings for the frame with tag <em>tag</em> are returned. </p>
<p>References <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a5b82c7780a2a8a79dfafcac70717b830">CPL_ERROR_DATA_NOT_FOUND</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a7b054cf7927d1bd0a9b3693a6715be84">CPL_ERROR_NULL_INPUT</a>, <a class="el" href="group__cpl__error.html#gad7cf962bbe59df1b5991b17b1a2361a3">cpl_error_set</a>, and <a class="el" href="struct__cpl__framedata__.html#a2c7d54c341203106260bbe386ff58d60">_cpl_framedata_::min_count</a>.</p>
</div>
</div>
<a class="anchor" id="gac704e6c64c889bef16e1621c375ece3b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char** cpl_recipeconfig_get_outputs </td>
<td>(</td>
<td class="paramtype">const cpl_recipeconfig * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>tag</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the output configuration for a given tag. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The recipe configuration object. </td></tr>
<tr><td class="paramname">tag</td><td>The tag for which the ouput configuration is requested.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>On success, the function returns a <code>NULL</code> terminated array of strings, and <code>NULL</code> if an error occurred. In the latter case an appropriate error code is also set.</dd></dl>
<dl class="exception">
<dt><b>Errors</b></dt>
<dd></dd>
<dt></dt>
<dd><table class="ec" align="center">
<tr>
<td class="ecl">CPL_ERROR_NULL_INPUT </td><td class="ecr">The parameter <em>self</em> or <em>tag</em> is a <code>NULL</code> pointer. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_DATA_NOT_FOUND </td><td class="ecr">The configuration tag <em>tag</em> was not found. </td></tr>
</table>
</dd>
</dl>
<p>The function retrieves the list of all possible output frame tags stored in the recipe configuration object <em>self</em> for the configuration tag <em>tag</em>.</p>
<p>In case the output configuration for the tag <em>tag</em> is empty, i.e. no output frame tag has been added the function still returns a C string array. In this case the first element is set to <code>NULL</code>.</p>
<p>The returned array and each of its elements must be deallocated using <a class="el" href="group__cpl__memory.html#ga9cd2b64cbbe05ec9f34fda048184b4d1" title="Memory block deallocation. ">cpl_free()</a> if they are no longer used. The array is <code>NULL</code> terminated, i.e. the last element of the array is set to <code>NULL</code>. </p>
<p>References <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a5b82c7780a2a8a79dfafcac70717b830">CPL_ERROR_DATA_NOT_FOUND</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a7b054cf7927d1bd0a9b3693a6715be84">CPL_ERROR_NULL_INPUT</a>, and <a class="el" href="group__cpl__error.html#gad7cf962bbe59df1b5991b17b1a2361a3">cpl_error_set</a>.</p>
</div>
</div>
<a class="anchor" id="ga3528069bf6a4247b37befbc790cb927b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char** cpl_recipeconfig_get_tags </td>
<td>(</td>
<td class="paramtype">const cpl_recipeconfig * </td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the list of supported configuration tags. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The recipe configuration object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>On success, the function returns a <code>NULL</code> terminated array of strings, and <code>NULL</code> if an error occurred. In the latter case an appropriate error code is also set.</dd></dl>
<dl class="exception">
<dt><b>Errors</b></dt>
<dd></dd>
<dt></dt>
<dd><table class="ec" align="center">
<tr>
<td class="ecl">CPL_ERROR_NULL_INPUT </td><td class="ecr">The parameter <em>self</em> is a <code>NULL</code> pointer. </td></tr>
</table>
</dd>
</dl>
<p>The function retrieves the list of configuration tags stored in the recipe configuration object <em>self</em>. The frame tags are returned as the elements of an array of C strings. The last element of the array is a <code>NULL</code> pointer indicating the end of the list.</p>
<p>In case the recipe configuration object is empty, i.e. no configuration tag has been added, or <a class="el" href="group__cpl__recipeconfig.html#ga764b696f0fcd396164ccf19a3e0a6a19" title="Clear a recipe configuration object. ">cpl_recipeconfig_clear()</a> has been called for this object, the function still returns the C string array. In this case the first element is set to <code>NULL</code>.</p>
<p>If the returned list is not used any more each element, and the array itself must be deallocated using <a class="el" href="group__cpl__memory.html#ga9cd2b64cbbe05ec9f34fda048184b4d1" title="Memory block deallocation. ">cpl_free()</a>. </p>
<p>References <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a7b054cf7927d1bd0a9b3693a6715be84">CPL_ERROR_NULL_INPUT</a>, and <a class="el" href="group__cpl__error.html#gad7cf962bbe59df1b5991b17b1a2361a3">cpl_error_set</a>.</p>
</div>
</div>
<a class="anchor" id="gac5ff7c89ca32d3202b2d33489de13702"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int cpl_recipeconfig_is_required </td>
<td>(</td>
<td class="paramtype">const cpl_recipeconfig * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>input</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether a frame with the given tag is required. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>A recipe configuration object. </td></tr>
<tr><td class="paramname">tag</td><td>The configuration tag to look up. </td></tr>
<tr><td class="paramname">input</td><td>The frame tag to search for.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function returns <code>1</code> if the frame with the tag <em>input</em> is required, and <code>0</code> if the frame is not a required input. If an error occurred <code>-1</code> is returned and an appropriate error code is set.</dd></dl>
<dl class="exception">
<dt><b>Errors</b></dt>
<dd></dd>
<dt></dt>
<dd><table class="ec" align="center">
<tr>
<td class="ecl">CPL_ERROR_NULL_INPUT </td><td class="ecr">The parameter <em>self</em>, <em>tag</em> or <em>input</em> is a <code>NULL</code> pointer. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_ILLEGAL_INPUT </td><td class="ecr">The frame tag <em>tag</em> is <code>NULL</code>, an invalid string, the empty string for instance. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_DATA_NOT_FOUND </td><td class="ecr">No frame tag <em>tag</em> or <em>input</em> was found, or <em>self</em> was not properly initialized. </td></tr>
</table>
</dd>
</dl>
<p>The function queries the recipe configuration <em>self</em> for the configuration tag <em>tag</em> and searches this configuration for the frame tag <em>input</em>. It returns the maximum number of frames required for this frame type.</p>
<p>If the same string is passed as <em>tag</em> and <em>input</em>, the settings for the frame with tag <em>tag</em> are returned. </p>
<p>References <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a5b82c7780a2a8a79dfafcac70717b830">CPL_ERROR_DATA_NOT_FOUND</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a7b054cf7927d1bd0a9b3693a6715be84">CPL_ERROR_NULL_INPUT</a>, <a class="el" href="group__cpl__error.html#gad7cf962bbe59df1b5991b17b1a2361a3">cpl_error_set</a>, and <a class="el" href="struct__cpl__framedata__.html#a2c7d54c341203106260bbe386ff58d60">_cpl_framedata_::min_count</a>.</p>
</div>
</div>
<a class="anchor" id="ga1089070f3b66bf6b73e49135008de8ac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cpl_recipeconfig* cpl_recipeconfig_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new recipe configuration object. </p>
<dl class="section return"><dt>Returns</dt><dd>The function returns a pointer to the newly created recipe configuration.</dd></dl>
<p>The function creates a new, empty recipe configuration object. </p>
</div>
</div>
<a class="anchor" id="gad9af0de58c8cb24eca0de642ddd6e4b4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int cpl_recipeconfig_set_input </td>
<td>(</td>
<td class="paramtype">cpl_recipeconfig * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__cpl__type.html#gacc431432a4fedf19ec6f7668dda3fbf0">cpl_size</a> </td>
<td class="paramname"><em>min_count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__cpl__type.html#gacc431432a4fedf19ec6f7668dda3fbf0">cpl_size</a> </td>
<td class="paramname"><em>max_count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add the configuration for the given input and configuration tag. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The recipe configuration object. </td></tr>
<tr><td class="paramname">tag</td><td>The configuration tag. </td></tr>
<tr><td class="paramname">input</td><td>The input frame tag. </td></tr>
<tr><td class="paramname">min_count</td><td>The value to set as the minimum number of frames. </td></tr>
<tr><td class="paramname">max_count</td><td>The value to set as the maximum number of frames.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function returns <code>0</code> on success and a non-zero value if an error occurred. The return value is <code>-1</code> if <em>self</em>, <em>tag</em> or <em>input</em> is <code>NULL</code>, or, if <em>tag</em> or <em>input</em> is an invalid string. The function returns <code>1</code> if <em>self</em> was not properly initialized using <a class="el" href="group__cpl__recipeconfig.html#gae266be82676cbebd2ed7220d4a2d0365" title="Set a configuration tag. ">cpl_recipeconfig_set_tag()</a> or <a class="el" href="group__cpl__recipeconfig.html#ga378e88a23e65e7fb018f761862ae6bcb" title="Set the list of configuration tags. ">cpl_recipeconfig_set_tags()</a>. If no tag <em>tag</em> is found in <em>self</em> the function returns <code>2</code>. If an error occurs an appropriate error code is also set.</dd></dl>
<dl class="exception">
<dt><b>Errors</b></dt>
<dd></dd>
<dt></dt>
<dd><table class="ec" align="center">
<tr>
<td class="ecl">CPL_ERROR_NULL_INPUT </td><td class="ecr">The parameter <em>self</em>, <em>tag</em> or <em>input</em> is a <code>NULL</code> pointer. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_ILLEGAL_INPUT </td><td class="ecr">The frame tag <em>tag</em> or <em>input</em> is an empty string, or <em>tag</em> and <em>input</em> are equal. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_DATA_NOT_FOUND </td><td class="ecr">No configuration for the tag <em>tag</em> was found, or <em>self</em> was not properly initialized. </td></tr>
</table>
</dd>
</dl>
<p>The function sets the configuration for the input frame tag <em>input</em> of the configuration associated with the tag <em>tag</em> in the recipe configuration object <em>self</em>. The minimum and maximum number of frames of this input frame tag are given using the <em>min_count</em> and <em>max_count</em> arguments. Using a value of <code>-1</code> for the minimum and maximum number of frames, means that these two numbers are unspecified. Using a minimum number <em>min_count</em> greater then <code>0</code> makes the frame a required input.</p>
<p>Before an input configuration can be set using this function, the configuration tag <em>tag</em> must have been added to <em>self</em> previously using <a class="el" href="group__cpl__recipeconfig.html#gae266be82676cbebd2ed7220d4a2d0365" title="Set a configuration tag. ">cpl_recipeconfig_set_tag()</a> or <a class="el" href="group__cpl__recipeconfig.html#ga378e88a23e65e7fb018f761862ae6bcb" title="Set the list of configuration tags. ">cpl_recipeconfig_set_tags()</a>.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__cpl__recipeconfig.html#gae266be82676cbebd2ed7220d4a2d0365" title="Set a configuration tag. ">cpl_recipeconfig_set_tag()</a>, <a class="el" href="group__cpl__recipeconfig.html#ga378e88a23e65e7fb018f761862ae6bcb" title="Set the list of configuration tags. ">cpl_recipeconfig_set_tags()</a> </dd></dl>
<p>References <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a5b82c7780a2a8a79dfafcac70717b830">CPL_ERROR_DATA_NOT_FOUND</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900ae6ab32df318c1af9afcddcb8249cad51">CPL_ERROR_ILLEGAL_INPUT</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a7b054cf7927d1bd0a9b3693a6715be84">CPL_ERROR_NULL_INPUT</a>, <a class="el" href="group__cpl__error.html#gad7cf962bbe59df1b5991b17b1a2361a3">cpl_error_set</a>, <a class="el" href="group__cpl__framedata.html#gace1bf71820e6e35467480fe529c043da">cpl_framedata_create()</a>, and <a class="el" href="group__cpl__framedata.html#ga5a4f4663c8ba2668ee1e1ac2d1a9a39e">cpl_framedata_delete()</a>.</p>
</div>
</div>
<a class="anchor" id="ga09c64691443eb83d3dc232dd3fc5db71"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int cpl_recipeconfig_set_inputs </td>
<td>(</td>
<td class="paramtype">cpl_recipeconfig * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__framedata.html#gac3d2cda81a762b2f50d4a52ea456f5ec">cpl_framedata</a> * </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the input configuration for a given tag. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The recipe configuration object. </td></tr>
<tr><td class="paramname">tag</td><td>The tag for which the input configuration is set. </td></tr>
<tr><td class="paramname">data</td><td>An array containing the configuration informations.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function returns <code>0</code> on success, or a non-zero value otherwise. If <em>self</em> or <em>tag</em> is <code>NULL</code>, or if <em>tag</em> is invalid, i.e. the empty string the function returns <code>-1</code> and sets an appropriate error code. If no configuration tags were previously configured using <a class="el" href="group__cpl__recipeconfig.html#gae266be82676cbebd2ed7220d4a2d0365" title="Set a configuration tag. ">cpl_recipeconfig_set_tag()</a> or <a class="el" href="group__cpl__recipeconfig.html#ga378e88a23e65e7fb018f761862ae6bcb" title="Set the list of configuration tags. ">cpl_recipeconfig_set_tags()</a> the function returns <code>1</code>. If no configuration was found for the given tag <em>tag</em> the return value is <code>2</code>. Finally, if the frame tag to add to the configuration is invalid, the function returns <code>3</code>.</dd></dl>
<dl class="exception">
<dt><b>Errors</b></dt>
<dd></dd>
<dt></dt>
<dd><table class="ec" align="center">
<tr>
<td class="ecl">CPL_ERROR_NULL_INPUT </td><td class="ecr">The parameter <em>self</em> or <em>tag</em> is a <code>NULL</code> pointer. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_ILLEGAL_INPUT </td><td class="ecr">The frame tag <em>tag</em> is an invalid tag, i.e. the empty string or the input frame tag read from <em>data</em> is invalid, or the same as <em>tag</em>. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_DATA_NOT_FOUND </td><td class="ecr">No configuration for the tag <em>tag</em> was found, or <em>self</em> was not properly initialized. </td></tr>
</table>
</dd>
</dl>
<p>The function sets the input configuration for the tag <em>tag</em> in the recipe configuration object <em>self</em>. The minimum and maximum number of frames of this tag can be given using the arguments <em>min_count</em> and <em>max_count</em>. Using a value of <code>-1</code> for the minimum and maximum number of frames, means that these two numbers are unspecified. Using a value greater than <code>0</code> for the minimum number of frames makes the input frame a required frame.</p>
<p>The function sets the configuration data for each input tag specified in the array <em>data</em>, until a tag set to <code>NULL</code> is reached. The array <em>data</em> must contain such an entry as last element, in order to indicate the end of the array.</p>
<p>Before an input configuration can be set using this function, the configuration tag <em>tag</em> must have been added to <em>self</em> previously using <a class="el" href="group__cpl__recipeconfig.html#gae266be82676cbebd2ed7220d4a2d0365" title="Set a configuration tag. ">cpl_recipeconfig_set_tag()</a> or <a class="el" href="group__cpl__recipeconfig.html#ga378e88a23e65e7fb018f761862ae6bcb" title="Set the list of configuration tags. ">cpl_recipeconfig_set_tags()</a>.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__cpl__recipeconfig.html#gae266be82676cbebd2ed7220d4a2d0365" title="Set a configuration tag. ">cpl_recipeconfig_set_tag()</a>, <a class="el" href="group__cpl__recipeconfig.html#ga378e88a23e65e7fb018f761862ae6bcb" title="Set the list of configuration tags. ">cpl_recipeconfig_set_tags()</a> </dd></dl>
<p>References <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a5b82c7780a2a8a79dfafcac70717b830">CPL_ERROR_DATA_NOT_FOUND</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900ae6ab32df318c1af9afcddcb8249cad51">CPL_ERROR_ILLEGAL_INPUT</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a7b054cf7927d1bd0a9b3693a6715be84">CPL_ERROR_NULL_INPUT</a>, <a class="el" href="group__cpl__error.html#gad7cf962bbe59df1b5991b17b1a2361a3">cpl_error_set</a>, <a class="el" href="group__cpl__framedata.html#ga5a4f4663c8ba2668ee1e1ac2d1a9a39e">cpl_framedata_delete()</a>, <a class="el" href="group__cpl__framedata.html#ga614cbf16ab8dd0f22567100835a29e71">cpl_framedata_duplicate()</a>, and <a class="el" href="struct__cpl__framedata__.html#ae1ead7a0e34e33d07e84d876793dc648">_cpl_framedata_::tag</a>.</p>
</div>
</div>
<a class="anchor" id="gaf8882d5fdc846fa4c1f469e7bc5eb492"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int cpl_recipeconfig_set_output </td>
<td>(</td>
<td class="paramtype">cpl_recipeconfig * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>output</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add an output frame tag for the given configuration tag. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The recipe configuration object. </td></tr>
<tr><td class="paramname">tag</td><td>The configuration tag. </td></tr>
<tr><td class="paramname">output</td><td>The output frame tag to add.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function returns <code>0</code> on success and a non-zero value if an error occurred. The return value is <code>-1</code> if <em>self</em>, <em>tag</em> or <em>output</em> is <code>NULL</code>, or if <em>tag</em> or <em>input</em> is an invalid string. The function returns <code>1</code> if <em>self</em> was not properly initialized using <a class="el" href="group__cpl__recipeconfig.html#gae266be82676cbebd2ed7220d4a2d0365" title="Set a configuration tag. ">cpl_recipeconfig_set_tag()</a> or <a class="el" href="group__cpl__recipeconfig.html#ga378e88a23e65e7fb018f761862ae6bcb" title="Set the list of configuration tags. ">cpl_recipeconfig_set_tags()</a>. If no tag <em>tag</em> is found in <em>self</em> the function returns <code>2</code>. If an error occurs an appropriate error code is also set.</dd></dl>
<dl class="exception">
<dt><b>Errors</b></dt>
<dd></dd>
<dt></dt>
<dd><table class="ec" align="center">
<tr>
<td class="ecl">CPL_ERROR_NULL_INPUT </td><td class="ecr">The parameter <em>self</em>, <em>tag</em> or <em>output</em> is a <code>NULL</code> pointer. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_ILLEGAL_INPUT </td><td class="ecr">The frame tag <em>tag</em> or <em>input</em> is an invalid string, i.e. the empty string. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_DATA_NOT_FOUND </td><td class="ecr">No configuration for the tag <em>tag</em> was found, or <em>self</em> was not properly initialized. </td></tr>
</table>
</dd>
</dl>
<p>The function adds the output frame tag <em>ouput</em> to the configuration associated with the tag <em>tag</em> in the recipe configuration object <em>self</em>.</p>
<p>Before an output frame tag can be set using this function, the configuration tag <em>tag</em> must have been added to <em>self</em> previously, using <a class="el" href="group__cpl__recipeconfig.html#gae266be82676cbebd2ed7220d4a2d0365" title="Set a configuration tag. ">cpl_recipeconfig_set_tag()</a> or <a class="el" href="group__cpl__recipeconfig.html#ga378e88a23e65e7fb018f761862ae6bcb" title="Set the list of configuration tags. ">cpl_recipeconfig_set_tags()</a>.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__cpl__recipeconfig.html#gae266be82676cbebd2ed7220d4a2d0365" title="Set a configuration tag. ">cpl_recipeconfig_set_tag()</a>, <a class="el" href="group__cpl__recipeconfig.html#ga378e88a23e65e7fb018f761862ae6bcb" title="Set the list of configuration tags. ">cpl_recipeconfig_set_tags()</a> </dd></dl>
<p>References <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a5b82c7780a2a8a79dfafcac70717b830">CPL_ERROR_DATA_NOT_FOUND</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900ae6ab32df318c1af9afcddcb8249cad51">CPL_ERROR_ILLEGAL_INPUT</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a7b054cf7927d1bd0a9b3693a6715be84">CPL_ERROR_NULL_INPUT</a>, <a class="el" href="group__cpl__error.html#gad7cf962bbe59df1b5991b17b1a2361a3">cpl_error_set</a>, <a class="el" href="group__cpl__framedata.html#gace1bf71820e6e35467480fe529c043da">cpl_framedata_create()</a>, and <a class="el" href="group__cpl__framedata.html#ga5a4f4663c8ba2668ee1e1ac2d1a9a39e">cpl_framedata_delete()</a>.</p>
</div>
</div>
<a class="anchor" id="ga7203cc61855953d50e1cfeeb840165ed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int cpl_recipeconfig_set_outputs </td>
<td>(</td>
<td class="paramtype">cpl_recipeconfig * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the output configuration for a given tag. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The recipe configuration object. </td></tr>
<tr><td class="paramname">tag</td><td>The tag for which the output configuration is set. </td></tr>
<tr><td class="paramname">data</td><td>An array of strings containing the output frame tags to set.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function returns <code>0</code> on success, or a non-zero value otherwise. If <em>self</em> or <em>tag</em> is <code>NULL</code>, or if <em>tag</em> is invalid, i.e. the empty string the function returns <code>-1</code> and sets an appropriate error code. If no configuration tags were previously configured using <a class="el" href="group__cpl__recipeconfig.html#gae266be82676cbebd2ed7220d4a2d0365" title="Set a configuration tag. ">cpl_recipeconfig_set_tag()</a> or <a class="el" href="group__cpl__recipeconfig.html#ga378e88a23e65e7fb018f761862ae6bcb" title="Set the list of configuration tags. ">cpl_recipeconfig_set_tags()</a> the function returns <code>1</code>. If no configuration was found for the given tag <em>tag</em> the return value is <code>2</code>.</dd></dl>
<dl class="exception">
<dt><b>Errors</b></dt>
<dd></dd>
<dt></dt>
<dd><table class="ec" align="center">
<tr>
<td class="ecl">CPL_ERROR_NULL_INPUT </td><td class="ecr">The parameter <em>self</em> or <em>tag</em> is a <code>NULL</code> pointer. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_ILLEGAL_INPUT </td><td class="ecr">The frame tag <em>tag</em> is an invalid tag, i.e. the empty string. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_DATA_NOT_FOUND </td><td class="ecr">No configuration for the tag <em>tag</em> was found, or <em>self</em> was not properly initialized. </td></tr>
</table>
</dd>
</dl>
<p>The function sets the output configuration for the tag <em>tag</em> in the recipe configuration object <em>self</em>. The output configuration is a list of all possible frame tags which could result from the execution of the corresponding recipe.</p>
<p>The function stores each output frame tag found in the array <em>data</em>, until an array element set to <code>NULL</code> is reached. The array <em>data</em> must contain such an entry as last element, in order to indicate the end of the array.</p>
<p>Before an output configuration can be set using this function, the configuration tag <em>tag</em> must have been added to <em>self</em> previously using <a class="el" href="group__cpl__recipeconfig.html#gae266be82676cbebd2ed7220d4a2d0365" title="Set a configuration tag. ">cpl_recipeconfig_set_tag()</a> or <a class="el" href="group__cpl__recipeconfig.html#ga378e88a23e65e7fb018f761862ae6bcb" title="Set the list of configuration tags. ">cpl_recipeconfig_set_tags()</a>.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__cpl__recipeconfig.html#gae266be82676cbebd2ed7220d4a2d0365" title="Set a configuration tag. ">cpl_recipeconfig_set_tag()</a>, <a class="el" href="group__cpl__recipeconfig.html#ga378e88a23e65e7fb018f761862ae6bcb" title="Set the list of configuration tags. ">cpl_recipeconfig_set_tags()</a> </dd></dl>
<p>References <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a5b82c7780a2a8a79dfafcac70717b830">CPL_ERROR_DATA_NOT_FOUND</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900ae6ab32df318c1af9afcddcb8249cad51">CPL_ERROR_ILLEGAL_INPUT</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a7b054cf7927d1bd0a9b3693a6715be84">CPL_ERROR_NULL_INPUT</a>, <a class="el" href="group__cpl__error.html#gad7cf962bbe59df1b5991b17b1a2361a3">cpl_error_set</a>, and <a class="el" href="group__cpl__framedata.html#gace1bf71820e6e35467480fe529c043da">cpl_framedata_create()</a>.</p>
</div>
</div>
<a class="anchor" id="gae266be82676cbebd2ed7220d4a2d0365"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int cpl_recipeconfig_set_tag </td>
<td>(</td>
<td class="paramtype">cpl_recipeconfig * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__cpl__type.html#gacc431432a4fedf19ec6f7668dda3fbf0">cpl_size</a> </td>
<td class="paramname"><em>min_count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__cpl__type.html#gacc431432a4fedf19ec6f7668dda3fbf0">cpl_size</a> </td>
<td class="paramname"><em>max_count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a configuration tag. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The recipe configuration object. </td></tr>
<tr><td class="paramname">tag</td><td>The configuration tag. </td></tr>
<tr><td class="paramname">min_count</td><td>The value to set as the minimum number of frames. </td></tr>
<tr><td class="paramname">max_count</td><td>The value to set as the maximum number of frames.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function returns <code>0</code> on success and a non-zero value if an error occurred. The return value is <code>-1</code> if <em>self</em> or <em>tag</em> is <code>NULL</code>, or if <em>tag</em> is an invalid string. If an error occurs an appropriate error code is set.</dd></dl>
<dl class="exception">
<dt><b>Errors</b></dt>
<dd></dd>
<dt></dt>
<dd><table class="ec" align="center">
<tr>
<td class="ecl">CPL_ERROR_NULL_INPUT </td><td class="ecr">The parameter <em>self</em> or <em>tag</em> is a <code>NULL</code> pointer. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_ILLEGAL_INPUT </td><td class="ecr">The frame tag <em>tag</em> is an invalid tag, i.e. the empty string. </td></tr>
</table>
</dd>
</dl>
<p>The function creates a configuration for the configuration tag <em>tag</em> and adds it to the recipe configuration object <em>self</em>. The minimum and maximum number of frames of this tag can be given using the arguments <em>min_count</em> and <em>max_count</em>. Using a value of <code>-1</code> for the minimum and maximum number of frames, means that these two numbers are unspecified. If the minimum number of frames is greater than <code>0</code>, the frame is considered to be required, otherwise it is optional. </p>
<p>References <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900ae6ab32df318c1af9afcddcb8249cad51">CPL_ERROR_ILLEGAL_INPUT</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a7b054cf7927d1bd0a9b3693a6715be84">CPL_ERROR_NULL_INPUT</a>, and <a class="el" href="group__cpl__error.html#gad7cf962bbe59df1b5991b17b1a2361a3">cpl_error_set</a>.</p>
</div>
</div>
<a class="anchor" id="ga378e88a23e65e7fb018f761862ae6bcb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int cpl_recipeconfig_set_tags </td>
<td>(</td>
<td class="paramtype">cpl_recipeconfig * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__framedata.html#gac3d2cda81a762b2f50d4a52ea456f5ec">cpl_framedata</a> * </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the list of configuration tags. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The recipe configuration object. </td></tr>
<tr><td class="paramname">data</td><td>A frame data array from which the tags are set.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function returns <code>0</code> on success, or a non-zero value otherwise. Inparticular, if the <em>self</em> is <code>NULL</code> the function returns <code>-1</code> and sets the appropriate error code. If any configuration tag in the input array <em>data</em> is invalid, an empty string for instance, the function returns <code>1</code> and sets an appropriate error code.</dd></dl>
<dl class="exception">
<dt><b>Errors</b></dt>
<dd></dd>
<dt></dt>
<dd><table class="ec" align="center">
<tr>
<td class="ecl">CPL_ERROR_NULL_INPUT </td><td class="ecr">The parameter <em>self</em> is a <code>NULL</code> pointer. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_ILLEGAL_INPUT </td><td class="ecr">The frame data array <em>data</em> contains an invalid tag. </td></tr>
</table>
</dd>
</dl>
<p>The function is a convenience function to allow an initialization of a recipe configuration from static data. The configuration tags to be stored are taken from the frame data array <em>data</em> and are added to the recipe configuration <em>self</em>. The configuration tag is copied to <em>self</em>.</p>
<p>In addition the tags can be configured using the remaining members of the frame data structures of <em>data</em>.</p>
<p>The function adds each configuration tag found in the array <em>data</em> to the configuration <em>self</em>, until a configuration tag set to <em>NULL</em> is reached. The array <em>data</em> must be terminated by such an entry, which indicates the end of the array. </p>
<p>References <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900ae6ab32df318c1af9afcddcb8249cad51">CPL_ERROR_ILLEGAL_INPUT</a>, <a class="el" href="group__cpl__error.html#gga49a0c316d52d2afbfd9fd94b95344900a7b054cf7927d1bd0a9b3693a6715be84">CPL_ERROR_NULL_INPUT</a>, <a class="el" href="group__cpl__error.html#gad7cf962bbe59df1b5991b17b1a2361a3">cpl_error_set</a>, and <a class="el" href="struct__cpl__framedata__.html#ae1ead7a0e34e33d07e84d876793dc648">_cpl_framedata_::tag</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|