Contents     Functions              PDF Index

comstr

• Cam,string istrue=comstr(Cam,'string')
• Cam,string,format [opt,CAM,Cam]=comstr(CAM,'string','format')
• CAM,ind [CAM,Cam] = comstr(CAM,ind)
• -1 opt = comstr(CAM,[-1 default])
• -3 date = comstr(CAM,[-3])
• -4 CAM = comstr(CAM,[-4 nc ])
• -5 comstr(Matrix,[-5 fid],'format')
• -7 st1=comstr(st1,-7,'string')
• -17 Tab, comstr(tt,-17,'type')
• -38 [i0,st2]=comstr(st1,-38)

Purpose

String handling functions for the Structural Dynamics Toolbox.

Syntax

See details below

Description

The user interfaces of the Structural Dynamics Toolbox have a number of string handling needs which have been grouped in the comstr function. The appropriate formats and usual place of use are indicated below.

Cam,string istrue=comstr(Cam,'string')

String comparison. 1 is returned if the first characters of Cam contain the complete 'string'. 0 is returned otherwise. This call is used extensively for command parsing. Note that istrue is output in format double and not logical. See also strncmp.

Cam,string,format [opt,CAM,Cam]=comstr(CAM,'string','format')

Next string match and parameter extraction. comstr finds the first character where lower(CAM) differs from string. Reads the remaining string using the sscanf specified format. Returns opt the result of sscanf and CAM the remaining characters that could not be read with the given format.

[opt,CAM,Cam]=comstr(CAM,'string','%c') is used to eliminate the matching part of string.

CAM,ind [CAM,Cam] = comstr(CAM,ind)

Command segmentation with removal of front and tail blanks. The first ind characters of the string command in capitals CAM are eliminated. The front and tail blanks are eliminated. Cam is a lowercase version of CAM. This call to comstr is used in all UI command functions for command segmentation.

-1 opt = comstr(CAM,[-1 default])

Option parameter evaluation. The string CAM is evaluated for numerical values which are output in the row vector opt. If a set of default values default is given any unspecified value in opt will be set to the default.

-3 date = comstr(CAM,[-3])

Return the standard date string. Used by ufwrite, naswrite, etc. See also date, datenum.

-4 CAM = comstr(CAM,[-4 nc ])

Fills the string CAM with blanks up to nc characters.

-5 comstr(Matrix,[-5 fid],'format')

Formatted output of Matrix, the format is repeated as many times as Matrix has columns and a formatted output to fid (default is 1 standard output). For example you might use comstr(ii_mac(md1,md2)*100,[-5 1],'%6.0f').

-7 st1=comstr(st1,-7,'string')

used for dynamic messaging on the command line. On UNIX platforms (the backspace does not work properly on Windows), the string st1 is erased before 'string' is displayed.

-17 Tab, comstr(tt,-17,'type')

This is used to generate tabular output of the cell array tt to various supported types : tab (opens a java tab containing the table), excel (Microsoft Excel only available on windows), html, csv (comma separated values, readable by excel), tex (latex formatting), text printout to the command window.

 % A sample table
 tab=num2cell(reshape(1:10,[],2));tab(1,:)={'c1','c2'};
 tname=nas2up('tempname o.html'); 
 % RO option structure to format a table for HTML or java output
 RO=struct('fmt',{{'%3i','%.1f'}}, ... % Formatting for each column
    'HasHead',1); % a header is provided as strings
 RO.fopen={tname,'a+'};  % Opening information 
 RO.OpenOnExit=0;
 RO.Legend=sprintf('<p>%s</p>','My HTML legend');
 %  comstr(tab,-17,[],RO.fmt)
 comstr(tab,-17,'html',RO);
 sdtweb('_link',sprintf('web(''%s'')',tname))
 % Show the table in JAVA tab
 comstr(tab,-17,'tab',RO);
 % Generate tex output of java tabs
 comstr(struct('FigTag','SDT Root'),-17,'tex');
 comstr(gcf,-17,'tex');

Accepted fields for the options structure are

• .fmt cell array of column formatting instructions. These can be strings %.1f,%i,%.2g which are passed to sprintf. They can also be java strings java.lang.String('0.00%') which are then parsed using java.text.DecimalFormat.
• .ColumnName cell array with first row giving column names. .ColumnName(:,3) can also be used to store the column format. .ColumnName(:,4) can also be used to store cell coloring data, see section 7.18.
• .HasHead if non zero, skips lines of strings

Fields specific for HTML generation are

• .name is used to define a title for the table.
• .fopen used for HTML generation. For example {tname,'a+'}; is for append. .OpenOnExit asks to open the file in the web browser.

Fields specific for JAVA tabs are

• .setSort activates row sorting in java tables. 1 : basic sort, 2: selectable sort. 3 : tree table.
• .name is used to define a tab name.
• .FigTag tag or handle for figure where the tab should be displayed.
• .ColWidth vector of column width in pixels.
• .groupable used with .setSort=3 to specify columns that will be used to generate the tree.
• jProp accepts tag,value pairs. 'ResizeMode','Off' to fix colums for example. 'MousePressed',data gives a cell array used to store events that should be handled by the table (see menu_generation('jpropcontext',ua,'Tab.ExportTable')).
• .ColumnName second row can give alignment 'right'. Third row can give column formatting (alternatively, the .RowFmt can be used). Row 4 can be used to define a color based on a CritFcn.

-38 [i0,st2]=comstr(st1,-38)

Checks whether provided string st1 is valid to be a structure field. Output i0 is a boolean, true if valid, false otherwise. Output st2 is equal to input st1 if the string is valid. If not, st2 is an alternative valid suggestion based on st1.

See also

commode