Home > Applications > SpinW > m_files > @sw > display.m

iFit/display

PURPOSE ^

prints the sw data structure in readable format onto the Command Window

SYNOPSIS ^

function varargout = display(obj, fid)

DESCRIPTION ^

 prints the sw data structure in readable format onto the Command Window

 {swDescr} = DISPLAY(obj, {fid})

 Input:

 obj       sw class object.
 fid       File identifier (created by fopen function) where the output
           will be written. Default is stored in obj, the output will be
           written onto the Command Line. Optional.

 Output:

 swdescr   If output variable is given, the description of the obj object
           will be output into the swdescr variable, instead of being
           written onto the Command Window/file. Optional.

 Example:

 crystal = sw;
 swFields = display(crystal);

 See also SW.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Mon 26-Nov-2018 15:08:42 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1