22.06.2015 Views

CIFER®-MATLAB Interfaces: Development and ... - Cal Poly

CIFER®-MATLAB Interfaces: Development and ... - Cal Poly

CIFER®-MATLAB Interfaces: Development and ... - Cal Poly

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

Appendix C: Online Help for Main Programs<br />

This Appendix contains the information that is displayed when the ‘help functionname’ comm<strong>and</strong><br />

is used in <strong>MATLAB</strong>.<br />

FUNCTION: frespid<br />

DESCRIPTION: Function to open, save <strong>and</strong> run a FRESPID case.<br />

Function may be called with no arguments to return a template,<br />

mostly blank structure.<br />

[out] = frespid(id,cmd,options)<br />

INPUTS:<br />

id<br />

cmd<br />

- either frespid structure or string with case name<br />

Information on the details of the structure can<br />

be found with an empty call:<br />

>> frespid<br />

- comm<strong>and</strong> to have function perform a process<br />

1 - open FRESPID case<br />

2 - save a FRESPID case<br />

3 - save case <strong>and</strong> run batch job<br />

options – name-value pairs to set individual data<br />

fields (optional)<br />

e.g.: ...,'casename','XVLATSWP',...<br />

OUTPUTS:<br />

out<br />

- return structure for frespid data structure. A<br />

template structure can be returned using<br />

an empty call:<br />

>> out = frespid<br />

EXAMPLE CALLS:<br />

[out] = frespid<br />

returns a mostly blank template frespid structure<br />

[out] = frespid('TEST',1)<br />

opens case named 'TEST', returns frespid structure<br />

[out] = frespid('TEST',2,'casename','TEST2','winlen',<br />

[45,40,30,20,15])<br />

saves TEST as TEST2 <strong>and</strong> changes window lengths; the<br />

structure is returned<br />

frespid(new_struct,3)<br />

sends new_struct, a new FRESPID case, to batch; nothing is<br />

returned<br />

NOTES:<br />

- A totally new case must be specified via a structure, not by<br />

the desired new name. (i.e., frespid('NEWNAME',2) will NOT<br />

save a blank case entitled 'NEWNAME' into the database)<br />

-----------------------------------------------------------------------<br />

DESCRIPTION OF FIELDS IN INPUT STRUCTURE<br />

SCREEN 2<br />

id.casename<br />

id.comments<br />

FRESPID case name<br />

FRESPID case identifier string<br />

83

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!