Description of edl_initctrlfile

Home > sltoolbox > ExpDL > edl_initctrlfile.m

edl_initctrlfile

PURPOSE

EDL_INITCTRLFILE Creates an initial control file

SYNOPSIS

function edl_initctrlfile(filename, guidstr, n)

DESCRIPTION

EDL_INITCTRLFILE Creates an initial control file

 $ Syntax $
   - edl_initctrlfile(filename, guidstr, n)

 $ Arguments $
   - filename:     the destination control filename
   - guidstr:      the GUID identifying the corresponding script
   - n:            the number of items

 $ Description $
   - edl_initctrlfile(filename, guidstr, n) writes an initial control
     file with all status set to pending.

 $ History $
   - Created by Dahua Lin, on Aug 14th, 2006

CROSS-REFERENCE INFORMATION

This function calls:

• edl_writeprops EDL_WRITEPROPS Writes the property table to XML file
• raise_lackinput RAISE_LACKINPUT Raises an error indicating lack of input argument

This function is called by:

• edl_writescript EDL_WRITESCRIPT Writes an EDL script

SOURCE CODE

0001 function edl_initctrlfile(filename, guidstr, n)
0002 %EDL_INITCTRLFILE Creates an initial control file
0003 %
0004 % $ Syntax $
0005 %   - edl_initctrlfile(filename, guidstr, n)
0006 %
0007 % $ Arguments $
0008 %   - filename:     the destination control filename
0009 %   - guidstr:      the GUID identifying the corresponding script
0010 %   - n:            the number of items
0011 %
0012 % $ Description $
0013 %   - edl_initctrlfile(filename, guidstr, n) writes an initial control
0014 %     file with all status set to pending.
0015 %
0016 % $ History $
0017 %   - Created by Dahua Lin, on Aug 14th, 2006
0018 %
0019 
0020 %% parse and verify input
0021 
0022 if nargin < 3
0023     raise_lackinput('edl_initctrlfile', 3);
0024 end
0025 
0026 %% Write
0027 
0028 doctag = 'ExpControl';
0029 attribs.guid = guidstr;
0030 nodetag = 'Entry';
0031 
0032 props = struct(...
0033     'internal_index', mat2cell((1:n)', ones(n,1)), ...
0034     'status', repmat({'pending'}, [n, 1]) ...
0035     );
0036 
0037 edl_writeprops(doctag, attribs, nodetag, props, filename)

---

Generated on Wed 20-Sep-2006 12:43:11 by m2html © 2003